utils
cloudposse/utils/aws
Utility functions for use with Terraform in the AWS environment
terraform-aws-utils    This terraform-aws-utils module provides some simple utilities to use when working in AWS. --- > [!NOTE] > This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps. > > > It's 100% Open Source and licensed under the APACHE2. > > We literally have [hundreds of terraform modules][terraform_modules] that are Open Source and well-maintained. Check them out! [![README Header][readme_header_img]][readme_header_link] Introduction This terraform-aws-utils module provides some simple utilities to use when working in AWS. More complex utilities are available through Cloud P
| Name | Type | Description | Default |
|---|---|---|---|
| name | string | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. Thi | null |
| additional_tag_map | map(string) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not add | {} |
| id_length_limit | number | Limit `id` to this many characters (minimum 6). Set to `0` for unlimited length. | null |
| label_value_case | string | Controls the letter case of ID elements (labels) as included in `id`, set as tag | null |
| tenant | string | ID element _(Rarely used, not included by default)_. A customer identifier, indi | null |
| environment | string | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'st | null |
| regex_replace_chars | string | Terraform regular expression (regex) string. Characters matching the regex will | null |
| elb_logging_region | string | Full region (e.g. `us-east-1`) where ELB logging is taking place. Required to ge | "" |
| context | any | Single object for setting entire context at once. See description of individual | {
"additional_tag_map": {},
"attribu |
| namespace | string | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp' | null |
| attributes | list(string) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, | [] |
| labels_as_tags | set(string) | Set of labels (ID elements) to include as tags in the `tags` output. Default is | [
"default"
] |
| tags | map(string) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the t | {} |
| label_order | list(string) | The order in which the labels (ID elements) appear in the `id`. Defaults to ["na | null |
| label_key_case | string | Controls the letter case of the `tags` keys (label names) for tags generated by | null |
| descriptor_formats | any | Describe additional descriptors to be output in the `descriptors` output map. Ma | {} |
| enabled | bool | Set to false to prevent the module from creating any resources | null |
| delimiter | string | Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` | null |
| stage | string | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'bu | null |
| elb_logging_bucket_resource_arn | string | The AWS Resource ARN to use in the policy granting access to Load Balancer Loggi | "" |
region_az_alt_code_maps — Collection of maps converting between official AWS Region, Availability Zone, and Local Zone codes aregion_display_name_map — Map of full region names to user-friendly display names (e.g. "eu-west-3" = "Europe (Paris)").
elb_logging_account — Map of full region to ELB logging accountelb_logging_s3_bucket_policy_json — The S3 bucket policy (in JSON) to attach to the S3 bucket to allow Load Balancer logs to be added.
Renabled_regions — A list of regions that are enabled in the accountdisabled_regions — A list of regions that are disabled in the accountall_regions — A list of all regions regardless of availability to the account