s3-bucket

This component is responsible for provisioning S3 buckets.

Usage

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):

components:
  terraform:
    s3-bucket-defaults:
      metadata:
        type: abstract
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        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
        lifecycle_configuration_rules:
          - id: default
            enabled: true
            abort_incomplete_multipart_upload_days: 90
            filter_and:
              prefix: ""
              tags: {}
            transition:
              - storage_class: GLACIER
                days: 60
            noncurrent_version_transition:
              - storage_class: GLACIER
                days: 60
            noncurrent_version_expiration:
              days: 90
            expiration:
              days: 120

import:
  - catalog/s3/defaults

components:
  terraform:
    template-bucket:
      metadata:
        component: s3-bucket
        inherits:
          - s3-bucket-defaults
      vars:
        enabled: true
        name: template
        logging_bucket_name_rendering_enabled: true
        logging:
          bucket_name: s3-access-logs
          prefix: logs/

Variables

Required Variables

region (string) required: AWS Region

Optional Variables

account_map_environment_name (string) optional

The name of the environment where account_map is provisioned

Default value: "gbl"

account_map_stage_name (string) optional

The name of the stage where account_map is provisioned

Default value: "root"

account_map_tenant_name (string) optional

The name of the tenant where account_map is provisioned.

If the tenant label is not used, leave this as null.

Default value: null

acl (string) optional

The canned ACL to apply.
We recommend private to avoid exposing sensitive information. Conflicts with grants.

Default value: "private"

allow_encrypted_uploads_only (bool) optional

Set to true to prevent uploads of unencrypted objects to S3 bucket

Default value: false

allow_ssl_requests_only (bool) optional

Set to true to require requests to use Secure Socket Layer (HTTPS/SSL). This will explicitly deny access to HTTP requests

Default value: false

allowed_bucket_actions (list(string)) optional

List of actions the user is permitted to perform on the S3 bucket

Default value:

[
  "s3:PutObject",
  "s3:PutObjectAcl",
  "s3:GetObject",
  "s3:DeleteObject",
  "s3:ListBucket",
  "s3:ListBucketMultipartUploads",
  "s3:GetBucketLocation",
  "s3:AbortMultipartUpload"
]

block_public_acls (bool) optional

Set to false to disable the blocking of new public access lists on the bucket

Default value: true

block_public_policy (bool) optional

Set to false to disable the blocking of new public policies on the bucket

Default value: true

bucket_key_enabled (bool) optional

Set this to true to use Amazon S3 Bucket Keys for SSE-KMS, which reduce the cost of AWS KMS requests.
For more information, see: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html

Default value: false

bucket_name (string) optional

Bucket name. If provided, the bucket will be created with this name instead of generating the name from the context

Default value: ""

cors_configuration optional

Specifies the allowed headers, methods, origins and exposed headers when using CORS on this bucket

Type:

list(object({
allowed_headers = list(string)
allowed_methods = list(string)
allowed_origins = list(string)
expose_headers  = list(string)
max_age_seconds = number
}))

Default value: null

custom_policy_account_names (list(string)) optional

List of accounts names to assign as principals for the s3 bucket custom policy

Default value: [ ]

custom_policy_actions (list(string)) optional

List of S3 Actions for the custom policy

Default value: [ ]

custom_policy_enabled (bool) optional

Whether to enable or disable the custom policy. If enabled, the default policy will be ignored

Default value: false

force_destroy (bool) optional

When 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.

Default value: false

grants optional

A list of policy grants for the bucket, taking a list of permissions.
Conflicts with acl. Set acl to null to use this.

Type:

list(object({
id          = string
type        = string
permissions = list(string)
uri         = string
}))

Default value: [ ]

iam_policy_statements (any) optional

Map of IAM policy statements to use in the bucket policy.

Default value: { }

ignore_public_acls (bool) optional

Set to false to disable the ignoring of public access lists on the bucket

Default value: true

kms_master_key_arn (string) optional

