| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudFormation.DeleteStack
Description
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.
Synopsis
- data DeleteStack = DeleteStack' {}
- newDeleteStack :: Text -> DeleteStack
- deleteStack_clientRequestToken :: Lens' DeleteStack (Maybe Text)
- deleteStack_retainResources :: Lens' DeleteStack (Maybe [Text])
- deleteStack_roleARN :: Lens' DeleteStack (Maybe Text)
- deleteStack_stackName :: Lens' DeleteStack Text
- data DeleteStackResponse = DeleteStackResponse' {
- newDeleteStackResponse :: DeleteStackResponse
Creating a Request
data DeleteStack Source #
The input for DeleteStack action.
See: newDeleteStack smart constructor.
Constructors
| DeleteStack' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DeleteStack |
Create a value of DeleteStack with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteStack, deleteStack_clientRequestToken - 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.
$sel:retainResources:DeleteStack', deleteStack_retainResources - 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.
DeleteStack, deleteStack_roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management
(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.
DeleteStack, deleteStack_stackName - The name or the unique stack ID that's associated with the stack.
Request Lenses
deleteStack_clientRequestToken :: Lens' DeleteStack (Maybe Text) Source #
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.
deleteStack_retainResources :: Lens' DeleteStack (Maybe [Text]) Source #
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.
deleteStack_roleARN :: Lens' DeleteStack (Maybe Text) Source #
The Amazon Resource Name (ARN) of an Identity and Access Management (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.
deleteStack_stackName :: Lens' DeleteStack Text Source #
The name or the unique stack ID that's associated with the stack.
Destructuring the Response
data DeleteStackResponse Source #
See: newDeleteStackResponse smart constructor.
Constructors
| DeleteStackResponse' | |
Instances
newDeleteStackResponse :: DeleteStackResponse Source #
Create a value of DeleteStackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.