terraform-aws-s3-bucket

This module creates an S3 bucket with support of versioning, replication, encryption, ACL, and bucket object policy. If user_enabled variable is set to true, the module will provision a basic IAM user with permissions to access the bucket.

This basic IAM system user is suitable for CI/CD systems (e.g. TravisCI, CircleCI) or systems which are external to AWS that cannot leverage AWS IAM Instance Profiles and do not already have IAM credentials. Users or systems that have IAM credentials should either be granted access directly based on their IAM identity or be allowed to assume an IAM role with access.

We do not recommend creating IAM users this way for any other purpose.

This module blocks public access to the bucket by default. See block_public_acls, block_public_policy, and ignore_public_acls to change the settings. See AWS documentation for more details.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Security & Compliance

Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.

Benchmark	Description
	Infrastructure Security Compliance
	Center for Internet Security, KUBERNETES Compliance
	Center for Internet Security, AWS Compliance
	Center for Internet Security, AZURE Compliance
	Payment Card Industry Data Security Standards Compliance
	National Institute of Standards and Technology Compliance
	Information Security Management System, ISO/IEC 27001 Compliance
	Service Organization Control 2 Compliance
	Center for Internet Security, GCP Compliance
	Health Insurance Portability and Accountability Compliance

Usage

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.

Using a canned ACL.

module "s3_bucket" {
  source = "cloudposse/s3-bucket/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  acl                      = "private"
  enabled                  = true
  user_enabled             = true
  versioning_enabled       = false
  allowed_bucket_actions   = ["s3:GetObject", "s3:ListBucket", "s3:GetBucketLocation"]
  name                     = "app"
  stage                    = "test"
  namespace                = "eg"
}

Using grants to enable access to another account and for logging.

module "s3_bucket" {
  source = "cloudposse/s3-bucket/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  acl                      = ""
  enabled                  = true
  user_enabled             = true
  versioning_enabled       = false
  allowed_bucket_actions   = ["s3:GetObject", "s3:ListBucket", "s3:GetBucketLocation"]
  name                     = "app"
  stage                    = "test"
  namespace                = "eg"

  grants = [
    {
      id          = "012abc345def678ghi901" # Canonical user or account id
      type        = "CanonicalUser"
      permissions = ["FULL_CONTROL"]
      uri         = null
    },
    {
      id          = null
      type        = "Group"
      permissions = ["READ", "WRITE"]
      uri         = "http://acs.amazonaws.com/groups/s3/LogDelivery"
    },
  ]
}

Allowing specific principal ARNs to perform actions on the bucket:

module "s3_bucket" {
  source = "cloudposse/s3-bucket/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  acl                      = "private"
  enabled                  = true
  user_enabled             = true
  versioning_enabled       = false
  allowed_bucket_actions   = ["s3:GetObject", "s3:ListBucket", "s3:GetBucketLocation"]
  name                     = "app"
  stage                    = "test"
  namespace                = "eg"