The 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:kms

Default value: ""

lifecycle_configuration_rules optional

A list of lifecycle V2 rules

Type:

list(object({
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)
}))

Default value: [ ]

logging optional

Bucket access logging configuration.

Type:

object({
bucket_name = string
prefix      = string
})

Default value: null

logging_bucket_name_rendering_enabled (bool) optional

Whether to render the logging bucket name, prepending context

Default value: false

logging_bucket_name_rendering_template (string) optional

The 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.

Default value: "%s-%s-%s-%s-%s"

logging_bucket_prefix_rendering_template (string) optional

The template for the template used to render Bucket Prefix for the Logging bucket, uses the format var.logging.prefix/var.name

Default value: "%s/%s/"

object_lock_configuration optional

A 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.

Type:

object({
mode  = string # Valid values are GOVERNANCE and COMPLIANCE.
days  = number
years = number
})

Default value: null

privileged_principal_actions (list(string)) optional

List of actions to permit privileged_principal_arns to perform on bucket and bucket prefixes (see privileged_principal_arns)

Default value: [ ]

privileged_principal_arns (list(map(list(string)))) optional

List 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 '/'.

Default value: [ ]

restrict_public_buckets (bool) optional

Set to false to disable the restricting of making the bucket public

Default value: true

s3_object_ownership (string) optional

Specifies the S3 object ownership control. Valid values are ObjectWriter, BucketOwnerPreferred, and 'BucketOwnerEnforced'.

Default value: "ObjectWriter"

s3_replica_bucket_arn (string) optional

A 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.

Default value: ""

s3_replication_enabled (bool) optional

Set this to true and specify s3_replication_rules to enable replication. versioning_enabled must also be true.

Default value: false

s3_replication_rules (list(any)) optional

Specifies the replication rules for S3 bucket replication if enabled. You must also set s3_replication_enabled to true.

Default value: null

s3_replication_source_roles (list(string)) optional

Cross-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).

Default value: [ ]

source_policy_documents (list(string)) optional

List 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.

Default value: [ ]

sse_algorithm (string) optional

The server-side encryption algorithm to use. Valid values are AES256 and aws:kms

Default value: "AES256"

transfer_acceleration_enabled (bool) optional

Set this to true to enable S3 Transfer Acceleration for the bucket.

Default value: false

user_enabled (bool) optional

Set to true to create an IAM user with permission to access the bucket

Default value: false

versioning_enabled (bool) optional

A state of versioning. Versioning is a means of keeping multiple variants of an object in the same bucket

Default value: true

website_inputs optional

Specifies the static website hosting configuration object.

Type:

list(object({
index_document           = string
error_document           = string
redirect_all_requests_to = string
routing_rules            = string
}))

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional 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.

Required: No

Default value: { }

attributes (list(string)) optional

ID 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.

Required: No

Default value: [ ]

context (any) optional

Single 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.

Required: No

Default value:

{
  "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": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe 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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit 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.

Required: No

Default value: null

label_key_case (string) optional

Controls 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.

Required: No

Default value: null

label_order (list(string)) optional

The 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.

Required: No

Default value: null

label_value_case (string) optional

Controls 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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set 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.
Notes:
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.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID 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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform 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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

bucket_arn: Bucket ARN
bucket_domain_name: Bucket domain name
bucket_id: Bucket ID
bucket_region: Bucket region
bucket_regional_domain_name: Bucket region-specific domain name

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.0, < 6.0.0
template, version: >= 2.2.0

Providers

aws, version: >= 4.0, < 6.0.0
template, version: >= 2.2.0

Modules

Name	Version	Source	Description
`account_map`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`bucket_policy`	2.0.2	`cloudposse/iam-policy/aws`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`s3_bucket`	4.10.0	`cloudposse/s3-bucket/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

Data Sources

The following data sources are used by this module:

aws_iam_policy_document.custom_policy (data source)
aws_partition.current (data source)
template_file.bucket_policy (data source)

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References