terraform-aws-s3-log-storage

This module creates an S3 bucket suitable for receiving logs from other AWS services such as S3, CloudFront, and CloudTrails.

This module implements a configurable log retention policy, which allows you to efficiently manage logs across different storage classes (e.g. Glacier) and ultimately expire the data altogether.

It enables default server-side encryption.

It blocks public access to the bucket by default.

As of March, 2022, this module is primarily a wrapper around our s3-bucket module, with some options preconfigured and SQS notifications added. If it does not exactly suit your needs, you may want to use the s3-bucket module directly.

As of version 1.0 of this module, most of the inputs are marked nullable = false, meaning you can pass in null and get the default value rather than having the input be actually set to null. This is technically a breaking change from previous versions, but since null was not a valid value for most of these variables, we are not considering it a truly breaking change. However, be mindful that the behavior of inputs set to null may change in the future, so we recommend setting them to the desired value explicitly.

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.

This module supports full S3 storage lifecycle configuration via our s3-bucket module:

locals {
  lifecycle_configuration_rule = {
    enabled = true # bool
    id      = "v2rule"

    abort_incomplete_multipart_upload_days = 1 # number

    filter_and = null
    expiration = {
      days = 120 # integer > 0
    }
    noncurrent_version_expiration = {
      newer_noncurrent_versions = 3  # integer > 0
      noncurrent_days           = 60 # integer >= 0
    }
    transition = [{
      days          = 30            # integer >= 0
      storage_class = "STANDARD_IA" # string/enum, one of GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR.
      },
      {
        days          = 60           # integer >= 0
        storage_class = "ONEZONE_IA" # string/enum, one of GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR.
    }]
    noncurrent_version_transition = [{
      newer_noncurrent_versions = 3            # integer >= 0
      noncurrent_days           = 30           # integer >= 0
      storage_class             = "ONEZONE_IA" # string/enum, one of GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR.
    }]
  }
}

module "log_storage" {
  source = "cloudposse/s3-log-storage/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  name      = "logs"
  stage     = "test"
  namespace = "eg"
  
  versioning_enabled            = true
  lifecycle_configuration_rules = [var.lifecycle_configuration_rule]
}

Makefile Targets

Available targets:

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

Requirements

Name	Version
terraform	>= 1.3.0
aws	>= 4.9.0
time	>= 0.7

Providers

Name	Version
aws	>= 4.9.0

Modules

Name	Source	Version
aws_s3_bucket	cloudposse/s3-bucket/aws	3.1.2
bucket_name	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_s3_bucket_notification.bucket_notification	resource
aws_sqs_queue.notifications	resource
aws_caller_identity.current	data source
aws_iam_policy_document.sqs_policy	data source
aws_partition.current	data source

Inputs

