Awesome

This component is responsible for provisioning information only: it simply populates Terraform state with data (account ids, groups, and roles) that other root modules need via outputs.

Pre-requisites

account must be provisioned before account-map component

Usage

Stack Level: Global

Here is an example snippet for how to use this component. Include this snippet in the stack configuration for the management account (typically root) in the management tenant/OU (usually something like mgmt or core) in the global region (gbl). You can include the content directly, or create a stacks/catalog/account-map.yaml file and import it from there.

components:
  terraform:
    account-map:
      vars:
        enabled: true
        # Set profiles_enabled to false unless we are using AWS config profiles for Terraform access.
        # When profiles_enabled is false, role_arn must be provided instead of profile in each terraform component provider.
        # This is automatically handled by the component's `provider.tf` file in conjunction with
        # the `account-map/modules/iam-roles` module.
        profiles_enabled: false
        root_account_aws_name: "aws-root"
        root_account_account_name: root
        identity_account_account_name: identity
        dns_account_account_name: dns
        audit_account_account_name: audit

        # The following variables contain `format()` strings that take the labels from `null-label`
        # as arguments in the standard order. The default values are shown here, assuming
        # the `null-label.label_order` is
        # ["namespace", "tenant", "environment", "stage", "name", "attributes"]
        # Note that you can rearrange the order of the labels in the template by
        # using [explicit argument indexes](https://pkg.go.dev/fmt#hdr-Explicit_argument_indexes) just like in `go`.

        #  `iam_role_arn_template_template` is the template for the template [sic] used to render Role ARNs.
        #  The template is first used to render a template for the account that takes only the role name.
        #  Then that rendered template is used to create the final Role ARN for the account.
        iam_role_arn_template_template: "arn:%s:iam::%s:role/%s-%s-%s-%s-%%s"
        # `profile_template` is the template used to render AWS Profile names.
        profile_template: "%s-%s-%s-%s-%s"

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.2.0
<a name="requirement_aws"></a> aws	>= 4.9.0
<a name="requirement_local"></a> local	>= 1.3
<a name="requirement_utils"></a> utils	>= 1.10.0

Providers

Name	Version
<a name="provider_aws"></a> aws	>= 4.9.0
<a name="provider_local"></a> local	>= 1.3
<a name="provider_utils"></a> utils	>= 1.10.0

Modules

Name	Source	Version
<a name="module_accounts"></a> accounts	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
<a name="module_atmos"></a> atmos	cloudposse/label/null	0.25.0
<a name="module_this"></a> this	cloudposse/label/null	0.25.0

Resources

Name	Type
local_file.account_info	resource
aws_organizations_organization.organization	data source
aws_partition.current	data source
utils_describe_stacks.team_roles	data source
utils_describe_stacks.teams	data source

Inputs

