terraform-aws-s3-cloudtrail

Terraform module which creates S3 Bucket resources for CloudTrail on AWS.

Description

Provision S3 bucket designed for CloudTrail. This module provides recommended settings.

• Enable Access Logging
• Enable Default Encryption
• Enable Versioning
• Enable Lifecycle Configuration
• Protected from deletion

Usage

Minimal

module "s3_cloudtrail" {
  source                = "git::https://github.com/tmknom/terraform-aws-s3-cloudtrail.git?ref=tags/1.0.0"
  name                  = "s3-cloudtrail"
  logging_target_bucket = "s3-access-log"
}

Complete

module "s3_cloudtrail" {
  source                = "git::https://github.com/tmknom/terraform-aws-s3-cloudtrail.git?ref=tags/1.0.0"
  name                  = "s3-cloudtrail"
  logging_target_bucket = "s3-access-log"

  versioning_enabled = false
  force_destroy      = true

  lifecycle_rule_enabled                     = true
  lifecycle_rule_prefix                      = ""
  standard_ia_transition_days                = "60"
  glacier_transition_days                    = "90"
  expiration_days                            = "180"
  glacier_noncurrent_version_transition_days = "60"
  noncurrent_version_expiration_days         = "90"

  tags = {
    Environment = "prod"
    Name        = "s3-access-log"
  }
}

Examples

• Minimal
• Complete

Inputs

Name	Description	Type	Default	Required
logging_target_bucket	The name of the bucket that will receive the log objects.	string	-	yes
name	The name of the bucket, which must comply with DNS naming conventions.	string	-	yes
expiration_days	Specifies a period in the object's expire.	string	90	no
force_destroy	A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error.	string	false	no
glacier_noncurrent_version_transition_days	Specifies when noncurrent object versions transitions.	string	30	no
glacier_transition_days	Specifies a period in the object's Glacier transitions.	string	60	no
lifecycle_rule_enabled	Specifies lifecycle rule status.	string	true	no
lifecycle_rule_prefix	Object key prefix identifying one or more objects to which the rule applies.	string	``	no
noncurrent_version_expiration_days	Specifies when noncurrent object versions expire.	string	60	no
standard_ia_transition_days	Specifies a period in the object's STANDARD_IA transitions.	string	30	no
tags	A mapping of tags to assign to the bucket.	map	{}	no
versioning_enabled	Enable versioning. Versioning is a means of keeping multiple variants of an object in the same bucket.	string	true	no

Outputs

Name	Description
s3_bucket_arn	The ARN of the bucket. Will be of format arn:aws:s3:::bucketname.
s3_bucket_domain_name	The bucket domain name. Will be of format bucketname.s3.amazonaws.com.
s3_bucket_hosted_zone_id	The Route 53 Hosted Zone ID for this bucket's region.
s3_bucket_id	The name of the bucket.
s3_bucket_region	The AWS region this bucket resides in.

Development

Requirements

• Docker

Configure environment variables

export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
export AWS_DEFAULT_REGION=ap-northeast-1

Installation

git clone [email protected]:tmknom/terraform-aws-s3-cloudtrail.git
cd terraform-aws-s3-cloudtrail
make install

Makefile targets

check-format                   Check format code
cibuild                        Execute CI build
clean                          Clean .terraform
docs                           Generate docs
format                         Format code
help                           Show help
install                        Install requirements
lint                           Lint code
release                        Release GitHub and Terraform Module Registry
terraform-apply-complete       Run terraform apply examples/complete
terraform-apply-minimal        Run terraform apply examples/minimal
terraform-destroy-complete     Run terraform destroy examples/complete
terraform-destroy-minimal      Run terraform destroy examples/minimal
terraform-plan-complete        Run terraform plan examples/complete
terraform-plan-minimal         Run terraform plan examples/minimal
upgrade                        Upgrade makefile

Releasing new versions

Bump VERSION file, and run make release.

Terraform Module Registry

• https://registry.terraform.io/modules/tmknom/s3-cloudtrail/aws

License

Apache 2 Licensed. See LICENSE for full details.