Skip to main content

Component: s3-bucket

This component is responsible for provisioning S3 buckets.


Stack Level: Regional

Here are some example snippets for how to use this component:

stacks/s3/defaults.yaml file (base component for all S3 buckets with default settings):

type: abstract
workspace_enabled: true
enabled: true
account_map_tenant_name: core
# Suggested configuration for all buckets
user_enabled: false
acl: "private"
grants: null
force_destroy: false
versioning_enabled: false
allow_encrypted_uploads_only: true
block_public_acls: true
block_public_policy: true
ignore_public_acls: true
restrict_public_buckets: true
allow_ssl_requests_only: true
- id: default
enabled: true
abort_incomplete_multipart_upload_days: 90
prefix: ""
tags: {}
- storage_class: GLACIER
days: 60
- storage_class: GLACIER
days: 60
days: 90
days: 120
- catalog/s3/defaults

component: s3-bucket
- s3-bucket-defaults
enabled: true
name: template
logging_bucket_name_rendering_enabled: true
bucket_name: s3-access-logs
prefix: logs/


terraform>= 1.0.0
aws>= 4.0
template>= 2.2.0


aws>= 4.0
template>= 2.2.0




aws_iam_policy_document.custom_policydata source
aws_partition.currentdata source
template_file.bucket_policydata source


account_map_environment_nameThe name of the environment where account_map is provisionedstring"gbl"no
account_map_stage_nameThe name of the stage where account_map is provisionedstring"root"no
account_map_tenant_nameThe name of the tenant where account_map is provisioned.

If the tenant label is not used, leave this as null.
aclThe canned ACL to apply.
We recommend private to avoid exposing sensitive information. Conflicts with grants.
additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
allow_encrypted_uploads_onlySet to true to prevent uploads of unencrypted objects to S3 bucketboolfalseno
allow_ssl_requests_onlySet to true to require requests to use Secure Socket Layer (HTTPS/SSL). This will explicitly deny access to HTTP requestsboolfalseno
allowed_bucket_actionsList of actions the user is permitted to perform on the S3 bucketlist(string)
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
block_public_aclsSet to false to disable the blocking of new public access lists on the bucketbooltrueno
block_public_policySet to false to disable the blocking of new public policies on the bucketbooltrueno
bucket_key_enabledSet this to true to use Amazon S3 Bucket Keys for SSE-KMS, which reduce the cost of AWS KMS requests.
For more information, see:
bucket_nameBucket name. If provided, the bucket will be created with this name instead of generating the name from the contextstring""no
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
cors_configurationSpecifies the allowed headers, methods, origins and exposed headers when using CORS on this bucket
allowed_headers = list(string)
allowed_methods = list(string)
allowed_origins = list(string)
expose_headers = list(string)
max_age_seconds = number
custom_policy_account_namesList of accounts names to assign as principals for the s3 bucket custom policylist(string)[]no
custom_policy_actionsList of S3 Actions for the custom policylist(string)[]no
custom_policy_enabledWhether to enable or disable the custom policy. If enabled, the default policy will be ignoredboolfalseno
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
force_destroyWhen true, permits a non-empty S3 bucket to be deleted by first deleting all objects in the bucket.
THESE OBJECTS ARE NOT RECOVERABLE even if they were versioned and stored in Glacier.
grantsA list of policy grants for the bucket, taking a list of permissions.
Conflicts with acl. Set acl to null to use this.
id = string
type = string
permissions = list(string)
uri = string
iam_policy_statementsMap of IAM policy statements to use in the bucket policy.any{}no
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
ignore_public_aclsSet to false to disable the ignoring of public access lists on the bucketbooltrueno
kms_master_key_arnThe AWS KMS master key ARN used for the SSE-KMS encryption. This can only be used when you set the value of sse_algorithm as aws:kms. The default aws/s3 AWS KMS master key is used if this element is absent while the sse_algorithm is aws:kmsstring""no
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
lifecycle_configuration_rulesA list of lifecycle V2 rules
enabled = bool
id = string

abort_incomplete_multipart_upload_days = number

# filter_and is the and configuration block inside the filter configuration.
# This is the only place you should specify a prefix.
filter_and = any
expiration = any
transition = list(any)

noncurrent_version_expiration = any
noncurrent_version_transition = list(any)
loggingBucket access logging configuration.
bucket_name = string
prefix = string
logging_bucket_name_rendering_enabledWhether to render the logging bucket name, prepending contextboolfalseno
logging_bucket_name_rendering_templateThe template for the template used to render Bucket Name for the Logging bucket.
Default is appropriate when using tenant and default label order with null-label.
Use "%s-%s-%s-%%s" when not using tenant.
logging_bucket_prefix_rendering_templateThe template for the template used to render Bucket Prefix for the Logging bucket, uses the format var.logging.prefix/var.namestring"%s/%s/"no
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
object_lock_configurationA configuration for S3 object locking. With S3 Object Lock, you can store objects using a write once, read many (WORM) model. Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely.
mode = string # Valid values are GOVERNANCE and COMPLIANCE.
days = number
years = number
privileged_principal_actionsList of actions to permit privileged_principal_arns to perform on bucket and bucket prefixes (see privileged_principal_arns)list(string)[]no
privileged_principal_arnsList of maps. Each map has one key, an IAM Principal ARN, whose associated value is
a list of S3 path prefixes to grant privileged_principal_actions permissions for that principal,
in addition to the bucket itself, which is automatically included. Prefixes should not begin with '/'.
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
regionAWS Regionstringn/ayes
restrict_public_bucketsSet to false to disable the restricting of making the bucket publicbooltrueno
s3_object_ownershipSpecifies the S3 object ownership control. Valid values are ObjectWriter, BucketOwnerPreferred, and 'BucketOwnerEnforced'.string"ObjectWriter"no
s3_replica_bucket_arnA single S3 bucket ARN to use for all replication rules.
Note: The destination bucket can be specified in the replication rule itself
(which allows for multiple destinations), in which case it will take precedence over this variable.
s3_replication_enabledSet this to true and specify s3_replication_rules to enable replication. versioning_enabled must also be true.boolfalseno
s3_replication_rulesSpecifies the replication rules for S3 bucket replication if enabled. You must also set s3_replication_enabled to true.list(any)nullno
s3_replication_source_rolesCross-account IAM Role ARNs that will be allowed to perform S3 replication to this bucket (for replication within the same AWS account, it's not necessary to adjust the bucket policy).list(string)[]no
source_policy_documentsList of IAM policy documents that are merged together into the exported document.
Statements defined in source_policy_documents or source_json must have unique SIDs.
Statement having SIDs that match policy SIDs generated by this module will override them.
sse_algorithmThe server-side encryption algorithm to use. Valid values are AES256 and aws:kmsstring"AES256"no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
transfer_acceleration_enabledSet this to true to enable S3 Transfer Acceleration for the bucket.boolfalseno
user_enabledSet to true to create an IAM user with permission to access the bucketboolfalseno
versioning_enabledA state of versioning. Versioning is a means of keeping multiple variants of an object in the same bucketbooltrueno
website_inputsSpecifies the static website hosting configuration object.
index_document = string
error_document = string
redirect_all_requests_to = string
routing_rules = string


bucket_arnBucket ARN
bucket_domain_nameBucket domain name
bucket_idBucket ID
bucket_regionBucket region
bucket_regional_domain_nameBucket region-specific domain name