amazonka-cloudformation-1.4.5: Amazon CloudFormation SDK.

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

Network.AWS.CloudFormation.DeleteStack

Contents

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

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.
  • 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 # 
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 # 
Show DeleteStack # 
Generic DeleteStack # 

Associated Types

type Rep DeleteStack :: * -> * #

Hashable DeleteStack # 
NFData DeleteStack # 

Methods

rnf :: DeleteStack -> () #

AWSRequest DeleteStack # 
ToQuery DeleteStack # 
ToPath DeleteStack # 
ToHeaders DeleteStack # 

Methods

toHeaders :: DeleteStack -> [Header] #

type Rep DeleteStack # 
type Rep DeleteStack = D1 (MetaData "DeleteStack" "Network.AWS.CloudFormation.DeleteStack" "amazonka-cloudformation-1.4.5-GkPqDOYcHIlLStUFA5eeUs" False) (C1 (MetaCons "DeleteStack'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dsRetainResources") 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 # 

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.

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 # 
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 # 
Show DeleteStackResponse # 
Generic DeleteStackResponse # 
NFData DeleteStackResponse # 

Methods

rnf :: DeleteStackResponse -> () #

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