Module: `config-storage`

This module creates an S3 bucket suitable for storing AWS Config data.

It 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 server-side default encryption. https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html

It blocks public access to the bucket by default. https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html

Usage

Here's how to invoke this example module in your projects

module "aws_config_storage" {
  source = "cloudposse/config-storage/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  name                     = "aws-config"
  stage                    = "test"
  namespace                = "eg"
  standard_transition_days = 30
  glacier_transition_days  = 60
}

Examples

Here is an example of using this module:

examples/complete - complete example of using this module

Variables

Required Variables

Optional Variables

abort_incomplete_multipart_upload_days (number) optional

Maximum time (in days) that you want to allow multipart uploads to remain in progress

Default value: 5

access_log_bucket_name (string) optional

Name of the S3 bucket where s3 access log will be sent to

Default value: ""

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: false

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

Enables the transition to AWS Glacier which can cause unnecessary costs for huge amount of small files

Default value: true

expiration_days (number) optional

Number of days after which to expunge the objects

Default value: 90

force_destroy (bool) optional

(Optional, Default:false ) A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable

Default value: false

glacier_transition_days (number) optional

Number of days after which to move the data to the glacier storage tier

Default value: 60

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_prefix (string) optional

Prefix filter. Used to manage object lifecycle events

Default value: ""

lifecycle_rule_enabled (bool) optional

Enable lifecycle events on this bucket

Default value: true

lifecycle_tags (map(string)) optional

Tags filter. Used to manage object lifecycle events

Default value: { }

noncurrent_version_expiration_days (number) optional

Specifies when noncurrent object versions expire

Default value: 90

noncurrent_version_transition_days (number) optional

Specifies when noncurrent object versions transitions

Default value: 30

policy (string) optional

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

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

Number of days to persist in the standard storage tier before moving to the infrequent access tier

Default value: 30

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.0
aws, version: >= 5.0

Providers

aws, version: >= 5.0

Modules

Name	Version	Source	Description
`aws_config_label`	0.25.0	`cloudposse/label/null`	n/a
`storage`	1.4.1	`cloudposse/s3-log-storage/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

Data Sources

The following data sources are used by this module:

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

Module: config-storage

Usage​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `config-storage`

Usage

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources