Submodule `iam-roles`

This submodule is used by other modules to determine which IAM Roles or AWS CLI Config Profiles to use for various tasks, most commonly for applying Terraform plans.

Special Configuration Needed

In order to avoid having to pass customization information through every module that uses this submodule, if the default configuration does not suit your needs, you are expected to add variables_override.tf to override the variables with the defaults you want to use in your project. For example, if you are not using "core" as the tenant portion of your "root" account (your Organization Management Account), then you should include the variable "overridable_global_tenant_name" declaration in your variables_override.tf so that overridable_global_tenant_name defaults to the value you are using (or the empty string if you are not using tenant at all).

Variables

Required Variables

Optional Variables

overridable_global_environment_name (string) optional

Global environment name

Default value: "gbl"

overridable_global_stage_name (string) optional

The stage name for the organization management account (where the account-map state is stored)

Default value: "root"

overridable_global_tenant_name (string) optional

The tenant name used for organization-wide resources

Default value: "core"

privileged (bool) optional

True if the Terraform user already has access to the backend

Default value: false

profiles_enabled (bool) optional

Whether or not to use profiles instead of roles for Terraform. Default (null) means to use global settings.

Default value: null

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

audit_terraform_profile_name: The AWS config profile name for Terraform to use to provision resources in the "audit" role account, when profiles are in use
audit_terraform_role_arn: The AWS Role ARN for Terraform to use to provision resources in the "audit" role account, when Role ARNs are in use
aws_partition: The AWS "partition" to use when constructing resource ARNs
current_account_account_name: The account name (usually <tenant>-<stage>) for the account configured by this module's inputs.
Roughly analogous to data "aws_caller_identity", but returning the name of the caller account as used in our configuration.
dns_terraform_profile_name: The AWS config profile name for Terraform to use to provision DNS Zone delegations, when profiles are in use
dns_terraform_role_arn: The AWS Role ARN for Terraform to use to provision DNS Zone delegations, when Role ARNs are in use
global_environment_name: The null-label environment value used for regionless (global) resources
global_stage_name: The null-label stage value for the organization management account (where the account-map state is stored)
global_tenant_name: The null-label tenant value used for organization-wide resources
identity_account_account_name: The account name (usually <tenant>-<stage>) for the account holding primary IAM roles
identity_terraform_profile_name: The AWS config profile name for Terraform to use to provision resources in the "identity" role account, when profiles are in use
identity_terraform_role_arn: The AWS Role ARN for Terraform to use to provision resources in the "identity" role account, when Role ARNs are in use
org_role_arn: The AWS Role ARN for Terraform to use when SuperAdmin is provisioning resources in the account
profiles_enabled: When true, use AWS config profiles in Terraform AWS provider configurations. When false, use Role ARNs.
terraform_profile_name: The AWS config profile name for Terraform to use when provisioning resources in the account, when profiles are in use
terraform_role_arn: The AWS Role ARN for Terraform to use when provisioning resources in the account, when Role ARNs are in use
terraform_role_arns: All of the terraform role arns

Dependencies

Requirements

terraform, version: >= 1.2.0
awsutils, version: >= 0.16.0

Providers

awsutils, version: >= 0.16.0

Modules

Name	Version	Source	Description
`account_map`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`always`	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:

Data Sources

The following data sources are used by this module:

awsutils_caller_identity.current (data source)

None

Submodule iam-roles

Special Configuration Needed​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Submodule `iam-roles`

Special Configuration Needed

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources