terraform-aws-s3-bucket

This module creates an S3 bucket with support of versioning, 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.

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

It blocks public access to the bucket by default. https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html

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!

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

Using a canned ACL.

module "s3_bucket" {
  source                   = "git::https://github.com/cloudposse/terraform-aws-s3-bucket.git?ref=master"
  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                   = "git::https://github.com/cloudposse/terraform-aws-s3-bucket.git?ref=master"
  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"
    },
  ]
}

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.12.0
aws	>= 2.0
local	>= 1.2
null	>= 2.0

Providers

Name	Version
aws	>= 2.0

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 tags for appending to tags_as_list_of_maps. Not added to `tags`.	`map(string)`	`{}`	no
allow_encrypted_uploads_only	Set to `true` to prevent uploads of unencrypted objects to S3 bucket	`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	Additional attributes (e.g. `1`)	`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
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.	object({ enabled = bool namespace = string environment = string stage = string name = string delimiter = string attributes = list(string) tags = map(string) additional_tag_map = map(string) regex_replace_chars = string label_order = list(string) id_length_limit = number })	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "enabled": true, "environment": null, "id_length_limit": null, "label_order": [], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {} }	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 `namespace`, `environment`, `stage`, `name` and `attributes`. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
enable_glacier_transition	Enables the transition to AWS Glacier which can cause unnecessary costs for huge amount of small files	`bool`	`true`	no
enable_standard_ia_transition	Enables the transition to STANDARD_IA	`bool`	`false`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
environment	Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
expiration_days	Number of days after which to expunge the objects	`number`	`90`	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
glacier_transition_days	Number of days after which to move the data to the glacier storage tier	`number`	`60`	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. Set to `0` for unlimited length. Set to `null` for default, which is `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_order	The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present.	`list(string)`	`null`	no
lifecycle_rule_enabled	Enable or disable lifecycle rule	`bool`	`false`	no
lifecycle_tags	Tags filter. Used to manage object lifecycle events	`map(string)`	`{}`	no
logging	Bucket access logging configuration.	object({ bucket_name = string prefix = string })	`null`	no
name	Solution name, e.g. 'app' or 'jenkins'	`string`	`null`	no
namespace	Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'	`string`	`null`	no
noncurrent_version_expiration_days	Specifies when noncurrent object versions expire	`number`	`90`	no
noncurrent_version_transition_days	Number of days to persist in the standard storage tier before moving to the glacier tier infrequent access tier	`number`	`30`	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
prefix	Prefix identifying one or more objects to which the rule applies	`string`	`""`	no
regex_replace_chars	Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
replication_rules	Specifies the replication rules if S3 bucket replication is enabled	`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	The ARN of the S3 replica bucket (destination)	`string`	`""`	no
s3_replication_enabled	Set this to true and specify `s3_replica_bucket_arn` to enable replication. `versioning_enabled` must also be `true`.	`bool`	`false`	no
sse_algorithm	The server-side encryption algorithm to use. Valid values are `AES256` and `aws:kms`	`string`	`"AES256"`	no
stage	Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
standard_transition_days	Number of days to persist in the standard storage tier before moving to the infrequent access tier	`number`	`30`	no
tags	Additional tags (e.g. `map('BusinessUnit','XYZ')`	`map(string)`	`{}`	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`	`false`	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
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

bendavies/terraform-aws-s3-bucket