This repo contains a Terraform module that is part of the tooling to provision a project team's accounts within an AWS Landing Zone.
This module is used in conjunction with other modules that provide other "layers" to project accounts within a landing zone. The modules are orchestrated using a terragrunt
configuration that is contained in a private repository.
- Development
- Production/Maintenance
Note: This module is intended to be used by another "root" module, or as part of a terragrunt
"stack" rather than on its own. It doesn't do much on its own.
Name | Version |
---|---|
aws | ~> 4.0 |
No providers.
Name | Source | Version |
---|---|---|
project_workspace | github.com/BCDevOps/terraform-aws-sea-account-set.git | v0.3 |
No resources.
Name | Description | Type | Default | Required |
---|---|---|---|---|
account_email_domain | Email domain to use when creating generated account email addresses. | string |
"cloud.gov.bc.ca" |
no |
account_email_prefix | Prefix to use when creating generated account email addresses. | string |
n/a | yes |
automation_role_name | The name role to be assumed in the master account in order to allow creation of accounts within the organization. | string |
n/a | yes |
close_on_deletion | true means that the account will be closed when it is deleted. false means that the account be removed from the aws org when it is deleted. | bool |
false |
no |
master_account_id | Master Account Id | string |
n/a | yes |
org_admin_role_name | The role name that will be created/set as the default cross-account admin role for accounts within an organization. | string |
"OrganizationAccountAccessRole" |
no |
project_definition_file_path | Full path to JSON file containing project definition structure. (project.json by convention) | string |
"project.json" |
no |
Name | Description |
---|---|
project_account_ids | n/a |
project_accounts | n/a |
To report bugs/issues/feature requests, please file an issue.
If you would like to contribute, please see our CONTRIBUTING guidelines.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Copyright 2018 Province of British Columbia
Licensed 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
http://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.