Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudformation ]

delete-stack-instances

Description

Deletes stack instances for the specified accounts, in the specified Regions.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-stack-instances
--stack-set-name <value>
[--accounts <value>]
[--deployment-targets <value>]
--regions <value>
[--operation-preferences <value>]
--retain-stacks | --no-retain-stacks
[--operation-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--stack-set-name (string)

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 AWS accounts that you want to delete stack instances for.

You can specify Accounts or DeploymentTargets , but not both.

(string)

Syntax:

"string" "string" ...

--deployment-targets (structure)

[Service-managed permissions] The AWS 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 AWS accounts for which you want to deploy stack set updates.

(string)

OrganizationalUnitIds -> (list)

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

(string)

Shorthand Syntax:

Accounts=string,string,OrganizationalUnitIds=string,string

JSON Syntax:

{
  "Accounts": ["string", ...],
  "OrganizationalUnitIds": ["string", ...]
}

--regions (list)

The Regions where you want to delete stack set instances.

(string)

Syntax:

"string" "string" ...

--operation-preferences (structure)

Preferences for how AWS CloudFormation performs this stack set operation.

RegionOrder -> (list)

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

(string)

FailureToleranceCount -> (integer)

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

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

FailureTolerancePercentage -> (integer)

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

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

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

MaxConcurrentCount -> (integer)

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount . MaxConcurrentCount is at most one more than the FailureToleranceCount .

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.

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, AWS 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.

Shorthand Syntax:

RegionOrder=string,string,FailureToleranceCount=integer,FailureTolerancePercentage=integer,MaxConcurrentCount=integer,MaxConcurrentPercentage=integer

JSON Syntax:

{
  "RegionOrder": ["string", ...],
  "FailureToleranceCount": integer,
  "FailureTolerancePercentage": integer,
  "MaxConcurrentCount": integer,
  "MaxConcurrentPercentage": integer
}

--retain-stacks | --no-retain-stacks (boolean)

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 .

--operation-id (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 AWS 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 AWS CloudFormation successfully received them.

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To delete stack instances

The following delete-stack-instances example deletes instances of a stack set in two accounts in two regions and terminates the stacks.

aws cloudformation delete-stack-instances \
    --stack-set-name my-stack-set \
    --accounts 123456789012 567890123456 \
    --regions us-east-1 us-west-1 \
    --no-retain-stacks

Output:

{
    "OperationId": "ad49f10c-fd1d-413f-a20a-8de6e2fa8f27"
}

To delete an empty stack set, use the delete-stack-set command.

Output

OperationId -> (string)

The unique identifier for this stack set operation.