Name	Description	Type	Default	Required
<a name="input_additional_tag_map"></a> additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
<a name="input_artifacts_account_account_name"></a> artifacts_account_account_name	The short name for the artifacts account	`string`	`"artifacts"`	no
<a name="input_attributes"></a> attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the `delimiter`<br/>and treated as a single ID element.	`list(string)`	`[]`	no
<a name="input_audit_account_account_name"></a> audit_account_account_name	The short name for the audit account	`string`	`"audit"`	no
<a name="input_aws_config_identity_profile_name"></a> aws_config_identity_profile_name	The AWS config profile name to use as `source_profile` for credentials.	`string`	`null`	no
<a name="input_context"></a> context	Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as `null` to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.	`any`	<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>	no
<a name="input_delimiter"></a> delimiter	Delimiter to be used between ID elements.<br/>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
<a name="input_descriptor_formats"></a> descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>`{<br/> format = string<br/> labels = list(string)<br/>}`<br/>(Type is `any` so the map values can later be enhanced to provide additional options.)<br/>`format` is a Terraform format string to be passed to the `format()` function.<br/>`labels` is a list of labels, in order, to pass to `format()` function.<br/>Label values will be normalized before being passed to `format()` so they will be<br/>identical to how they appear in `id`.<br/>Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
<a name="input_dns_account_account_name"></a> dns_account_account_name	The short name for the primary DNS account	`string`	`"dns"`	no
<a name="input_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_environment"></a> environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
<a name="input_iam_role_arn_template_template"></a> iam_role_arn_template_template	The template for the template used to render Role ARNs.<br/>The template is first used to render a template for the account that takes only the role name.<br/>Then that rendered template is used to create the final Role ARN for the account.<br/>Default is appropriate when using `tenant` and default label order with `null-label`.<br/>Use `"arn:%s:iam::%s:role/%s-%s-%s-%%s"` when not using `tenant`.<br/><br/>Note that if the `null-label` variable `label_order` is truncated or extended with additional labels, this template will<br/>need to be updated to reflect the new number of labels.	`string`	`"arn:%s:iam::%s:role/%s-%s-%s-%s-%%s"`	no
<a name="input_id_length_limit"></a> id_length_limit	Limit `id` to this many characters (minimum 6).<br/>Set to `0` for unlimited length.<br/>Set to `null` for keep the existing setting, which defaults to `0`.<br/>Does not affect `id_full`.	`number`	`null`	no
<a name="input_identity_account_account_name"></a> identity_account_account_name	The short name for the account holding primary IAM roles	`string`	`"identity"`	no
<a name="input_label_key_case"></a> label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`.	`string`	`null`	no
<a name="input_label_order"></a> label_order	The order in which the labels (ID elements) appear in the `id`.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
<a name="input_label_value_case"></a> label_value_case	Controls the letter case of ID elements (labels) as included in `id`,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br/>Default value: `lower`.	`string`	`null`	no
<a name="input_labels_as_tags"></a> labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the `tags` output.<br/>Set to `[]` to suppress all generated tags.<br/>Notes:<br/> The value of the `name` tag, if included, will be the `id`, not the `name`.<br/> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	<pre>[<br/> "default"<br/>]</pre>	no
<a name="input_legacy_terraform_uses_admin"></a> legacy_terraform_uses_admin	If `true`, the legacy behavior of using the `admin` role rather than the `terraform` role in the<br/>`root` and identity accounts will be preserved.<br/>The default is to use the negations of the value of `terraform_dynamic_role_enabled`.	`bool`	`null`	no
<a name="input_name"></a> name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a `tag`.<br/>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
<a name="input_namespace"></a> 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
<a name="input_profile_template"></a> profile_template	The template used to render AWS Profile names.<br/>Default is appropriate when using `tenant` and default label order with `null-label`.<br/>Use `"%s-%s-%s-%s"` when not using `tenant`.<br/><br/>Note that if the `null-label` variable `label_order` is truncated or extended with additional labels, this template will<br/>need to be updated to reflect the new number of labels.	`string`	`"%s-%s-%s-%s-%s"`	no
<a name="input_profiles_enabled"></a> profiles_enabled	Whether or not to enable profiles instead of roles for the backend. If true, profile must be set. If false, role_arn must be set.	`bool`	`false`	no
<a name="input_regex_replace_chars"></a> regex_replace_chars	Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
<a name="input_region"></a> region	AWS Region	`string`	n/a	yes
<a name="input_root_account_account_name"></a> root_account_account_name	The short name for the root account	`string`	`"root"`	no
<a name="input_root_account_aws_name"></a> root_account_aws_name	The name of the root account as reported by AWS	`string`	n/a	yes
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_tags"></a> tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br/>Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
<a name="input_tenant"></a> tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
<a name="input_terraform_dynamic_role_enabled"></a> terraform_dynamic_role_enabled	If true, the IAM role Terraform will assume will depend on the identity of the user running terraform	`bool`	`false`	no
<a name="input_terraform_role_name_map"></a> terraform_role_name_map	Mapping of Terraform action (plan or apply) to aws-team-role name to assume for that action	`map(string)`	<pre>{<br/> "apply": "terraform",<br/> "plan": "planner"<br/>}</pre>	no

Outputs

Name	Description
<a name="output_account_info_map"></a> account_info_map	A map from account name to various information about the account.<br/>See the `account_info_map` output of `account` for more detail.
<a name="output_all_accounts"></a> all_accounts	A list of all accounts in the AWS Organization
<a name="output_artifacts_account_account_name"></a> artifacts_account_account_name	The short name for the artifacts account
<a name="output_audit_account_account_name"></a> audit_account_account_name	The short name for the audit account
<a name="output_aws_partition"></a> aws_partition	The AWS "partition" to use when constructing resource ARNs
<a name="output_cicd_profiles"></a> cicd_profiles	OBSOLETE: dummy results returned to avoid breaking code that depends on this output
<a name="output_cicd_roles"></a> cicd_roles	OBSOLETE: dummy results returned to avoid breaking code that depends on this output
<a name="output_dns_account_account_name"></a> dns_account_account_name	The short name for the primary DNS account
<a name="output_eks_accounts"></a> eks_accounts	A list of all accounts in the AWS Organization that contain EKS clusters
<a name="output_full_account_map"></a> full_account_map	The map of account name to account ID (number).
<a name="output_helm_profiles"></a> helm_profiles	OBSOLETE: dummy results returned to avoid breaking code that depends on this output
<a name="output_helm_roles"></a> helm_roles	OBSOLETE: dummy results returned to avoid breaking code that depends on this output
<a name="output_iam_role_arn_templates"></a> iam_role_arn_templates	Map of accounts to corresponding IAM Role ARN templates
<a name="output_identity_account_account_name"></a> identity_account_account_name	The short name for the account holding primary IAM roles
<a name="output_non_eks_accounts"></a> non_eks_accounts	A list of all accounts in the AWS Organization that do not contain EKS clusters
<a name="output_org"></a> org	The name of the AWS Organization
<a name="output_profiles_enabled"></a> profiles_enabled	Whether or not to enable profiles instead of roles for the backend
<a name="output_root_account_account_name"></a> root_account_account_name	The short name for the root account
<a name="output_root_account_aws_name"></a> root_account_aws_name	The name of the root account as reported by AWS
<a name="output_terraform_access_map"></a> terraform_access_map	Mapping of team Role ARN to map of account name to terraform action role ARN to assume<br/><br/>For each team in `aws-teams`, look at every account and see if that team has access to the designated "apply" role.<br/> If so, add an entry `<account-name> = "apply"` to the `terraform_access_map` entry for that team.<br/> If not, see if it has access to the "plan" role, and if so, add a "plan" entry.<br/> Otherwise, no entry is added.
<a name="output_terraform_dynamic_role_enabled"></a> terraform_dynamic_role_enabled	True if dynamic role for Terraform is enabled
<a name="output_terraform_profiles"></a> terraform_profiles	A list of all SSO profiles used to run terraform updates
<a name="output_terraform_role_name_map"></a> terraform_role_name_map	Mapping of Terraform action (plan or apply) to aws-team-role name to assume for that action
<a name="output_terraform_roles"></a> terraform_roles	A list of all IAM roles used to run terraform updates

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

[!TIP]

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. Works with Github Actions, Atlantis, or Spacelift.
<details> <summary>Watch demo of using Atmos with Terraform</summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/> Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial. </detalis>

Related Projects

Check out these related projects.

Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
Atmos - Atmos is like docker-compose but for your infrastructure

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team. ✅ Your team owns everything. ✅ 100% Open Source and backed by fanatical support. 

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-account-map&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
<details><summary>📚 Learn More</summary> 
Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.

Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.

Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.

Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.

GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-account-map&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.

Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.

Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.

Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.

Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.

Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.

Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-account-map&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-account-map&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.