Module: `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.

Usage

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]
}

Variables

Required Variables

Optional Variables

abort_incomplete_multipart_upload_days (number) optional

(Deprecated, use lifecycle_configuration_rules instead)
Maximum time (in days) that you want to allow multipart uploads to remain in progress

Default value: null

access_log_bucket_name (string) optional

Name of the S3 bucket where S3 access logs will be sent to

Default value: ""

access_log_bucket_prefix (string) optional

Prefix to prepend to the current S3 bucket name, where S3 access logs will be sent to

Default value: "logs/"

acl (string) optional

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.

Default value: "log-delivery-write"

allow_encrypted_uploads_only (bool) optional

Set to true to prevent uploads of unencrypted objects to S3 bucket

Default value: false

allow_ssl_requests_only (bool) optional

Set to true to require requests to use Secure Socket Layer (HTTPS/SSL). This will explicitly deny access to HTTP requests

Default value: true

block_public_acls (bool) optional

Set to false to disable the blocking of new public access lists on the bucket

Default value: true

block_public_policy (bool) optional

Set to false to disable the blocking of new public policies on the bucket

Default value: true

bucket_key_enabled (bool) optional

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

Default value: false

bucket_name (string) optional

Bucket name. If provided, the bucket will be created with this name
instead of generating the name from the context.

Default value: ""

bucket_notifications_enabled (bool) optional

Send notifications for the object created events. Used for 3rd-party log collection from a bucket

Default value: false

bucket_notifications_prefix (string) optional

Prefix filter. Used to manage object notifications

Default value: ""

bucket_notifications_type (string) optional

Type of the notification configuration. Only SQS is supported.

Default value: "SQS"

enable_glacier_transition (bool) optional

(Deprecated, use lifecycle_configuration_rules instead)
Enables the transition to AWS Glacier which can cause unnecessary costs for huge amount of small files

Default value: null

enable_noncurrent_version_expiration (bool) optional

(Deprecated, use lifecycle_configuration_rules instead)
Enable expiration of non-current versions

Default value: null

expiration_days (number) optional

(Deprecated, use lifecycle_configuration_rules instead)
Number of days after which to expunge the objects

Default value: null

force_destroy (bool) optional

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.

Default value: false

glacier_transition_days (number) optional

(Deprecated, use lifecycle_configuration_rules instead)
Number of days after which to move the data to the Glacier Flexible Retrieval storage tier

Default value: null

grants optional

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

Type:

list(object({
id          = string
type        = string
permissions = list(string)
uri         = string
}))

Default value: [ ]

ignore_public_acls (bool) optional

Set to false to disable the ignoring of public access lists on the bucket

Default value: true

kms_master_key_arn (string) optional

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

Default value: ""

lifecycle_configuration_rules optional

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.

Type:

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.
})), [])
}))

Default value: [ ]

lifecycle_prefix (string) optional

(Deprecated, use lifecycle_configuration_rules instead)
Prefix filter. Used to manage object lifecycle events

Default value: null

lifecycle_rule_enabled (bool) optional

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.

Default value: null

lifecycle_tags (map(string)) optional

(Deprecated, use lifecycle_configuration_rules instead)
Tags filter. Used to manage object lifecycle events

Default value: null

noncurrent_version_expiration_days (number) optional

(Deprecated, use lifecycle_configuration_rules instead)
Specifies when non-current object versions expire (in days)

Default value: null

noncurrent_version_transition_days (number) optional

(Deprecated, use lifecycle_configuration_rules instead)
Specifies (in days) when noncurrent object versions transition to Glacier Flexible Retrieval

Default value: null

object_lock_configuration optional

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.

Type:

object({
mode  = string # Valid values are GOVERNANCE and COMPLIANCE.
days  = number
years = number
})

Default value: null

policy (string) optional

(Deprecated, use source_policy_documents instead): A valid bucket policy JSON document.

Default value: null

restrict_public_buckets (bool) optional

Set to false to disable the restricting of making the bucket public

Default value: true

s3_object_ownership (string) optional

Specifies the S3 object ownership control. Valid values are ObjectWriter, BucketOwnerPreferred, and 'BucketOwnerEnforced'.

Default value: "BucketOwnerPreferred"

source_policy_documents (list(string)) optional

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.

Default value: [ ]

sse_algorithm (string) optional

The server-side encryption algorithm to use. Valid values are AES256 and aws:kms

Default value: "AES256"

standard_transition_days (number) optional

(Deprecated, use lifecycle_configuration_rules instead)
Number of days to persist in the standard storage tier before moving to the infrequent access tier

Default value: null

versioning_enabled (bool) optional

Enable object versioning, keeping multiple variants of an object in the same bucket

Default value: true

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

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

Dependencies

Requirements

terraform, version: >= 1.3.0
aws, version: >= 4.9.0
time, version: >= 0.7

Providers

aws, version: >= 4.9.0

Modules

Name	Version	Source	Description
`aws_s3_bucket`	3.1.3	`cloudposse/s3-bucket/aws`	n/a
`bucket_name`	0.25.0	`cloudposse/label/null`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_s3_bucket_notification.bucket_notification (resource)
aws_sqs_queue.notifications (resource)

Data Sources

The following data sources are used by this module:

aws_caller_identity.current (data source)
aws_iam_policy_document.sqs_policy (data source)
aws_partition.current (data source)

Module: s3-log-storage

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `s3-log-storage`

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources