libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudFormation.DeleteStack

Description

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.

Synopsis

Creating a Request

data DeleteStack Source #

The input for DeleteStack action.

See: newDeleteStack smart constructor.

Constructors

DeleteStack' 

Fields

  • retainResources :: Maybe [Text]

    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 does not delete the retained resources.

    Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

  • clientRequestToken :: Maybe Text

    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 triggered 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.

  • roleARN :: Maybe Text

    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 is generated from your user credentials.

  • stackName :: Text

    The name or the unique stack ID that is associated with the stack.

Instances

Instances details
Eq DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Read DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Show DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Generic DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Associated Types

type Rep DeleteStack :: Type -> Type #

NFData DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Methods

rnf :: DeleteStack -> () #

Hashable DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

AWSRequest DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Associated Types

type AWSResponse DeleteStack #

ToHeaders DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Methods

toHeaders :: DeleteStack -> [Header] #

ToPath DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

ToQuery DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

type Rep DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

type Rep DeleteStack = D1 ('MetaData "DeleteStack" "Amazonka.CloudFormation.DeleteStack" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DeleteStack'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "retainResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteStack Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

newDeleteStack Source #

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:

$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 does not delete the retained resources.

Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

$sel:clientRequestToken: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 triggered 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:roleARN: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 is generated from your user credentials.

$sel:stackName:DeleteStack', deleteStack_stackName - The name or the unique stack ID that is associated with the stack.

Request Lenses

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 does not delete the retained resources.

Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

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 triggered 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_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 is generated from your user credentials.

deleteStack_stackName :: Lens' DeleteStack Text Source #

The name or the unique stack ID that is associated with the stack.

Destructuring the Response

data DeleteStackResponse Source #

See: newDeleteStackResponse smart constructor.

Constructors

DeleteStackResponse' 

Instances

Instances details
Eq DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Read DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Show DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Generic DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Associated Types

type Rep DeleteStackResponse :: Type -> Type #

NFData DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

Methods

rnf :: DeleteStackResponse -> () #

type Rep DeleteStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeleteStack

type Rep DeleteStackResponse = D1 ('MetaData "DeleteStackResponse" "Amazonka.CloudFormation.DeleteStack" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DeleteStackResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteStackResponse :: DeleteStackResponse Source #

Create a value of DeleteStackResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.