Skip to main content
Sponsor @cloudposse

Module: lb-s3-bucket

Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs.

Usage​

For a complete example, see examples/complete. For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "s3_bucket" {
  source = "cloudposse/lb-s3-bucket/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  namespace = "eg"
  stage     = "test"
  name      = "bucket"
}

Variables​

Required Variables​

Optional Variables​

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

acl (string) optional

Canned ACL to apply to the S3 bucket


Default value: "log-delivery-write"

allow_ssl_requests_only (bool) optional

Require requests to use Secure Socket Layer (HTTPS/SSL).


Default value: true

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

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

expiration_days (number) optional

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


Default value: 90

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

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 = any
expiration = any
transition = list(any)

noncurrent_version_expiration = any
noncurrent_version_transition = list(any)
}))

Default value: [ ]

lifecycle_prefix (string) optional

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


Default value: ""

lifecycle_rule_enabled (bool) optional

DEPRECATED: Defaults to false, use lifecycle_configuration_rules instead.
When true, configures lifecycle events on this bucket using individual (now deprecated) variables."



Default value: false

noncurrent_version_expiration_days (number) optional

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


Default value: 90

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

s3_object_ownership (string) optional

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


Default value: "BucketOwnerPreferred"

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

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

S3 bucket ARN

bucket_domain_name

S3 bucket domain name

bucket_id

S3 bucket ID

bucket_prefix

S3 bucket prefix

enabled

Is module enabled

Dependencies​

Requirements​

  • terraform, version: >= 1.3.0
  • aws, version: >= 4.0

Providers​

  • aws, version: >= 4.0

Modules​

NameVersionSourceDescription
bucket_name0.25.0cloudposse/label/nulln/a
s3_bucket1.4.3cloudposse/s3-log-storage/awsn/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: