|
17 | 17 | - [!Include](#include)
|
18 | 18 | - [Task types](#task-types)
|
19 | 19 | - [update-organization](#update-organization)
|
| 20 | + - [annotate-organization](#annotate-organization) |
20 | 21 | - [update-stacks](#update-stacks)
|
21 | 22 | - [update-serverless.com](#update-serverlesscom)
|
22 | 23 | - [copy-to-s3](#copy-to-s3)
|
@@ -282,6 +283,28 @@ The `update-organization` task will update all the organization resources based
|
282 | 283 | | Skip | `true` or `false` | When `true` task (and dependent tasks) will not be executed. |
|
283 | 284 | | TemplatingContext | Dictionary | Specifies the data for [templating](#templating). |
|
284 | 285 |
|
| 286 | +### annotate-organization |
| 287 | + |
| 288 | +The `annotate-organization` task will will allow you to use a different account factory (e.g. AWS Control Tower) while using org-formation to provision resources across the AWS Organization. If you use `annotate-organization`, you must use this *instead of* `update-organization`. |
| 289 | + |
| 290 | +| Attribute | Value | Remarks | |
| 291 | +| :---------------- | :---------------- | :----------------------------------------------------------- | |
| 292 | +| DefaultOrganizationAccessRoleName | string | The name of the Role used for cross account access (default is: `OrganizationAccountAccessRole`). | |
| 293 | +| ExcludeAccounts | List<string> | A list (array) of AWS Account Ids (string) that will be excluded from the org-formation provisioning process. These accounts will not be addressable using `!Ref AccountName` or bindings, such as `Account: *` | |
| 294 | +| AccountMapping | Dictionary<string, string> | Dictionary where the AttributeName will be used as the Logical Name of the account, specified as Attribute value. When not specified, the account name is used as Logical Name.| |
| 295 | + |
| 296 | +example: |
| 297 | +``` yml |
| 298 | +AnnotateOrganization: |
| 299 | + Type: annotate-organization |
| 300 | + DefaultOrganizationAccessRoleName: OrganizationAccountAccessRole |
| 301 | + ExcludeAccounts: ["123123123123", "123123123124"] |
| 302 | + AccountMapping: |
| 303 | + AccountA: "234234234234" # these mappings are optional, when specified the account can be referenced using `!Ref AccountA` |
| 304 | + AccountB: "234234234235" # when not specified the account can be referenced using `!Ref My Account B` (or whatever the account name is) |
| 305 | + # regardless of this, accounts will always be included in bindings like `Account: *` |
| 306 | +``` |
| 307 | + |
285 | 308 | ### update-stacks
|
286 | 309 |
|
287 | 310 | The `update-stacks` task will provision all resources in all accounts specified in `Template`.
|
|
0 commit comments