This component is responsible for provisioning the full account hierarchy along with Organizational Units (OUs). It includes the ability to associate Service Control Policies (SCPs) to the Organization, each Organizational Unit and account.
Part of a cold start so it has to be initially run with
In addition, it enables AWS IAM Access Analyzer, which helps you identify the resources in your organization and accounts, such as Amazon S3 buckets or IAM roles, that are shared with an external entity. This lets you identify unintended access to your resources and data, which is a security risk. Access Analyzer identifies resources that are shared with external principals by using logic-based reasoning to analyze the resource-based policies in your AWS environment. For each instance of a resource that is shared outside of your account, Access Analyzer generates a finding. Findings include information about the access and the external principal that it is granted to. You can review findings to determine whether the access is intended and safe, or the access is unintended and a security risk.
Stack Level: Global
IMPORTANT: Account Name building blocks (such as tenant, stage, environment) must not contain dashes. Doing so will lead to unpredictable resource names as a
- is the default delimiter. Additionally, account names must be lower case alpha-numeric with no special characters.
Here is an example snippet for how to use this component. Include this snippet in the stack configuration for the management account
root) in the management tenant/OU (usually something like
core) in the global region (
gbl). You can insert
the content directly, or create a
stacks/catalog/account.yaml file and import it from there.
account_email_format: aws+%[email protected]
- name: core
- name: core-artifacts
- name: core-audit
- name: core-auto
- name: core-corp
- name: core-dns
- name: core-identity
- name: core-network
- name: core-security
- name: plat
- name: plat-dev
- name: plat-sandbox
- name: plat-staging
- name: plat-prod
# These paths specify where to find the service control policies identified by SID in the service_control_policies sections above.
First Time Organization Setup
Your AWS Organization is managed by the
account component, along with accounts and organizational units.
However, because the AWS defaults for an Organization and its accounts are not exactly what we want, and there is no way to change them via Terraform, we have to first provision the AWS Organization, then take some steps on the AWS console, and then we can provision the rest.
Use AWS Console to create and set up the Organization
Unfortunately, there are some tasks that need to be done via the console. Log into the AWS Console with the root (not SuperAdmin) credentials you have saved in 1Password.
Request an increase in the maximum number of accounts allowed
Make sure your support plan for the root account was upgraded to the "Business" level (or Higher). This is necessary to expedite the quota increase requests, which could take several days on a basic support plan. Without it, AWS support will claim that since we’re not currently utilizing any of the resources, so they do not want to approve the requests. AWS support is not aware of your other organization. If AWS still gives you problems, please escalate to your AWS TAM. See AWS.
From the region list, select "US East (N. Virginia) us-east-1".
From the account dropdown menu, select "My Service Quotas".
From the Sidebar, select "AWS Services".
Type "org" in the search field under "AWS services"
Click on "AWS Organizations" in the "Service" list
Click on "Default maximum number of accounts", which should take you to a new view
Click on "Request quota increase" on the right side of the view, which should pop us a request form
At the bottom of the form, under "Change quota value", enter the number you decided on in the previous step (probably "20") and click "Request"
(Optional) Create templates to request other quota increases
New accounts start with a low limit on the number of instances you can create. However, as you add accounts, and use more instances, the numbers automatically adjust up. So you may or may not want to create a template to generate automatic quota increase requests, depending on how many instances per account you expect to want to provision right away.
Create a Quota request template for the organization. From the Sidebar, click "Quota request template"
Add each EC2 quota increase request you want to make:
Click "Add Quota" on the right side of the view
Under "Region", select your default region (repeat with the backup region if you are using one)
Under "Service", type "EC2" and select "Amazon Elastic Compute Cloud (Amazon EC2)"
Under "Quota", find the quota you want to increase. The likely candidates are:
type "stand" and select "Running On-Demand Standard (A, C, D, H, I, M, R, T, Z) Instances"
type "stand" and select "All Standard (A, C, D, H, I, M, R, T, Z) Spot Instance Request"
type "g i" and select "Running On-Demand G Instances"
type "all g" and select "All G Spot Instance Requests"
Under "Desired quota value" enter your desired default quota
After you have added all the templates, click "Enable" on the Quota request template screen to enable the templates.
Enable resource sharing with AWS Organization
AWS Resource Access Manager (RAM) lets you share your resources with any AWS account or through AWS Organizations.
If you have multiple AWS accounts, you can create resources centrally and use AWS RAM to share those resources with other accounts.
Resource sharing through AWS Organization will be used to share the Transit Gateway deployed in the
network account with other accounts to connect their VPCs to the shared Transit Gateway.
This is a one-time manual step in the AWS Resource Access Manager console. When you share resources within your organization, AWS RAM does not send invitations to principals. Principals in your organization get access to shared resources without exchanging invitations.
To enable resource sharing with AWS Organization via AWS Management Console
Open the Settings page of AWS Resource Access Manager console at https://console.aws.amazon.com/ram/home#Settings
Choose "Enable sharing with AWS Organizations"
To enable resource sharing with AWS Organization via AWS CLI
√ . [xamp-SuperAdmin] (HOST) infra ⨠ aws ram enable-sharing-with-aws-organization
For more information, see:
Import the organization into Terraform using the
After we are done with the above ClickOps and the Service Quota Increase for maximum number of accounts has been granted, we can then do the rest via Terraform.
In the Geodesic shell, as SuperAdmin, execute the following command to get the AWS Organization ID that will be used to import the organization:
aws organizations describe-organization
From the output, identify the organization-id:
Using the example above, the organization-id is o-7qcakq6zxw.
In the Geodesic shell, as SuperAdmin, execute the following command to import the AWS Organization, changing the stack name
core-gbl-root if needed, to reflect the stack where the organization management account is defined, and changing the last argument to reflect the organization-id from the output of the previous command.
atmos terraform import account --stack core-gbl-root 'aws_organizations_organization.this' 'o-7qcakq6zxw'
Provision AWS OUs and Accounts using the
AWS accounts and organizational units are generated dynamically by the
terraform/account component using the configuration in the
Special note: **** In the rare case where you will need to be enabling non-default AWS Regions, temporarily comment out the
DenyRootAccountAccess service control policy setting in
gbl-root.yaml. You will restore it later, after enabling the optional Regions.
See related: Decide on Opting Into Non-default Regions
You must wait until your quota increase request has been granted. If you try to create the accounts before the quota increase is granted, you can expect to see failures like
In the Geodesic shell, execute the following commands to provision AWS Organizational Units and AWS accounts:
atmos terraform apply account --stack gbl-root
Review the Terraform plan, ensure that no new organization will be created (look for
aws_organizations_organization.this), type "yes" to approve and apply. This creates the AWS organizational units and AWS accounts.
Configure root account credentials for each account
Note: unless you need to enable non-default AWS regions (see next step), this step can be done later or in parallel with other steps, for example while waiting for Terraform to create resources.
For each new account:
Perform a password reset by attempting to log in to the AWS console as a "root user", using that account's email address, and then clicking the "Forgot password?" link. You will receive a password reset link via email, which should be forwarded to the shared Slack channel for automated messages. Click the link and enter a new password. (Use 1Password or Random.org to create a password 26-38 characters long, including at least 3 of each class of character: lower case, uppercase, digit, and symbol. You may need to manually combine or add to the generated password to ensure 3 symbols and digits are present.) Save the email address and generated password as web login credentials in 1Password. While you are at it, save the account number in a separate field.
Log in using the new password, choose "My Security Credentials" from the account dropdown menu and set up Multi-Factor Authentication (MFA) to use a Virutal MFA device. Save the MFA TOTP key in 1Password by using 1Password's TOTP field and built-in screen scanner. Also, save the Virutal MFA ARN (sometimes shown as "serial number").
While logged in, enable optional regions as described in the next step, if needed.
(Optional, but highly recommended): Unsubscribe the account's email address from all marketing emails.
(Optional) Enable regions
Most AWS regions are enabled by default. If you are using a region that is not enabled by default (such as Middle East/Bahrain), you need to take extra steps.
While logged in using root credentials (see the previous step), in the account dropdown menu, select "My Account" to get to the Billing home page.
In the "AWS Regions" section, enable the regions you want to enable.
Go to the IAM account settings page and edit the STS Global endpoint to create session tokens valid in all AWS regions.
You will need to wait a few minutes for the regions to be enabled before you can proceed to the next step. Until they are enabled, you may get what look like AWS authentication or permissions errors.
After enabling the regions in all accounts, re-enable the
DenyRootAccountAccess service control policy setting in
gbl-root.yaml and rerun
atmos terraform apply account --stack gbl-root
|account_email_format||Email address format for the accounts (e.g. ||n/a||yes|
|account_iam_user_access_to_billing||If set to ||no|
|additional_tag_map||Additional key-value pairs to add to each map in |
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.
|attributes||ID element. Additional attributes (e.g. |
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
and treated as a single ID element.
|aws_service_access_principals||List of AWS service principal names for which you want to enable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com. Organization must have ||n/a||yes|
|context||Single object for setting entire context at once.|
See description of individual variables for details.
Leave string and numeric variables as
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
|delimiter||Delimiter to be used between ID elements.|
|descriptor_formats||Describe additional descriptors to be output in the |
Map of maps. Keys are names of descriptors. Values are maps of the form
Label values will be normalized before being passed to
identical to how they appear in
|enabled||Set to false to prevent the module from creating any resources||no|
|enabled_policy_types||List of Organizations policy types to enable in the Organization Root. Organization must have feature_set set to ALL. For additional information about valid policy types (e.g. SERVICE_CONTROL_POLICY and TAG_POLICY), see the AWS Organizations API Reference||n/a||yes|
|environment||ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'||no|
Does not affect
|label_key_case||Controls the letter case of the |
Does not affect keys of tags passed in via the
|label_order||The order in which the labels (ID elements) appear in the |
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.
|label_value_case||Controls the letter case of ID elements (labels) as included in |
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the
Set this to
|labels_as_tags||Set of labels (ID elements) to include as tags in the |
Default is to include all labels.
Tags with empty values will not be included in the
The value of the
changed in later chained modules. Attempts to change it will be silently ignored.
|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
The "name" tag is set to the full
|namespace||ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique||no|
|organization_config||Organization, Organizational Units and Accounts configuration||n/a||yes|
|organization_enabled||A boolean flag indicating whether to create an Organization or use the existing one||no|
|regex_replace_chars||Terraform regular expression (regex) string.|
Characters matching the regex will be removed from the ID elements.
If not set,
|service_control_policies_config_paths||List of paths to Service Control Policy configurations||n/a||yes|
|stage||ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'||no|
|tags||Additional tags (e.g. |
Neither the tag keys nor the tag values will be modified by this module.
|tenant||ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for||no|
|account_arns||List of account ARNs (excluding root account)|
|account_ids||List of account IDs (excluding root account)|
|account_info_map||Map of account names to|
eks: boolean, account hosts at least one EKS cluster
id: account id (number)
stage: (optional) the account "stage"
tenant: (optional) the account "tenant"
|account_names_account_arns||Map of account names to account ARNs (excluding root account)|
|account_names_account_ids||Map of account names to account IDs (excluding root account)|
|account_names_account_scp_arns||Map of account names to SCP ARNs for accounts with SCPs|
|account_names_account_scp_ids||Map of account names to SCP IDs for accounts with SCPs|
|eks_accounts||List of EKS accounts|
|non_eks_accounts||List of non EKS accounts|
|organization_master_account_arn||Organization master account ARN|
|organization_master_account_email||Organization master account email|
|organization_master_account_id||Organization master account ID|
|organization_scp_arn||Organization Service Control Policy ARN|
|organization_scp_id||Organization Service Control Policy ID|
|organizational_unit_arns||List of Organizational Unit ARNs|
|organizational_unit_ids||List of Organizational Unit IDs|
|organizational_unit_names_organizational_unit_arns||Map of Organizational Unit names to Organizational Unit ARNs|
|organizational_unit_names_organizational_unit_ids||Map of Organizational Unit names to Organizational Unit IDs|
|organizational_unit_names_organizational_unit_scp_arns||Map of OU names to SCP ARNs|
|organizational_unit_names_organizational_unit_scp_ids||Map of OU names to SCP IDs|
- cloudposse/terraform-aws-components - Cloud Posse's upstream component