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

Description

When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.

Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.

  • CREATE_COMPLETE
  • UPDATE_COMPLETE
  • UPDATE_ROLLBACK_COMPLETE
  • IMPORT_COMPLETE
  • IMPORT_ROLLBACK_COMPLETE
Synopsis

Creating a Request

data RollbackStack Source #

See: newRollbackStack smart constructor.

Constructors

RollbackStack' 

Fields

  • clientRequestToken :: Maybe Text

    A unique identifier for this RollbackStack request.

  • roleARN :: Maybe Text

    The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.

  • stackName :: Text

    The name that's associated with the stack.

Instances

Instances details
ToHeaders RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

ToPath RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

ToQuery RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

AWSRequest RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

Associated Types

type AWSResponse RollbackStack #

Generic RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

Associated Types

type Rep RollbackStack :: Type -> Type #

Read RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

Show RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

NFData RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

Methods

rnf :: RollbackStack -> () #

Eq RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

Hashable RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

type AWSResponse RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

type Rep RollbackStack Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

type Rep RollbackStack = D1 ('MetaData "RollbackStack" "Amazonka.CloudFormation.RollbackStack" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "RollbackStack'" 'PrefixI 'True) (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))))

newRollbackStack Source #

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

RollbackStack, rollbackStack_clientRequestToken - A unique identifier for this RollbackStack request.

RollbackStack, rollbackStack_roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.

RollbackStack, rollbackStack_stackName - The name that's associated with the stack.

Request Lenses

rollbackStack_clientRequestToken :: Lens' RollbackStack (Maybe Text) Source #

A unique identifier for this RollbackStack request.

rollbackStack_roleARN :: Lens' RollbackStack (Maybe Text) Source #

The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.

rollbackStack_stackName :: Lens' RollbackStack Text Source #

The name that's associated with the stack.

Destructuring the Response

data RollbackStackResponse Source #

See: newRollbackStackResponse smart constructor.

Constructors

RollbackStackResponse' 

Fields

Instances

Instances details
Generic RollbackStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

Associated Types

type Rep RollbackStackResponse :: Type -> Type #

Read RollbackStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

Show RollbackStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

NFData RollbackStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

Methods

rnf :: RollbackStackResponse -> () #

Eq RollbackStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

type Rep RollbackStackResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RollbackStack

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

newRollbackStackResponse Source #

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

RollbackStackResponse, rollbackStackResponse_stackId - Unique identifier of the stack.

$sel:httpStatus:RollbackStackResponse', rollbackStackResponse_httpStatus - The response's http status code.

Response Lenses