  privileged_principal_arns = {
    "arn:aws:iam::123456789012:role/principal1" = ["prefix1/", "prefix2/"]
    "arn:aws:iam::123456789012:role/principal2" = [""]
  }
  privileged_principal_actions = [
    "s3:PutObject", 
    "s3:PutObjectAcl", 
    "s3:GetObject", 
    "s3:DeleteObject", 
    "s3:ListBucket", 
    "s3:ListBucketMultipartUploads", 
    "s3:GetBucketLocation", 
    "s3:AbortMultipartUpload"
  ]
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code
  test/%                              Run Terraform commands in the examples/complete folder; e.g. make test/plan

Requirements

Name	Version
terraform	>= 0.13.0
aws	>= 2.33

Providers

Name	Version
aws	>= 2.33

Modules

Name	Source	Version
s3_user	cloudposse/iam-s3-user/aws	0.15.3
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_iam_policy.replication	resource
aws_iam_role.replication	resource
aws_iam_role_policy_attachment.replication	resource
aws_s3_bucket.default	resource
aws_s3_bucket_policy.default	resource
aws_s3_bucket_public_access_block.default	resource
aws_iam_policy_document.aggregated_policy	data source
aws_iam_policy_document.bucket_policy	data source
aws_iam_policy_document.replication	data source
aws_iam_policy_document.replication_sts	data source
aws_partition.current	data source

Inputs

Name	Description	Type	Default	Required
abort_incomplete_multipart_upload_days	Maximum time (in days) that you want to allow multipart uploads to remain in progress	`number`	`5`	no
acl	The canned ACL to apply. We recommend `private` to avoid exposing sensitive information. Conflicts with `grants`.	`string`	`"private"`	no
additional_tag_map	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.	`map(string)`	`{}`	no
allow_encrypted_uploads_only	Set to `true` to prevent uploads of unencrypted objects to S3 bucket	`bool`	`false`	no
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
allowed_bucket_actions	List of actions the user is permitted to perform on the S3 bucket	`list(string)`	[ "s3:PutObject", "s3:PutObjectAcl", "s3:GetObject", "s3:DeleteObject", "s3:ListBucket", "s3:ListBucketMultipartUploads", "s3:GetBucketLocation", "s3:AbortMultipartUpload" ]	no
attributes	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.	`list(string)`	`[]`	no
block_public_acls	Set to `false` to disable the blocking of new public access lists on the bucket	`bool`	`true`	no
block_public_policy	Set to `false` to disable the blocking of new public policies on the bucket	`bool`	`true`	no
bucket_name	Bucket name. If provided, the bucket will be created with this name instead of generating the name from the context	`string`	`null`	no
context	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.	`any`	{ "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 }	no
cors_rule_inputs	Specifies the allowed headers, methods, origins and exposed headers when using CORS on this bucket	list(object({ allowed_headers = list(string) allowed_methods = list(string) allowed_origins = list(string) expose_headers = list(string) max_age_seconds = number }))	`null`	no
delimiter	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
descriptor_formats	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).	`any`	`{}`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
force_destroy	A boolean string that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable	`bool`	`false`	no
grants	An ACL policy grant. Conflicts with `acl`. Set `acl` to `null` to use this.	list(object({ id = string type = string permissions = list(string) uri = string }))	`null`	no
id_length_limit	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`.	`number`	`null`	no
ignore_public_acls	Set to `false` to disable the ignoring of public access lists on the bucket	`bool`	`true`	no
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
label_key_case	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`.	`string`	`null`	no
label_order	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.	`list(string)`	`null`	no
label_value_case	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`.	`string`	`null`	no
labels_as_tags	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.	`set(string)`	[ "default" ]	no
lifecycle_rules	A list of lifecycle rules	list(object({ prefix = string enabled = bool tags = map(string) enable_glacier_transition = bool enable_deeparchive_transition = bool enable_standard_ia_transition = bool enable_current_object_expiration = bool abort_incomplete_multipart_upload_days = number noncurrent_version_glacier_transition_days = number noncurrent_version_deeparchive_transition_days = number noncurrent_version_expiration_days = number standard_transition_days = number glacier_transition_days = number deeparchive_transition_days = number expiration_days = number }))	[ { "abort_incomplete_multipart_upload_days": 90, "deeparchive_transition_days": 90, "enable_current_object_expiration": true, "enable_deeparchive_transition": false, "enable_glacier_transition": true, "enable_standard_ia_transition": false, "enabled": false, "expiration_days": 90, "glacier_transition_days": 60, "noncurrent_version_deeparchive_transition_days": 60, "noncurrent_version_expiration_days": 90, "noncurrent_version_glacier_transition_days": 30, "prefix": "", "standard_transition_days": 30, "tags": {} } ]	no
logging	Bucket access logging configuration.	object({ bucket_name = string prefix = string })	`null`	no
name	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.	`string`	`null`	no
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
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.	object({ mode = string # Valid values are GOVERNANCE and COMPLIANCE. days = number years = number })	`null`	no
policy	A valid bucket policy JSON document. Note that if the policy document is not specific enough (but still valid), Terraform may view the policy as constantly changing in a terraform plan. In this case, please make sure you use the verbose/specific version of the policy	`string`	`""`	no
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
privileged_principal_arns	(Optional) Map of IAM Principal ARNs to lists of S3 path prefixes to grant `privileged_principal_actions` permissions. Resource list will include the bucket itself along with all the prefixes. Prefixes should not begin with '/'.	`map(list(string))`	`{}`	no
regex_replace_chars	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.	`string`	`null`	no
replication_rules	DEPRECATED: Use s3_replication_rules instead.	`list(any)`	`null`	no
restrict_public_buckets	Set to `false` to disable the restricting of making the bucket public	`bool`	`true`	no
s3_replica_bucket_arn	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.	`string`	`""`	no
s3_replication_enabled	Set this to true and specify `s3_replication_rules` to enable replication. `versioning_enabled` must also be `true`.	`bool`	`false`	no
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
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
sse_algorithm	The server-side encryption algorithm to use. Valid values are `AES256` and `aws:kms`	`string`	`"AES256"`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
transfer_acceleration_enabled	Set this to true to enable S3 Transfer Acceleration for the bucket.	`bool`	`false`	no
user_enabled	Set to `true` to create an IAM user with permission to access the bucket	`bool`	`false`	no
versioning_enabled	A state of versioning. Versioning is a means of keeping multiple variants of an object in the same bucket	`bool`	`true`	no
website_inputs	Specifies the static website hosting configuration object.	list(object({ index_document = string error_document = string redirect_all_requests_to = string routing_rules = string }))	`null`	no

Outputs

Name	Description
access_key_id	The access key ID
bucket_arn	Bucket ARN
bucket_domain_name	FQDN of bucket
bucket_id	Bucket Name (aka ID)
bucket_region	Bucket region
bucket_regional_domain_name	The bucket region-specific domain name
enabled	Is module enabled
replication_role_arn	The ARN of the replication IAM Role
secret_access_key	The secret access key. This will be written to the state file in plain-text
user_arn	The ARN assigned by AWS for the user
user_enabled	Is user creation enabled
user_name	Normalized IAM user name
user_unique_id	The user unique ID assigned by AWS

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

terraform-aws-cloudfront-s3-cdn - Terraform module to easily provision CloudFront CDN backed by an S3 origin
terraform-aws-s3-website - Terraform Module for Creating S3 backed Websites and Route53 DNS
terraform-aws-user-data-s3-backend - Terraform Module to Offload User Data to S3
terraform-aws-s3-logs-athena-query - A Terraform module that creates an Athena Database and Structure for querying S3 access logs
terraform-aws-lb-s3-bucket - Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs
terraform-aws-s3-log-storage - Terraform module creates an S3 bucket suitable for receiving logs from other AWS services such as S3, CloudFront, and CloudTrail

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
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.

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.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

Contributing

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 our other projects, we would love to hear from you! Shoot us an email.

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

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!

Copyright

License

See LICENSE for full details.

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.

Trademarks

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

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman	Andriy Knysh	Maxim Mironenko	Josh Myers	Yonatan Koren

adamantike / terraform-aws-s3-bucket Goto Github PK