/AWS1/CL_FRMDEPLOYMENTTARGETS¶
Specifies the Organizations accounts where you want to create, update, or delete stack instances. You can target either your entire organization or specific accounts using organizational units (OUs) and account filter options.
CloudFormation doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.
When performing create operations, if you specify both OrganizationalUnitIds
and Accounts, you must also specify the AccountFilterType property.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
it_accounts TYPE /AWS1/CL_FRMACCOUNTLIST_W=>TT_ACCOUNTLIST TT_ACCOUNTLIST¶
The Amazon Web Services account IDs where you want to perform stack operations. How these accounts are used depends on the
AccountFilterTypeproperty.If you have many account numbers, you can provide those accounts using the
AccountsUrlproperty instead.
iv_accountsurl TYPE /AWS1/FRMACCOUNTSURL /AWS1/FRMACCOUNTSURL¶
The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs. The file format must be either
.csvor.txt, and the data can be comma-separated or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000 accounts).This property serves the same purpose as
Accountsbut allows you to specify a large number of accounts.
it_organizationalunitids TYPE /AWS1/CL_FRMORGALUNITIDLIST_W=>TT_ORGANIZATIONALUNITIDLIST TT_ORGANIZATIONALUNITIDLIST¶
The organization root ID or organizational unit (OU) IDs where you want to perform stack operations. CloudFormation will perform operations on accounts within these OUs and their child OUs.
iv_accountfiltertype TYPE /AWS1/FRMACCOUNTFILTERTYPE /AWS1/FRMACCOUNTFILTERTYPE¶
Refines which accounts will have stack operations performed on them by specifying how to use the
AccountsandOrganizationalUnitIdsproperties together.The following values determine how CloudFormation selects target accounts:
INTERSECTION: Performs stack operations only on specific individual accounts within the selected OUs. Only accounts that are both specified in theAccountsproperty and belong to the specified OUs will be targeted.
DIFFERENCE: Performs stack operations on all accounts in the selected OUs except for specific accounts listed in theAccountsproperty. This enables you to exclude certain accounts within an OU, such as suspended accounts.
UNION: Performs stack operations on the specified OUs plus additional individual accounts listed in theAccountsproperty. This is the default value ifAccountFilterTypeis not provided. This lets you target an entire OU and individual accounts from a different OU in one request. Note thatUNIONis not supported forCreateStackInstancesoperations.
NONE: Performs stack operations on all accounts in the specified organizational units (OUs).
Queryable Attributes¶
Accounts¶
The Amazon Web Services account IDs where you want to perform stack operations. How these accounts are used depends on the
AccountFilterTypeproperty.If you have many account numbers, you can provide those accounts using the
AccountsUrlproperty instead.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCOUNTS() |
Getter for ACCOUNTS, with configurable default |
ASK_ACCOUNTS() |
Getter for ACCOUNTS w/ exceptions if field has no value |
HAS_ACCOUNTS() |
Determine if ACCOUNTS has a value |
AccountsUrl¶
The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs. The file format must be either
.csvor.txt, and the data can be comma-separated or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000 accounts).This property serves the same purpose as
Accountsbut allows you to specify a large number of accounts.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCOUNTSURL() |
Getter for ACCOUNTSURL, with configurable default |
ASK_ACCOUNTSURL() |
Getter for ACCOUNTSURL w/ exceptions if field has no value |
HAS_ACCOUNTSURL() |
Determine if ACCOUNTSURL has a value |
OrganizationalUnitIds¶
The organization root ID or organizational unit (OU) IDs where you want to perform stack operations. CloudFormation will perform operations on accounts within these OUs and their child OUs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ORGANIZATIONALUNITIDS() |
Getter for ORGANIZATIONALUNITIDS, with configurable default |
ASK_ORGANIZATIONALUNITIDS() |
Getter for ORGANIZATIONALUNITIDS w/ exceptions if field has |
HAS_ORGANIZATIONALUNITIDS() |
Determine if ORGANIZATIONALUNITIDS has a value |
AccountFilterType¶
Refines which accounts will have stack operations performed on them by specifying how to use the
AccountsandOrganizationalUnitIdsproperties together.The following values determine how CloudFormation selects target accounts:
INTERSECTION: Performs stack operations only on specific individual accounts within the selected OUs. Only accounts that are both specified in theAccountsproperty and belong to the specified OUs will be targeted.
DIFFERENCE: Performs stack operations on all accounts in the selected OUs except for specific accounts listed in theAccountsproperty. This enables you to exclude certain accounts within an OU, such as suspended accounts.
UNION: Performs stack operations on the specified OUs plus additional individual accounts listed in theAccountsproperty. This is the default value ifAccountFilterTypeis not provided. This lets you target an entire OU and individual accounts from a different OU in one request. Note thatUNIONis not supported forCreateStackInstancesoperations.
NONE: Performs stack operations on all accounts in the specified organizational units (OUs).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCOUNTFILTERTYPE() |
Getter for ACCOUNTFILTERTYPE, with configurable default |
ASK_ACCOUNTFILTERTYPE() |
Getter for ACCOUNTFILTERTYPE w/ exceptions if field has no v |
HAS_ACCOUNTFILTERTYPE() |
Determine if ACCOUNTFILTERTYPE has a value |