CloudFormation / Client / delete_stack_instances

delete_stack_instances

CloudFormation.Client.delete_stack_instances(**kwargs)

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.

See also: AWS API Documentation

Request Syntax

response = client.delete_stack_instances(
    StackSetName='string',
    Accounts=[
        'string',
    ],
    DeploymentTargets={
        'Accounts': [
            'string',
        ],
        'AccountsUrl': 'string',
        'OrganizationalUnitIds': [
            'string',
        ],
        'AccountFilterType': 'NONE'|'INTERSECTION'|'DIFFERENCE'|'UNION'
    },
    Regions=[
        'string',
    ],
    OperationPreferences={
        'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL',
        'RegionOrder': [
            'string',
        ],
        'FailureToleranceCount': 123,
        'FailureTolerancePercentage': 123,
        'MaxConcurrentCount': 123,
        'MaxConcurrentPercentage': 123,
        'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE'|'SOFT_FAILURE_TOLERANCE'
    },
    RetainStacks=True|False,
    OperationId='string',
    CallAs='SELF'|'DELEGATED_ADMIN'
)

Parameters:

• StackSetName (string) –

  [REQUIRED]

  The name or unique ID of the stack set that you want to delete stack instances for.

• Accounts (list) –

  [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.

  You can specify Accounts or DeploymentTargets, but not both.

  • (string) –

• DeploymentTargets (dict) –

  [Service-managed permissions] The Organizations accounts from which to delete stack instances.

  You can specify Accounts or DeploymentTargets, but not both.

  • Accounts (list) –

    The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.

    • (string) –

  • AccountsUrl (string) –

    Returns the value of the AccountsUrl property.

  • OrganizationalUnitIds (list) –

    The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

    • (string) –

  • AccountFilterType (string) –

    Limit deployment targets to individual accounts or include additional accounts with provided OUs.

    The following is a list of possible values for the AccountFilterType operation.

    • INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.

    • DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.

    • UNION: StackSets includes additional accounts deployment targets. This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.

    • NONE: Deploys to all the accounts in specified organizational units (OU).

• Regions (list) –

  [REQUIRED]

  The Amazon Web Services Regions where you want to delete stack set instances.

  • (string) –

• OperationPreferences (dict) –

  Preferences for how CloudFormation performs this stack set operation.

  • RegionConcurrencyType (string) –

    The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

  • RegionOrder (list) –

    The order of the Regions where you want to perform the stack operation.

    Note

    RegionOrder isn’t followed if AutoDeployment is enabled.

    • (string) –

  • FailureToleranceCount (integer) –

    The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn’t attempt the operation in any subsequent Regions.

    Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

    By default, 0 is specified.

  • FailureTolerancePercentage (integer) –

    The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn’t attempt the operation in any subsequent Regions.

    When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

    Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

    By default, 0 is specified.

  • MaxConcurrentCount (integer) –

    The maximum number of accounts in which to perform this operation at one time. This can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you’re using STRICT_FAILURE_TOLERANCE.

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

    By default, 1 is specified.

  • MaxConcurrentPercentage (integer) –

    The maximum percentage of accounts in which to perform this operation at one time.

    When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

    By default, 1 is specified.

  • ConcurrencyMode (string) –

    Specifies how the concurrency level behaves during the operation execution.

    • STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of FailureToleranceCount +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.

    • SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

• RetainStacks (boolean) –

  [REQUIRED]

  Removes the stack instances from the specified stack set, but doesn’t delete the stacks. You can’t reassociate a retained stack or add an existing, saved stack to a new stack set.

  For more information, see Stack set operation options.

• OperationId (string) –

  The unique identifier for this stack set operation.

  If you don’t specify an operation ID, the SDK generates one automatically.

  The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.

  Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

  This field is autopopulated if not provided.

• CallAs (string) –

  [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

  By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Return type:

dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

• (dict) –

  • OperationId (string) –

    The unique identifier for this stack set operation.

Exceptions

• CloudFormation.Client.exceptions.StackSetNotFoundException

• CloudFormation.Client.exceptions.OperationInProgressException

• CloudFormation.Client.exceptions.OperationIdAlreadyExistsException

• CloudFormation.Client.exceptions.StaleRequestException

• CloudFormation.Client.exceptions.InvalidOperationException