aws_s3
Type:
Stores each item in an S3 bucket as a file, where an item ID is the path of the item within the bucket.
Introduced in version 3.36.0.
-
Common
-
Advanced
# Common config fields, showing default values
label: ""
aws_s3:
bucket: "" # No default (required)
content_type: application/octet-stream
# All config fields, showing default values
label: ""
aws_s3:
bucket: "" # No default (required)
content_type: application/octet-stream
force_path_style_urls: false
retries:
initial_interval: 1s
max_interval: 5s
max_elapsed_time: 30s
region: ""
endpoint: ""
credentials:
profile: ""
id: ""
secret: ""
token: ""
from_ec2_role: false
role: ""
role_external_id: ""
It is not possible to atomically upload S3 objects exclusively when the target does not already exist, therefore this cache is not suitable for deduplication.
Fields
content_type
The content type to set for each item.
Type: string
Default: "application/octet-stream"
force_path_style_urls
Forces the client API to use path style URLs, which helps when connecting to custom endpoints.
Type: bool
Default: false
retries.initial_interval
The initial period to wait between retry attempts.
Type: string
Default: "1s"
# Examples
initial_interval: 50ms
initial_interval: 1s
retries.max_interval
The maximum period to wait between retry attempts
Type: string
Default: "5s"
# Examples
max_interval: 5s
max_interval: 1m
retries.max_elapsed_time
The maximum overall period of time to spend on retry attempts before the request is aborted.
Type: string
Default: "30s"
# Examples
max_elapsed_time: 1m
max_elapsed_time: 1h
credentials
Optional manual configuration of AWS credentials to use. More information can be found in Amazon Web Services.
Type: object
credentials.secret
The secret for the credentials being used.
This field contains sensitive information that usually shouldn’t be added to a config directly, read our secrets page for more info. |
Type: string
Default: ""
credentials.token
The token for the credentials being used, required when using short term credentials.
Type: string
Default: ""
credentials.from_ec2_role
Use the credentials of a host EC2 machine configured to assume an IAM role associated with the instance.
Type: bool
Default: false
Requires version 4.2.0 or newer