delete_stack¶
Operation¶
async
¶
delete_stack(input: DeleteStackInput, plugins: list[Plugin] | None = None) -> DeleteStackOutput
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.
For more information about deleting a stack, see Delete a stack from the CloudFormation console in the CloudFormation User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeleteStackInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DeleteStackOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
The input for DeleteStack action.
Attributes¶
class-attribute
instance-attribute
¶
client_request_token: str | None = ...
A unique identifier for this DeleteStack request. Specify this token
if you plan to retry requests so that CloudFormation knows that you're
not attempting to delete a stack with the same name. You might retry
DeleteStack requests to ensure that CloudFormation successfully
received them.
All events initiated by a given stack operation are assigned the same
client request token, which you can use to track operations. For
example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will
have ClientRequestToken set as token1.
In the console, stack operations display the client request token on the
Events tab. Stack operations that are initiated from the console use the
token format Console-StackOperation-ID, which helps you easily
identify the stack operation . For example, if you create a stack using
the console, each stack event would be assigned the same token in the
following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
class-attribute
instance-attribute
¶
deletion_mode: str | None = ...
Specifies the deletion mode for the stack. Possible values are:
-
STANDARD- Use the standard behavior. Specifying this value is the same as not specifying this parameter. -
FORCE_DELETE_STACK- Delete the stack if it's stuck in aDELETE_FAILEDstate due to resource deletion failure.
class-attribute
instance-attribute
¶
deployment_config: DeploymentConfig | None = ...
The deployment configuration for this stack operation, including the deployment mode.
class-attribute
instance-attribute
¶
For stacks in the DELETE_FAILED state, a list of resource logical IDs
that are associated with the resources you want to retain. During
deletion, CloudFormation deletes the stack but doesn't delete the
retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.
class-attribute
instance-attribute
¶
role_arn: str | None = ...
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteStackOutput structure.