Skip to content

DeploymentTargets

Source code in docs_src/capo_cloudformation/types/deployment_targets.py
class DeploymentTargets(TypedDict, closed=True):
    accounts: NotRequired["capo_cloudformation.types.account_list.AccountList"]
    """<p>The Amazon Web Services account IDs where you want to perform stack operations. How these accounts are used depends on the <code>AccountFilterType</code> property.</p> <p>If you have many account numbers, you can provide those accounts using the <code>AccountsUrl</code> property instead.</p>"""
    accounts_url: NotRequired["capo_cloudformation.types.accounts_url.AccountsUrl"]
    """<p>The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs. The file format must be either <code>.csv</code> or <code>.txt</code>, and the data can be comma-separated or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000 accounts).</p> <p>This property serves the same purpose as <code>Accounts</code> but allows you to specify a large number of accounts.</p>"""
    organizational_unit_ids: NotRequired[
        "capo_cloudformation.types.organizational_unit_id_list.OrganizationalUnitIdList"
    ]
    """<p>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.</p>"""
    account_filter_type: NotRequired[
        "capo_cloudformation.types.account_filter_type.AccountFilterType"
    ]
    """<p>Refines which accounts will have stack operations performed on them by specifying how to use the <code>Accounts</code> and <code>OrganizationalUnitIds</code> properties together.</p> <p>The following values determine how CloudFormation selects target accounts:</p> <ul> <li> <p> <code>INTERSECTION</code>: Performs stack operations only on specific individual accounts within the selected OUs. Only accounts that are both specified in the <code>Accounts</code> property and belong to the specified OUs will be targeted.</p> </li> <li> <p> <code>DIFFERENCE</code>: Performs stack operations on all accounts in the selected OUs except for specific accounts listed in the <code>Accounts</code> property. This enables you to exclude certain accounts within an OU, such as suspended accounts.</p> </li> <li> <p> <code>UNION</code>: Performs stack operations on the specified OUs plus additional individual accounts listed in the <code>Accounts</code> property. This is the default value if <code>AccountFilterType</code> is not provided. This lets you target an entire OU and individual accounts from a different OU in one request. Note that <code>UNION</code> is not supported for <code>CreateStackInstances</code> operations.</p> </li> <li> <p> <code>NONE</code>: Performs stack operations on all accounts in the specified organizational units (OUs).</p> </li> </ul>"""

account_filter_type instance-attribute

account_filter_type: NotRequired[AccountFilterType]

Refines which accounts will have stack operations performed on them by specifying how to use the Accounts and OrganizationalUnitIds properties 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 the Accounts property 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 the Accounts property. 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 the Accounts property. This is the default value if AccountFilterType is not provided. This lets you target an entire OU and individual accounts from a different OU in one request. Note that UNION is not supported for CreateStackInstances operations.

  • NONE: Performs stack operations on all accounts in the specified organizational units (OUs).

accounts instance-attribute

accounts: NotRequired[AccountList]

The Amazon Web Services account IDs where you want to perform stack operations. How these accounts are used depends on the AccountFilterType property.

If you have many account numbers, you can provide those accounts using the AccountsUrl property instead.

accounts_url instance-attribute

accounts_url: NotRequired[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 .csv or .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 Accounts but allows you to specify a large number of accounts.

organizational_unit_ids instance-attribute

organizational_unit_ids: NotRequired[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.