[ aws . cloudformation ]
Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
See also: AWS API Documentation
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>]
[--call-as <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--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 Amazon Web Services accounts that you want to delete stack instances for.
You can specify
Accounts
orDeploymentTargets
, but not both.(string)
Syntax:
"string" "string" ...
--deployment-targets
(structure)
[Service-managed permissions] The Organizations accounts from which to delete stack instances.
You can specify
Accounts
orDeploymentTargets
, 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 inAccounts
parameter.
DIFFERENCE
: StackSets excludes the accounts specified inAccounts
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 ifAccountFilterType
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).
Shorthand Syntax:
Accounts=string,string,AccountsUrl=string,OrganizationalUnitIds=string,string,AccountFilterType=string
JSON Syntax:
{
"Accounts": ["string", ...],
"AccountsUrl": "string",
"OrganizationalUnitIds": ["string", ...],
"AccountFilterType": "NONE"|"INTERSECTION"|"DIFFERENCE"|"UNION"
}
--regions
(list)
The Amazon Web Services Regions where you want to delete stack set instances.
(string)
Syntax:
"string" "string" ...
--operation-preferences
(structure)
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 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 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
orFailureTolerancePercentage
(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
orFailureTolerancePercentage
, 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 is dependent on the value of
FailureToleranceCount
.``MaxConcurrentCount`` is at most one more than theFailureToleranceCount
.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
orMaxConcurrentPercentage
, 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
orMaxConcurrentPercentage
, but not both.By default,
1
is specified.
Shorthand Syntax:
RegionConcurrencyType=string,RegionOrder=string,string,FailureToleranceCount=integer,FailureTolerancePercentage=integer,MaxConcurrentCount=integer,MaxConcurrentPercentage=integer
JSON Syntax:
{
"RegionConcurrencyType": "SEQUENTIAL"|"PARALLEL",
"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 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
.
--call-as
(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. UseSELF
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 .Possible values:
SELF
DELEGATED_ADMIN
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
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.
OperationId -> (string)
The unique identifier for this stack set operation.