amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.CancelUpdateStack

Description

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

Synopsis

Creating a Request

data CancelUpdateStack Source #

The input for the CancelUpdateStack action.

See: newCancelUpdateStack smart constructor.

Constructors

CancelUpdateStack' 

Fields

  • clientRequestToken :: Maybe Text

    A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.

  • stackName :: Text

    The name or the unique stack ID that's associated with the stack.

Instances

Instances details
ToHeaders CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

ToPath CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

ToQuery CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

AWSRequest CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

Associated Types

type AWSResponse CancelUpdateStack #

Generic CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

Associated Types

type Rep CancelUpdateStack :: Type -> Type #

Read CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

Show CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

NFData CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

Methods

rnf :: CancelUpdateStack -> () #

Eq CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

Hashable CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

type AWSResponse CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

type Rep CancelUpdateStack Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

type Rep CancelUpdateStack = D1 ('MetaData "CancelUpdateStack" "Amazonka.CloudFormation.CancelUpdateStack" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "CancelUpdateStack'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelUpdateStack Source #

Create a value of CancelUpdateStack 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:

CancelUpdateStack, cancelUpdateStack_clientRequestToken - A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.

CancelUpdateStack, cancelUpdateStack_stackName - The name or the unique stack ID that's associated with the stack.

Request Lenses

cancelUpdateStack_clientRequestToken :: Lens' CancelUpdateStack (Maybe Text) Source #

A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.

cancelUpdateStack_stackName :: Lens' CancelUpdateStack Text Source #

The name or the unique stack ID that's associated with the stack.

Destructuring the Response

data CancelUpdateStackResponse Source #

See: newCancelUpdateStackResponse smart constructor.

Instances

Instances details
Generic CancelUpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

Associated Types

type Rep CancelUpdateStackResponse :: Type -> Type #

Read CancelUpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

Show CancelUpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

NFData CancelUpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

Eq CancelUpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

type Rep CancelUpdateStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CancelUpdateStack

type Rep CancelUpdateStackResponse = D1 ('MetaData "CancelUpdateStackResponse" "Amazonka.CloudFormation.CancelUpdateStack" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "CancelUpdateStackResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newCancelUpdateStackResponse :: CancelUpdateStackResponse Source #

Create a value of CancelUpdateStackResponse with all optional fields omitted.

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