Name	Description	Type	Default	Required
abort_incomplete_multipart_upload_days	(Deprecated, use `lifecycle_configuration_rules` instead) Maximum time (in days) that you want to allow multipart uploads to remain in progress	`number`	`null`	no
access_log_bucket_name	Name of the S3 bucket where S3 access logs will be sent to	`string`	`""`	no
access_log_bucket_prefix	Prefix to prepend to the current S3 bucket name, where S3 access logs will be sent to	`string`	`"logs/"`	no
acl	The canned ACL to apply. Deprecated by AWS in favor of bucket policies. Automatically disabled if `s3_object_ownership` is set to "BucketOwnerEnforced". Defaults to "private" for backwards compatibility, but we recommend setting `s3_object_ownership` to "BucketOwnerEnforced" instead.	`string`	`"log-delivery-write"`	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`	`true`	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_key_enabled	Set this to true to use Amazon S3 Bucket Keys for SSE-KMS, which reduce the cost of AWS KMS requests. For more information, see: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html	`bool`	`false`	no
bucket_name	Bucket name. If provided, the bucket will be created with this name instead of generating the name from the context.	`string`	`""`	no
bucket_notifications_enabled	Send notifications for the object created events. Used for 3rd-party log collection from a bucket	`bool`	`false`	no
bucket_notifications_prefix	Prefix filter. Used to manage object notifications	`string`	`""`	no
bucket_notifications_type	Type of the notification configuration. Only SQS is supported.	`string`	`"SQS"`	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
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
enable_glacier_transition	(Deprecated, use `lifecycle_configuration_rules` instead) Enables the transition to AWS Glacier which can cause unnecessary costs for huge amount of small files	`bool`	`null`	no
enable_noncurrent_version_expiration	(Deprecated, use `lifecycle_configuration_rules` instead) Enable expiration of non-current versions	`bool`	`null`	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
expiration_days	(Deprecated, use `lifecycle_configuration_rules` instead) Number of days after which to expunge the objects	`number`	`null`	no
force_destroy	When `true`, permits a non-empty S3 bucket to be deleted by first deleting all objects in the bucket. THESE OBJECTS ARE NOT RECOVERABLE even if they were versioned and stored in Glacier. Must be set `false` unless `force_destroy_enabled` is also `true`.	`bool`	`false`	no
glacier_transition_days	(Deprecated, use `lifecycle_configuration_rules` instead) Number of days after which to move the data to the Glacier Flexible Retrieval storage tier	`number`	`null`	no
grants	A list of policy grants for the bucket, taking a list of permissions. Conflicts with `acl`. Set `acl` to `null` to use this. Deprecated by AWS in favor of bucket policies, but still required for some log delivery services. Automatically disabled if `s3_object_ownership` is set to "BucketOwnerEnforced".	list(object({ id = string type = string permissions = list(string) uri = string }))	`[]`	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_configuration_rules	A list of S3 bucket v2 lifecycle rules, as specified in terraform-aws-s3-bucket" These rules are not affected by the deprecated `lifecycle_rule_enabled` flag. NOTE: Unless you also set `lifecycle_rule_enabled = false` you will also get the default deprecated rules set on your bucket.	list(object({ enabled = bool id = string abort_incomplete_multipart_upload_days = number # `filter_and` is the `and` configuration block inside the `filter` configuration. # This is the only place you should specify a prefix. filter_and = optional(object({ object_size_greater_than = optional(number) # integer >= 0 object_size_less_than = optional(number) # integer >= 1 prefix = optional(string) tags = optional(map(string)) })) expiration = optional(object({ date = optional(string) # string, RFC3339 time format, GMT days = optional(number) # integer > 0 expired_object_delete_marker = optional(bool) })) noncurrent_version_expiration = optional(object({ newer_noncurrent_versions = optional(number) # integer > 0 noncurrent_days = optional(number) # integer >= 0 })) transition = optional(list(object({ date = optional(string) # string, RFC3339 time format, GMT days = optional(number) # integer >= 0 storage_class = string # string/enum, one of GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR. })), []) noncurrent_version_transition = optional(list(object({ newer_noncurrent_versions = optional(number) # integer >= 0 noncurrent_days = optional(number) # integer >= 0 storage_class = string # string/enum, one of GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR. })), []) }))	`[]`	no
lifecycle_prefix	(Deprecated, use `lifecycle_configuration_rules` instead) Prefix filter. Used to manage object lifecycle events	`string`	`null`	no
lifecycle_rule_enabled	DEPRECATED: Use `lifecycle_configuration_rules` instead. When `true`, configures lifecycle events on this bucket using individual (now deprecated) variables. When `false`, lifecycle events are not configured using individual (now deprecated) variables, but `lifecycle_configuration_rules` still apply. When `null`, lifecycle events are configured using individual (now deprecated) variables only if `lifecycle_configuration_rules` is empty.	`bool`	`null`	no
lifecycle_tags	(Deprecated, use `lifecycle_configuration_rules` instead) Tags filter. Used to manage object lifecycle events	`map(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
noncurrent_version_expiration_days	(Deprecated, use `lifecycle_configuration_rules` instead) Specifies when non-current object versions expire (in days)	`number`	`null`	no
noncurrent_version_transition_days	(Deprecated, use `lifecycle_configuration_rules` instead) Specifies (in days) when noncurrent object versions transition to Glacier Flexible Retrieval	`number`	`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	(Deprecated, use `source_policy_documents` instead): A valid bucket policy JSON document.	`string`	`null`	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
restrict_public_buckets	Set to `false` to disable the restricting of making the bucket public	`bool`	`true`	no
s3_object_ownership	Specifies the S3 object ownership control. Valid values are `ObjectWriter`, `BucketOwnerPreferred`, and 'BucketOwnerEnforced'.	`string`	`"BucketOwnerPreferred"`	no
source_policy_documents	List of IAM policy documents that are merged together into the exported document. Statements defined in source_policy_documents must have unique SIDs. Statement having SIDs that match policy SIDs generated by this module will override them.	`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
standard_transition_days	(Deprecated, use `lifecycle_configuration_rules` instead) Number of days to persist in the standard storage tier before moving to the infrequent access tier	`number`	`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
versioning_enabled	Enable object versioning, keeping multiple variants of an object in the same bucket	`bool`	`true`	no

Outputs

Name	Description
bucket_arn	Bucket ARN
bucket_domain_name	FQDN of bucket
bucket_id	Bucket Name (aka ID)
bucket_notifications_sqs_queue_arn	Notifications SQS queue ARN
enabled	Is module enabled
prefix	Prefix configured for lifecycle rules

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-s3-bucket - Terraform module that creates an S3 bucket with an optional IAM user for external CI/CD systems
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

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	Vladimir	Gonzalo Peci	Nuru

cloudposse/terraform-aws-s3-log-storage

cloudposse

Reviews

Repository Details