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

Requirements

Name	Version
terraform	>= 1.0
aws	>= 4.0

Providers

Name	Version
aws	>= 4.0

Modules

Name	Source	Version
s3_bucket	cloudposse/s3-log-storage/aws	1.4.2
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_elb_service_account.default	data source
aws_iam_policy_document.default	data source
aws_partition.current	data source

Inputs

Name	Description	Type	Default	Required
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`	`null`	no
acl	Canned ACL to apply to the S3 bucket	`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_ssl_requests_only	Require requests to use Secure Socket Layer (HTTPS/SSL).	`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
bucket_name	Bucket name. If provided, the bucket will be created with this name instead of generating the name from the context	`string`	`null`	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`	`true`	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`	`90`	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`	`60`	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
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 = any expiration = any transition = list(any) noncurrent_version_expiration = any noncurrent_version_transition = list(any) }))`	`[]`	no
lifecycle_prefix	(Deprecated, use `lifecycle_configuration_rules` instead) Prefix filter. Used to manage object lifecycle events	`string`	`""`	no
lifecycle_rule_enabled	DEPRECATED: Defaults to `false`, use `lifecycle_configuration_rules` instead. When `true`, configures lifecycle events on this bucket using individual (now deprecated) variables."	`bool`	`false`	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`	`90`	no
noncurrent_version_transition_days	(Deprecated, use `lifecycle_configuration_rules` instead) Specifies (in days) when noncurrent object versions transition to Glacier Flexible Retrieval	`number`	`30`	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
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`	`30`	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	S3 bucket ARN
bucket_domain_name	S3 bucket domain name
bucket_id	S3 bucket ID
bucket_prefix	S3 bucket prefix
enabled	Is module enabled

Module: lb-s3-bucket

Usage​

Requirements​

Providers​

Modules​

Resources​

Inputs​

Outputs​