Awesome

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/

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.0.0
<a name="requirement_aws"></a> aws	>= 4.0
<a name="requirement_template"></a> template	>= 2.2.0

Providers

Name	Version
<a name="provider_aws"></a> aws	>= 4.0
<a name="provider_template"></a> template	>= 2.2.0

Modules

Name	Source	Version
<a name="module_account_map"></a> account_map	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
<a name="module_bucket_policy"></a> bucket_policy	cloudposse/iam-policy/aws	0.4.0
<a name="module_iam_roles"></a> iam_roles	../account-map/modules/iam-roles	n/a
<a name="module_s3_bucket"></a> s3_bucket	cloudposse/s3-bucket/aws	3.1.1
<a name="module_this"></a> this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_iam_policy_document.custom_policy	data source
aws_partition.current	data source
template_file.bucket_policy	data source

Inputs

Name	Description	Type	Default	Required
<a name="input_account_map_environment_name"></a> account_map_environment_name	The name of the environment where `account_map` is provisioned	`string`	`"gbl"`	no
<a name="input_account_map_stage_name"></a> account_map_stage_name	The name of the stage where `account_map` is provisioned	`string`	`"root"`	no
<a name="input_account_map_tenant_name"></a> account_map_tenant_name	The name of the tenant where `account_map` is provisioned.<br><br>If the `tenant` label is not used, leave this as `null`.	`string`	`null`	no
<a name="input_acl"></a> acl	The canned ACL to apply.<br>We recommend `private` to avoid exposing sensitive information. Conflicts with `grants`.	`string`	`"private"`	no
<a name="input_additional_tag_map"></a> additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
<a name="input_allow_encrypted_uploads_only"></a> allow_encrypted_uploads_only	Set to `true` to prevent uploads of unencrypted objects to S3 bucket	`bool`	`false`	no
<a name="input_allow_ssl_requests_only"></a> allow_ssl_requests_only	Set to `true` to require requests to use Secure Socket Layer (HTTPS/SSL). This will explicitly deny access to HTTP requests	`bool`	`false`	no
<a name="input_allowed_bucket_actions"></a> allowed_bucket_actions	List of actions the user is permitted to perform on the S3 bucket	`list(string)`	<pre>[<br> "s3:PutObject",<br> "s3:PutObjectAcl",<br> "s3:GetObject",<br> "s3:DeleteObject",<br> "s3:ListBucket",<br> "s3:ListBucketMultipartUploads",<br> "s3:GetBucketLocation",<br> "s3:AbortMultipartUpload"<br>]</pre>	no
<a name="input_attributes"></a> attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element.	`list(string)`	`[]`	no
<a name="input_block_public_acls"></a> block_public_acls	Set to `false` to disable the blocking of new public access lists on the bucket	`bool`	`true`	no
<a name="input_block_public_policy"></a> block_public_policy	Set to `false` to disable the blocking of new public policies on the bucket	`bool`	`true`	no
<a name="input_bucket_key_enabled"></a> bucket_key_enabled	Set this to true to use Amazon S3 Bucket Keys for SSE-KMS, which reduce the cost of AWS KMS requests.<br>For more information, see: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html	`bool`	`false`	no
<a name="input_bucket_name"></a> bucket_name	Bucket name. If provided, the bucket will be created with this name instead of generating the name from the context	`string`	`""`	no
<a name="input_context"></a> context	Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional_tag_map, which are merged.	`any`	<pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre>	no
<a name="input_cors_configuration"></a> cors_configuration	Specifies the allowed headers, methods, origins and exposed headers when using CORS on this bucket	<pre>list(object({<br> allowed_headers = list(string)<br> allowed_methods = list(string)<br> allowed_origins = list(string)<br> expose_headers = list(string)<br> max_age_seconds = number<br> }))</pre>	`null`	no
<a name="input_custom_policy_account_names"></a> custom_policy_account_names	List of accounts names to assign as principals for the s3 bucket custom policy	`list(string)`	`[]`	no
<a name="input_custom_policy_actions"></a> custom_policy_actions	List of S3 Actions for the custom policy	`list(string)`	`[]`	no
<a name="input_custom_policy_enabled"></a> custom_policy_enabled	Whether to enable or disable the custom policy. If enabled, the default policy will be ignored	`bool`	`false`	no
<a name="input_delimiter"></a> delimiter	Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
<a name="input_descriptor_formats"></a> descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br> format = string<br> labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
<a name="input_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_environment"></a> environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
<a name="input_force_destroy"></a> force_destroy	When `true`, permits a non-empty S3 bucket to be deleted by first deleting all objects in the bucket.<br>THESE OBJECTS ARE NOT RECOVERABLE even if they were versioned and stored in Glacier.	`bool`	`false`	no
<a name="input_grants"></a> grants	A list of policy grants for the bucket, taking a list of permissions.<br>Conflicts with `acl`. Set `acl` to `null` to use this.	<pre>list(object({<br> id = string<br> type = string<br> permissions = list(string)<br> uri = string<br> }))</pre>	`[]`	no
<a name="input_iam_policy_statements"></a> iam_policy_statements	Map of IAM policy statements to use in the bucket policy.	`any`	`{}`	no
<a name="input_id_length_limit"></a> id_length_limit	Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for keep the existing setting, which defaults to `0`.<br>Does not affect `id_full`.	`number`	`null`	no
<a name="input_ignore_public_acls"></a> ignore_public_acls	Set to `false` to disable the ignoring of public access lists on the bucket	`bool`	`true`	no
<a name="input_kms_master_key_arn"></a> kms_master_key_arn	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`	`string`	`""`	no
<a name="input_label_key_case"></a> label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`.	`string`	`null`	no
<a name="input_label_order"></a> label_order	The order in which the labels (ID elements) appear in the `id`.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
<a name="input_label_value_case"></a> label_value_case	Controls the letter case of ID elements (labels) as included in `id`,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br>Default value: `lower`.	`string`	`null`	no
<a name="input_labels_as_tags"></a> labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the `tags` output.<br>Set to `[]` to suppress all generated tags.<br>Notes:<br> The value of the `name` tag, if included, will be the `id`, not the `name`.<br> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	<pre>[<br> "default"<br>]</pre>	no
<a name="input_lifecycle_configuration_rules"></a> lifecycle_configuration_rules	A list of lifecycle V2 rules	<pre>list(object({<br> enabled = bool<br> id = string<br><br> abort_incomplete_multipart_upload_days = number<br><br> # `filter_and` is the `and` configuration block inside the `filter` configuration.<br> # This is the only place you should specify a prefix.<br> filter_and = any<br> expiration = any<br> transition = list(any)<br><br> noncurrent_version_expiration = any<br> noncurrent_version_transition = list(any)<br> }))</pre>	`[]`	no
<a name="input_logging"></a> logging	Bucket access logging configuration.	<pre>object({<br> bucket_name = string<br> prefix = string<br> })</pre>	`null`	no
<a name="input_logging_bucket_name_rendering_enabled"></a> logging_bucket_name_rendering_enabled	Whether to render the logging bucket name, prepending context	`bool`	`false`	no
<a name="input_logging_bucket_name_rendering_template"></a> logging_bucket_name_rendering_template	The template for the template used to render Bucket Name for the Logging bucket.<br>Default is appropriate when using `tenant` and default label order with `null-label`.<br>Use `"%s-%s-%s-%%s"` when not using `tenant`.	`string`	`"%s-%s-%s-%s-%s"`	no
<a name="input_logging_bucket_prefix_rendering_template"></a> logging_bucket_prefix_rendering_template	The template for the template used to render Bucket Prefix for the Logging bucket, uses the format `var.logging.prefix`/`var.name`	`string`	`"%s/%s/"`	no
<a name="input_name"></a> name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a `tag`.<br>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
<a name="input_namespace"></a> namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
<a name="input_object_lock_configuration"></a> object_lock_configuration	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.	<pre>object({<br> mode = string # Valid values are GOVERNANCE and COMPLIANCE.<br> days = number<br> years = number<br> })</pre>	`null`	no
<a name="input_privileged_principal_actions"></a> privileged_principal_actions	List of actions to permit `privileged_principal_arns` to perform on bucket and bucket prefixes (see `privileged_principal_arns`)	`list(string)`	`[]`	no
<a name="input_privileged_principal_arns"></a> privileged_principal_arns	List of maps. Each map has one key, an IAM Principal ARN, whose associated value is<br>a list of S3 path prefixes to grant `privileged_principal_actions` permissions for that principal,<br>in addition to the bucket itself, which is automatically included. Prefixes should not begin with '/'.	`list(map(list(string)))`	`[]`	no
<a name="input_regex_replace_chars"></a> regex_replace_chars	Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
<a name="input_region"></a> region	AWS Region	`string`	n/a	yes
<a name="input_restrict_public_buckets"></a> restrict_public_buckets	Set to `false` to disable the restricting of making the bucket public	`bool`	`true`	no
<a name="input_s3_object_ownership"></a> s3_object_ownership	Specifies the S3 object ownership control. Valid values are `ObjectWriter`, `BucketOwnerPreferred`, and 'BucketOwnerEnforced'.	`string`	`"ObjectWriter"`	no
<a name="input_s3_replica_bucket_arn"></a> s3_replica_bucket_arn	A single S3 bucket ARN to use for all replication rules.<br>Note: The destination bucket can be specified in the replication rule itself<br>(which allows for multiple destinations), in which case it will take precedence over this variable.	`string`	`""`	no
<a name="input_s3_replication_enabled"></a> s3_replication_enabled	Set this to true and specify `s3_replication_rules` to enable replication. `versioning_enabled` must also be `true`.	`bool`	`false`	no
<a name="input_s3_replication_rules"></a> s3_replication_rules	Specifies the replication rules for S3 bucket replication if enabled. You must also set s3_replication_enabled to true.	`list(any)`	`null`	no
<a name="input_s3_replication_source_roles"></a> s3_replication_source_roles	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).	`list(string)`	`[]`	no
<a name="input_source_policy_documents"></a> source_policy_documents	List of IAM policy documents that are merged together into the exported document.<br>Statements defined in source_policy_documents or source_json must have unique SIDs.<br>Statement having SIDs that match policy SIDs generated by this module will override them.	`list(string)`	`[]`	no
<a name="input_sse_algorithm"></a> sse_algorithm	The server-side encryption algorithm to use. Valid values are `AES256` and `aws:kms`	`string`	`"AES256"`	no
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_tags"></a> tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br>Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
<a name="input_tenant"></a> tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
<a name="input_transfer_acceleration_enabled"></a> transfer_acceleration_enabled	Set this to true to enable S3 Transfer Acceleration for the bucket.	`bool`	`false`	no
<a name="input_user_enabled"></a> user_enabled	Set to `true` to create an IAM user with permission to access the bucket	`bool`	`false`	no
<a name="input_versioning_enabled"></a> versioning_enabled	A state of versioning. Versioning is a means of keeping multiple variants of an object in the same bucket	`bool`	`true`	no
<a name="input_website_inputs"></a> website_inputs	Specifies the static website hosting configuration object.	<pre>list(object({<br> index_document = string<br> error_document = string<br> redirect_all_requests_to = string<br> routing_rules = string<br> }))</pre>	`null`	no

Outputs

Name	Description
<a name="output_bucket_arn"></a> bucket_arn	Bucket ARN
<a name="output_bucket_domain_name"></a> bucket_domain_name	Bucket domain name
<a name="output_bucket_id"></a> bucket_id	Bucket ID
<a name="output_bucket_region"></a> bucket_region	Bucket region
<a name="output_bucket_regional_domain_name"></a> bucket_regional_domain_name	Bucket region-specific domain name

References

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

[!NOTE] This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.
<details><summary>Learn More</summary>
It's 100% Open Source and licensed under the APACHE2.
</details>

Related Projects

Check out these related projects.

Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
Atmos - Atmos is like docker-compose but for your infrastructure

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

🐛 Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

💻 Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you! Hit us up in Slack, in the #cloudposse channel.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-s3-bucket&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

About

This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-s3-bucket&utm_content=">Cloud Posse, LLC</a>. <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-s3-bucket&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>

We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.

Your team can operate like a pro today.

Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.

<details> <summary>📚 See What's Included</summary>

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

</details>

License

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.