S3
Define an S3 object store (bucket) for the storage of files.
Amazon's Simple Storage Service (S3) is an object storage system. Files and data can be stored in the buckets it provides. S3 is suitable for the storage of static files and files that do not change regularly. Some filesystem operations are very inefficient when mapped onto the S3 object store. For example, it is not suitable for log files due to the S3 storage system not supporting append operations.
New S3 Storage items can be added.
S3 Storage
The attributes of the S3 bucket.
- Authentication - The authentication required to connect to the S3 bucket.
- Compatibility - Options to ensure S3 API compatibility.
Properties
Enable
Enable this filesystem.
- Data type: boolean
- Default:
true - Configuration
CLI: (cli)> config storage s3 <key> enable
Label
The label used to describe and locate this filesystem.
- Data type: string
- Configuration
- Optional
CLI: (cli)> config storage s3 <key> label
Resource tags
Apply these tags to resources associated with this filesystem.
- Data type: string list
- Configuration
CLI: (cli)> config storage s3 <key> tags
Available
The availability of the S3 bucket.
- Data type: boolean
- Status
CLI: (cli)> show storage s3 <key> available
Server URL
The URL of the server for access this S3 bucket.
- Data type: string
- Default:
https://s3.amazonaws.com - Configuration
- Required
CLI: (cli)> config storage s3 <key> url
Bucket name
The name for this storage bucket.
- Data type: string
- Configuration
- Required
CLI: (cli)> config storage s3 <key> bucket
Access style
Define how the bucket name should be used when accessing the S# bucket.
| Option | Label | Description |
|---|---|---|
path | Path-style access | Requests are made to the S3 server with the bucket name inserted into the URL path. |
virtual-host | Virtual-hosted-style access | Requests are made to the S3 server with the bucket name inserted into the URL subdomain. |
- Data type: string select
- Default:
path - Configuration
- Required
CLI: (cli)> config storage s3 <key> access-style
Instance name
The instance name included in user agent headers sent to the S3 server.
- Data type: string
- Configuration
- Optional
CLI: (cli)> config storage s3 <key> instance-name
Public bucket
Is this bucket publicly visible.
- Data type: boolean
- Default:
false - Configuration
CLI: (cli)> config storage s3 <key> public