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.

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

module "s3_bucket" {
  source                   = "git::https://github.com/cloudposse/terraform-aws-s3-bucket.git?ref=master"
  enabled                  = "${var.enabled}"
  user_enabled             = "${var.user_enabled}"
  versioning_enabled       = "${var.versioning_enabled}"
  allowed_bucket_actions   = "${var.allowed_bucket_actions}"
  name                     = "${var.name}"
  stage                    = "${var.stage}"
  namespace                = "${var.namespace}"
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Inputs

Name	Description	Type	Default	Required
acl	The canned ACL to apply. We recommend `private` to avoid exposing sensitive information	string	`private`	no
allow_encrypted_uploads_only	Set to `true` to prevent uploads of unencrypted objects to S3 bucket	string	`false`	no
allowed_bucket_actions	List of actions the user is permitted to perform on the S3 bucket	list	`<list>`	no
attributes	Additional attributes (e.g. `1`)	list	`<list>`	no
delimiter	Delimiter to be used between `namespace`, `stage`, `name` and `attributes`	string	`-`	no
enabled	Set to `false` to prevent the module from creating any resources	string	`true`	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.	string	`false`	no
kms_master_key_id	The AWS KMS master key ID 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
name	Name (e.g. `app` or `db`)	string	-	yes
namespace	Namespace (e.g. `eg` or `cp`)	string	-	yes
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
region	If specified, the AWS region this bucket should reside in. Otherwise, the region used by the callee.	string	``	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`, `dev`, `staging`)	string	-	yes
tags	Additional tags (e.g. `{ BusinessUnit = "XYZ" }`	map	`<map>`	no
user_enabled	Set to `true` to create an S3 user with permission to access the bucket	string	`false`	no
versioning_enabled	A state of versioning. Versioning is a means of keeping multiple variants of an object in the same bucket.	string	`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)
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?

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

Commercial Support

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

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

Questions. We'll use a Shared Slack channel between your team and ours.
Troubleshooting. We'll help you triage why things aren't working.
Code Reviews. We'll review your Pull Requests and provide constructive feedback.
Bug Fixes. We'll rapidly work to fix any bugs in our projects.
Build New Terraform Modules. We'll develop original modules to provision infrastructure.
Cloud Architecture. We'll assist with your cloud strategy and design.
Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

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.

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

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

kpankonen/terraform-aws-s3-bucket