Network.AWS.CloudFormation.DeleteStack

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.

Creating a Request

deleteStack

Arguments

:: Text

dsStackName

-> DeleteStack

Creates a value of DeleteStack with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dsRetainResources - 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, AWS 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.
• dsClientRequestToken - A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS 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 .
• dsRoleARN - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
• dsStackName - The name or the unique stack ID that is associated with the stack.

data DeleteStack

The input for DeleteStack action.

See: deleteStack smart constructor.

Instances

Eq DeleteStack

Methods

(==) :: DeleteStack -> DeleteStack -> Bool

(/=) :: DeleteStack -> DeleteStack -> Bool

Data DeleteStack

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteStack -> c DeleteStack

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteStack

toConstr :: DeleteStack -> Constr

dataTypeOf :: DeleteStack -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteStack)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteStack)

gmapT :: (forall b. Data b => b -> b) -> DeleteStack -> DeleteStack

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteStack -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteStack -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteStack -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteStack -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteStack -> m DeleteStack

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteStack -> m DeleteStack

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteStack -> m DeleteStack

Read DeleteStack

Methods

readsPrec :: Int -> ReadS DeleteStack

readList :: ReadS [DeleteStack]

readPrec :: ReadPrec DeleteStack

readListPrec :: ReadPrec [DeleteStack]

Show DeleteStack

Methods

showsPrec :: Int -> DeleteStack -> ShowS

show :: DeleteStack -> String

showList :: [DeleteStack] -> ShowS

Generic DeleteStack

Associated Types

type Rep DeleteStack :: * -> *

Methods

from :: DeleteStack -> Rep DeleteStack x

to :: Rep DeleteStack x -> DeleteStack

Hashable DeleteStack

Methods

hashWithSalt :: Int -> DeleteStack -> Int

hash :: DeleteStack -> Int

NFData DeleteStack

Methods

rnf :: DeleteStack -> ()

AWSRequest DeleteStack

Associated Types

type Rs DeleteStack :: *

Methods

request :: DeleteStack -> Request DeleteStack

response :: MonadResource m => Logger -> Service -> Proxy * DeleteStack -> ClientResponse -> m (Response DeleteStack)

ToQuery DeleteStack

Methods

toQuery :: DeleteStack -> QueryString

ToPath DeleteStack

Methods

toPath :: DeleteStack -> ByteString

ToHeaders DeleteStack

Methods

toHeaders :: DeleteStack -> [Header]

type Rep DeleteStack

type Rep DeleteStack = D1 (MetaData "DeleteStack" "Network.AWS.CloudFormation.DeleteStack" "amazonka-cloudformation-1.5.0-KJ8fU86x75V4EoPee9jClQ" False) (C1 (MetaCons "DeleteStack'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dsRetainResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_dsClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dsRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dsStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs DeleteStack

type Rs DeleteStack = DeleteStackResponse

Request Lenses

dsRetainResources :: Lens' DeleteStack [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, AWS 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.

dsClientRequestToken :: Lens' DeleteStack (Maybe Text)

A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS 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 .

dsRoleARN :: Lens' DeleteStack (Maybe Text)

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

dsStackName :: Lens' DeleteStack Text

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

Destructuring the Response

deleteStackResponse :: DeleteStackResponse

Creates a value of DeleteStackResponse with the minimum fields required to make a request.

data DeleteStackResponse

See: deleteStackResponse smart constructor.

Instances

Eq DeleteStackResponse

Methods

(==) :: DeleteStackResponse -> DeleteStackResponse -> Bool

(/=) :: DeleteStackResponse -> DeleteStackResponse -> Bool

Data DeleteStackResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteStackResponse -> c DeleteStackResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteStackResponse

toConstr :: DeleteStackResponse -> Constr

dataTypeOf :: DeleteStackResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteStackResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteStackResponse)

gmapT :: (forall b. Data b => b -> b) -> DeleteStackResponse -> DeleteStackResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteStackResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteStackResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteStackResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteStackResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteStackResponse -> m DeleteStackResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteStackResponse -> m DeleteStackResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteStackResponse -> m DeleteStackResponse

Read DeleteStackResponse

Methods

readsPrec :: Int -> ReadS DeleteStackResponse

readList :: ReadS [DeleteStackResponse]

readPrec :: ReadPrec DeleteStackResponse

readListPrec :: ReadPrec [DeleteStackResponse]

Show DeleteStackResponse

Methods

showsPrec :: Int -> DeleteStackResponse -> ShowS

show :: DeleteStackResponse -> String

showList :: [DeleteStackResponse] -> ShowS

Generic DeleteStackResponse

Associated Types

type Rep DeleteStackResponse :: * -> *

Methods

from :: DeleteStackResponse -> Rep DeleteStackResponse x

to :: Rep DeleteStackResponse x -> DeleteStackResponse

NFData DeleteStackResponse

Methods

rnf :: DeleteStackResponse -> ()

type Rep DeleteStackResponse

type Rep DeleteStackResponse = D1 (MetaData "DeleteStackResponse" "Network.AWS.CloudFormation.DeleteStack" "amazonka-cloudformation-1.5.0-KJ8fU86x75V4EoPee9jClQ" False) (C1 (MetaCons "DeleteStackResponse'" PrefixI False) U1)