AWS Control Tower Account Factory for Terraform (AFT) follows a GitOps model to automate the processes of account provisioning and account updating in AWS Control Tower. You'll create an account request Terraform file, which provides the necessary input that triggers the AFT workflow for account provisioning.
For more information on AFT, see Overview of AWS Control Tower Account Factory for Terraform
This guide is intended for administrators of AWS Control Tower environments who wish to set up Account Factory for Terraform (AFT) in their environment. It describes how to set up an Account Factory for Terraform (AFT) environment with a new, dedicated AFT management account. This guide follows the deployment steps outlined in Deploy AWS Control Tower Account Factory for Terraform (AFT)
Five steps are required to configure and launch your AFT environment.
Step 1: Launch your AWS Control Tower landing zone
Before launching AFT, you must have a working AWS Control Tower landing zone in your AWS account. You will configure and launch AFT from the AWS Control Tower management account.
Step 2: Create a new organizational unit for AFT (recommended)
We recommend that you create a separate OU in your AWS Organization, where you will deploy the AFT management account. Create an OU through your AWS Control Tower management account. For instructions on how to create an OU, refer to Create an organization in the AWS Organizations User Guide.
Step 3: Provision the AFT management account
AFT requires a separate AWS account to manage and orchestrate its own requests. From the AWS Control Tower management account that's associated with your AWS Control Tower landing zone, you'll provision this account for AFT.
To provision the AFT management account, see Provisioning Account Factory Accounts With AWS Service Catalog. When specifying an OU, be sure to select the OU you created in Step 2. When specifying a name, use "AFT-Management".
Note: It can take up to 30 minutes for the account to be fully provisioned. Validate that you have access to the AFT management account.
Step 4: Ensure that the Terraform environment is available for deployment
This step assumes that you are experienced with Terraform, and that you have procedures in place for executing Terraform. AFT supports Terraform Version 0.15.x or later.
Step 5: Call the Account Factory for Terraform module to deploy AFT
The Account Factory for Terraform module must be called while you are authenticated with AdministratorAccess credentials in your AWS Control Tower management account.
AWS Control Tower, through the AWS Control Tower management account, vends a Terraform module that establishes all infrastructure necessary to orchestrate your AWS Control Tower account factory requests. You can view that module in the AFT repository.
Refer to the module’s README file for information about the input required to run the module and deploy AFT.
If you have established pipelines for managing Terraform in your environment, you can integrate this module into your existing workflow. Otherwise, run the module from any environment that is authenticated with the required credentials.
Note: The AFT Terraform module does not manage a backend Terraform state. Be sure to preserve the Terraform state file that’s generated, after applying the module, or set up a Terraform backend using Amazon S3 and DynamoDB.
Certain input variables may contain sensitive values, such as a private ssh key or Terraform token. These values may be viewable as plain text in Terraform state file, depending on your deployment method. It is your responsibility to protect the Terraform state file, which may contain sensitive data. See the Terraform documentation
for more information.
Note: Deploying AFT through the Terraform module requires several minutes. Initial deployment may require up to 30 minutes. As a best practice, use AWS Security Token Service (STS) credentials and ensure that the credentials have a timeout sufficient for a full deployment, because a timeout causes the deployment to fail. The minimum timeout for AWS STS credentials is 60 minutes or more. Alternatively, you can leverage any IAM user that has AdministratorAccess permissions in the AWS Control Tower management account.
Now that you have configured and deployed AWS Control Tower Account Factory for Terraform, follow the steps outlined in Post-deployment steps and Provision accounts with AWS Control Tower Account Factory for Terraform to begin using your environment.
As of version 1.6.0, AFT collects anonymous operational metrics to help AWS improve the quality and features of the solution. For more information, including how to disable this capability, please see the documentation here.
| Name | Version |
|---|---|
| terraform | >= 1.2.0, < 2.0.0 |
| aws | >= 5.11.0, < 6.0.0 |
| Name | Version |
|---|---|
| aws | >= 5.11.0, < 6.0.0 |
| local | n/a |
| Name | Source | Version |
|---|---|---|
| aft_account_provisioning_framework | ./modules/aft-account-provisioning-framework | n/a |
| aft_account_request_framework | ./modules/aft-account-request-framework | n/a |
| aft_backend | ./modules/aft-backend | n/a |
| aft_code_repositories | ./modules/aft-code-repositories | n/a |
| aft_customizations | ./modules/aft-customizations | n/a |
| aft_feature_options | ./modules/aft-feature-options | n/a |
| aft_iam_roles | ./modules/aft-iam-roles | n/a |
| aft_lambda_layer | ./modules/aft-lambda-layer | n/a |
| aft_ssm_parameters | ./modules/aft-ssm-parameters | n/a |
| packaging | ./modules/aft-archives | n/a |
| Name | Type |
|---|---|
| aws_partition.current | data source |
| aws_service.home_region_validation | data source |
| aws_ssm_parameters_by_path.servicecatalog_regional_data | data source |
| local_file.python_version | data source |
| local_file.version | data source |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| account_customizations_repo_branch | Branch to source account customizations repo from | string |
"main" |
no |
| account_customizations_repo_name | Repository name for the account customizations files. For non-CodeCommit repos, name should be in the format of Org/Repo | string |
"aft-account-customizations" |
no |
| account_provisioning_customizations_repo_branch | Branch to source account provisioning customization files | string |
"main" |
no |
| account_provisioning_customizations_repo_name | Repository name for the account provisioning customizations files. For non-CodeCommit repos, name should be in the format of Org/Repo | string |
"aft-account-provisioning-customizations" |
no |
| account_request_repo_branch | Branch to source account request repo from | string |
"main" |
no |
| account_request_repo_name | Repository name for the account request files. For non-CodeCommit repos, name should be in the format of Org/Repo | string |
"aft-account-request" |
no |
| aft_backend_bucket_access_logs_object_expiration_days | Amount of days to keep the objects stored in the access logs bucket for AFT backend buckets | number |
365 |
no |
| aft_enable_vpc | Flag turning use of VPC on/off for AFT | bool |
true |
no |
| aft_feature_cloudtrail_data_events | Feature flag toggling CloudTrail data events on/off | bool |
false |
no |
| aft_feature_delete_default_vpcs_enabled | Feature flag toggling deletion of default VPCs on/off | bool |
false |
no |
| aft_feature_enterprise_support | Feature flag toggling Enterprise Support enrollment on/off | bool |
false |
no |
| aft_framework_repo_git_ref | Git branch from which the AFT framework should be sourced from | string |
null |
no |
| aft_framework_repo_url | Git repo URL where the AFT framework should be sourced from | string |
"https://github.com/aws-ia/terraform-aws-control_tower_account_factory.git" |
no |
| aft_management_account_id | AFT Management Account ID | string |
n/a | yes |
| aft_metrics_reporting | Flag toggling reporting of operational metrics | bool |
true |
no |
| aft_vpc_cidr | CIDR Block to allocate to the AFT VPC | string |
"192.168.0.0/22" |
no |
| aft_vpc_endpoints | Flag turning VPC endpoints on/off for AFT VPC | bool |
true |
no |
| aft_vpc_private_subnet_01_cidr | CIDR Block to allocate to the Private Subnet 01 | string |
"192.168.0.0/24" |
no |
| aft_vpc_private_subnet_02_cidr | CIDR Block to allocate to the Private Subnet 02 | string |
"192.168.1.0/24" |
no |
| aft_vpc_public_subnet_01_cidr | CIDR Block to allocate to the Public Subnet 01 | string |
"192.168.2.0/25" |
no |
| aft_vpc_public_subnet_02_cidr | CIDR Block to allocate to the Public Subnet 02 | string |
"192.168.2.128/25" |
no |
| audit_account_id | Audit Account Id | string |
n/a | yes |
| backup_recovery_point_retention | Number of days to keep backup recovery points in AFT DynamoDB tables. Default = Never Expire | number |
null |
no |
| cloudwatch_log_group_retention | Amount of days to keep CloudWatch Log Groups for Lambda functions. 0 = Never Expire | string |
"0" |
no |
| concurrent_account_factory_actions | Maximum number of accounts that can be provisioned in parallel. | number |
5 |
no |
| ct_home_region | The region from which this module will be executed. This MUST be the same region as Control Tower is deployed. | string |
n/a | yes |
| ct_management_account_id | Control Tower Management Account Id | string |
n/a | yes |
| github_enterprise_url | GitHub enterprise URL, if GitHub Enterprise is being used | string |
"null" |
no |
| global_codebuild_timeout | Codebuild build timeout | number |
60 |
no |
| global_customizations_repo_branch | Branch to source global customizations repo from | string |
"main" |
no |
| global_customizations_repo_name | Repository name for the global customization files. For non-CodeCommit repos, name should be in the format of Org/Repo | string |
"aft-global-customizations" |
no |
| log_archive_account_id | Log Archive Account Id | string |
n/a | yes |
| log_archive_bucket_object_expiration_days | Amount of days to keep the objects stored in the AFT logging bucket | number |
365 |
no |
| maximum_concurrent_customizations | Maximum number of customizations/pipelines to run at once | number |
5 |
no |
| terraform_api_endpoint | API Endpoint for Terraform. Must be in the format of https://xxx.xxx. | string |
"https://app.terraform.io/api/v2/" |
no |
| terraform_distribution | Terraform distribution being used for AFT - valid values are oss, tfc, or tfe | string |
"oss" |
no |
| terraform_org_name | Organization name for Terraform Cloud or Enterprise | string |
"null" |
no |
| terraform_token | Terraform token for Cloud or Enterprise | string |
"null" |
no |
| terraform_version | Terraform version being used for AFT | string |
"1.6.0" |
no |
| tf_backend_secondary_region | AFT creates a backend for state tracking for its own state as well as OSS cases. The backend's primary region is the same as the AFT region, but this defines the secondary region to replicate to. | string |
"" |
no |
| vcs_provider | Customer VCS Provider - valid inputs are codecommit, bitbucket, github, or githubenterprise | string |
"codecommit" |
no |