Skip to content

cloudposse-terraform-components/aws-account

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

73 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Project Banner

Latest ReleaseSlack CommunityGet Support

This component is responsible for creating or importing a single AWS Account within an AWS Organization.

Unlike the monolithic account component which manages the entire organization hierarchy, this component follows the single-resource pattern - it only manages a single AWS account.

Note

This component should be deployed from the management/root account as it creates accounts within AWS Organizations.

Key Features

  • Single-resource pattern: Manages exactly one AWS account per component instance
  • Conditional import blocks (OpenTofu/Terraform 1.7+): Easily import existing accounts into Terraform state
  • Independent lifecycle: Each account can be managed independently without affecting others
  • Simple configuration: Minimal variables required for account creation

Tip

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform
Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

Stack Level: Global (deployed in the management/root account)

This component creates or imports a single AWS account. For managing the entire organization hierarchy, see the companion components: aws-organization, aws-organizational-unit, aws-account-settings, and aws-scp.

Basic Usage

components:
  terraform:
    aws-account/core-analytics:
      metadata:
        component: aws-account
      vars:
        name: core-analytics
        account_email: "aws+myorg-core-analytics@example.com"
        parent_id: "ou-xxxx-xxxxxxxx"

Using Remote State for Parent ID

Reference the parent OU dynamically using Atmos remote state:

components:
  terraform:
    aws-account/core-analytics:
      metadata:
        component: aws-account
      vars:
        name: core-analytics
        account_email: "aws+myorg-core-analytics@example.com"
        parent_id: !terraform.output aws-organizational-unit/core organizational_unit_id

Importing an Existing Account

To import an existing AWS account into Terraform state:

components:
  terraform:
    aws-account/core-analytics:
      metadata:
        component: aws-account
      vars:
        name: core-analytics
        account_email: "aws+myorg-core-analytics@example.com"
        parent_id: "ou-xxxx-xxxxxxxx"
        import_account_id: "123456789012"

After the import succeeds, you can remove the import_account_id variable.

Using Catalog Defaults

Create a defaults file for consistent configuration:

# stacks/catalog/aws-account/defaults.yaml
components:
  terraform:
    aws-account/defaults:
      metadata:
        component: aws-account
        type: abstract
      vars:
        enabled: true
        iam_user_access_to_billing: DENY
        close_on_deletion: false

Then inherit from defaults:

# stacks/orgs/myorg/core/root/global-region.yaml
import:
  - catalog/aws-account/defaults

components:
  terraform:
    aws-account/core-analytics:
      metadata:
        component: aws-account
        inherits:
          - aws-account/defaults
      vars:
        name: core-analytics
        account_email: "aws+myorg-core-analytics@example.com"
        parent_id: !terraform.output aws-organizational-unit/core organizational_unit_id

Complete Example with Multiple Accounts

components:
  terraform:
    # Core OU Accounts
    aws-account/core-analytics:
      metadata:
        component: aws-account
        inherits:
          - aws-account/defaults
      vars:
        name: core-analytics
        account_email: "aws+myorg-core-analytics@example.com"
        parent_id: !terraform.output aws-organizational-unit/core organizational_unit_id
        import_account_id: "111111111111"

    aws-account/core-security:
      metadata:
        component: aws-account
        inherits:
          - aws-account/defaults
      vars:
        name: core-security
        account_email: "aws+myorg-core-security@example.com"
        parent_id: !terraform.output aws-organizational-unit/core organizational_unit_id
        import_account_id: "222222222222"

    # Platform OU Accounts
    aws-account/plat-dev:
      metadata:
        component: aws-account
        inherits:
          - aws-account/defaults
      vars:
        name: plat-dev
        account_email: "aws+myorg-plat-dev@example.com"
        parent_id: !terraform.output aws-organizational-unit/plat organizational_unit_id
        import_account_id: "333333333333"

    aws-account/plat-prod:
      metadata:
        component: aws-account
        inherits:
          - aws-account/defaults
      vars:
        name: plat-prod
        account_email: "aws+myorg-plat-prod@example.com"
        parent_id: !terraform.output aws-organizational-unit/plat organizational_unit_id
        import_account_id: "444444444444"

Related Components

This component is part of a suite of single-resource components for AWS Organizations:

Component Purpose
aws-organization Creates/imports the AWS Organization
aws-organizational-unit Creates/imports a single Organizational Unit
aws-account Creates/imports a single AWS Account (this component)
aws-account-settings Configures account settings (IAM alias, S3 block, EBS encryption)
aws-scp Creates/imports Service Control Policies

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Requirements

Name Version
terraform >= 1.7.0
aws >= 4.9.0, < 6.0.0

Providers

Name Version
aws >= 4.9.0, < 6.0.0

Modules

Name Source Version
this cloudposse/label/null 0.25.0

Resources

Name Type
aws_organizations_account.this resource

Inputs

Name Description Type Default Required
account_email The email address for the AWS account string n/a yes
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
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
close_on_deletion Whether to close the account on deletion bool false 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
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
iam_user_access_to_billing Whether IAM users can access billing. ALLOW or DENY string "DENY" 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
import_account_id The AWS account ID to import. Set this to import an existing account into Terraform state. string 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
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
parent_id The ID of the parent Organizational Unit or organization root string n/a yes
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
region AWS Region string n/a yes
role_name The name of the IAM role that Organizations creates in the new member account string null no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null 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

Outputs

Name Description
account_arn The ARN of the AWS account
account_email The email of the AWS account
account_id The ID of the AWS account
account_name The name of the AWS account
parent_id The parent ID of the account

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

References

For additional context, refer to some of these links.

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.

Request Quote

πŸ“š Learn More

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.

Request Quote

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.

Request Quote

✨ 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.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. 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!

Running Terraform Tests

We use Atmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in the test/ folder.

Under the hood, tests are powered by Terratest together with our internal Test Helpers library, providing robust infrastructure validation.

Setup dependencies:

To run tests:

  • Run all tests:
    atmos test run
  • Clean up test artifacts:
    atmos test clean
  • Explore additional test options:
    atmos test --help

The configuration for test commands is centrally managed. To review what's being imported, see the atmos.yaml file.

Learn more about our automated testing in our documentation or implementing custom commands with atmos.

🌎 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

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

License

Preamble to the Apache License, Version 2.0

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.

Trademarks

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


Copyright Β© 2017-2026 Cloud Posse, LLC

README footer

Beacon

About

This component is responsible for provisioning the full account hierarchy along with Organizational Units (OUs)

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors