S3 Buckets
Executive Summary
S3 Buckets is the setup list of Amazon S3 storage connections (bucket profiles) that other parts of the system use to store and retrieve files. Administrators add a profile with its access key, secret key, region, bucket name and encryption type, change it when credentials are rotated, delete it when it is no longer needed, and test that the connection works.
Key Features
- Add and edit S3 bucket profiles (credentials are stored encrypted)
- Delete a profile after confirmation
- Test a profile by listing and reading the files in a folder, and optionally uploading a test file
- Choose the server side encryption used for the bucket
Typical Workflow
- Click Add, enter a Name, Access Key, Secret Key, Region, Bucket Name and Server Side Encryption, then click Save.
- Right-click the new row and choose Test Bucket.
- Enter a Folder Name, optionally tick Test Upload, and click Ok.
- Read the messages that appear to confirm the connection works.
- Edit the profile later if the keys change, or delete it when it is no longer used.
Available Permissions
The following permissions are available to be assigned to AlayaCare Roles:
| Attribute | What It Controls |
|---|---|
| View | Open the page |
| Edit | Add, edit and delete bucket profiles. Without it, these actions show a warning that you are not authorized. |
Main Grid
The grid lists the bucket profiles (14 rows per page).
| Column | Description |
|---|---|
| Name | Name of the bucket profile. |
| Manage Records | Edit icon and a delete (close) icon for the row. |
Actions
| Button | Description |
|---|---|
| Add | Opens the S3 Bucket dialog to create a profile (requires the Edit permission). |
| Edit icon / right-click Edit | Opens the selected profile for editing (requires the Edit permission). |
| Delete icon / right-click Delete | Asks "Are you sure you want to delete this s3 bucket link?" and deletes the profile on Yes (requires the Edit permission). |
| Test Bucket (right-click a row) | Opens the Test Bucket dialog for the selected profile. |
Dialog Components
S3 Bucket
Opens from Add or edit. Save stores the profile; Cancel closes without saving. All fields except Server Side Encryption are required, and the Name must be different from every other profile. When editing an existing profile, Name is read-only and the saved keys, region and bucket name are shown for review.
| Field | Purpose |
|---|---|
| Name | Name that identifies the profile. Can only be set when the profile is created. |
| Access Key | AWS access key. |
| Secret Key | AWS secret key. |
| Region | AWS region: CA-Central-1, US-East-1 or US-East-2. |
| Bucket Name | Name of the bucket in S3. |
| Server Side Encryption | None, AES256 or AWSKMS. |
Test Bucket
Opens from the right-click Test Bucket option.
| Field | Purpose |
|---|---|
| Folder Name | Folder in the bucket to test against. |
| Test Upload | When checked, a small test text file is also uploaded. |
Ok runs the test; Cancel closes the dialog.
Processing Overviews
This section describes what happens after you confirm a processing action.
Test Bucket
- Connects to the bucket with the saved credentials. If the connection fails, the warning "Error connecting to S3 bucket" appears and the test stops.
- Lists the files in the folder and reads each one.
- Shows a message with the number of items found in the folder.
- If Test Upload is checked, uploads a text file named "Test Upload at" followed by the date and time, containing "This is a test", and reports whether the upload succeeded or failed.
- After a successful upload, lists the folder again and reports whether the uploaded file was found.