Terraform AWS S3 module

Terraform module to handle S3 buckets, bucket objects and bucket notifications resources on AWS.

These types of resources are supported:

• S3 Bucket
• S3 Bucket Ownership Controls
• S3 Bucket-level Public Access Block
• S3 Bucket ACL
• S3 Bucket Policy
• S3 Bucket Versioning
• S3 Bucket Website Configuration
• S3 Bucket Logging
• S3 Object
• S3 Bucket Notification

Usage

module "bucket" {
  source = "github.com/chgasparoto/terraform-s3-object-notification"

  name   = "my-super-unique-bucket-name"
  acl    = "public-read"
  policy = {
    json = templatefile("policy.json", {
      bucket_name = local.domain
    })
  }

  versioning = {
    status = "Enabled"
  }

  # This property activates the module to upload the files to the bucket.
  filepath = "path/to/my/website/files"
  website = {
    index_document = "index.html"
    error_document = "error.html"
  }

  logging = {
    target_bucket = module.logs.name
    target_prefix = "access/"
  }

  notification_topic = [{
    topic_arn     = aws_sns_topic.topic.arn
    events        = "s3:ObjectCreated:*"
    filter_suffix = ".log"
  }]

  notification_queue = [{
    queue_arn     = aws_sqs_queue.queue.arn
    events        = "s3:ObjectCreated:*,s3:ObjectRemoved:*"
    filter_suffix = ".jpg"
  }]

  # This property creates the needed permissions for the bucket be able to call the lambda.
  notification_lambda = [{
    lambda_function_arn = aws_lambda_function.func.arn
    events              = join(",", ["s3:ObjectCreated:*", "s3:ObjectRemoved:*])
    filter_suffix       = ".png"
  }]
}

Examples

• Simple Bucket
• Static Website
• S3 Notifications

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 4.0.0

Inputs

Name	Description	Type	Default	Required
name	Bucket unique name	string	null	✅
ownership	Object ownership	string	BucketOwnerPreferred
acl	Bucket ACL	string	private
policy	Bucket Policy	object({ json = string })		null
block_public_acls	Whether to block public ACLs	bool	true
block_public_policy	Whether to block public policiy	bool	true
ignore_public_acls	Whether to ignore public ACLs	bool	true
restrict_public_buckets	Whether to restrict public buckets	bool	true
force_destroy	Whether or not to force destroy the bucket	bool	false
tags	Bucket Tags	map(string)	{}
key_prefix	Prefix to put your key(s) inside the bucket. E.g.: logs -> all files will be uploaded under logs/	string
filepath	The local path where the desired files will be uploaded to the bucket	string
versioning	Object containing versioning configuration	object({ expected_bucket_owner: string status: string mfa: string mfa_delete: string })	{}
website	Map containing website configuration	map(string)	{}
logging	Map containing logging configuration	map(string)	{}
notification_topic	List of maps containing notification_topic configuration	list(map(string))	[{}]
notification_queue	List of maps containing notification_queue configuration	list(map(string))	[{}]
notification_lambda	List of maps containing notification_lambda configuration	list(map(string))	[{}]

Outputs

Name	Description
arn	The ARN of the bucket. Will be of format arn:aws:s3:::bucketname
name	Bucket name
website	The website endpoint, if the bucket is configured with a website. If not, this will be an empty string
regional_domain_name	The bucket region-specific domain name. E.g.: bucketname.s3.eu-central-1.amazonaws.com
domain_name	The bucket domain name. Will be of format bucketname.s3.amazonaws.com
website_domain	The domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records.
hosted_zone_id	The Route 53 Hosted Zone ID for this bucket's region
objects	List of objects uploaded to the bucket
notifications	Map of bucket notifications (lambda, queue and, topic)

Authors

Module managed by Cleber Gasparoto

License

MIT