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

Description

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

To create a change set for the entire stack hierachy, IncludeNestedStacks must have been set to True.

Synopsis

Creating a Request

data ExecuteChangeSet Source #

The input for the ExecuteChangeSet action.

See: newExecuteChangeSet smart constructor.

Constructors

ExecuteChangeSet' 

Fields

  • disableRollback :: Maybe Bool

    Preserves the state of previously provisioned resources when an operation fails.

    Default: True

  • clientRequestToken :: Maybe Text

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

  • stackName :: Maybe Text

    If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.

  • changeSetName :: Text

    The name or ARN of the change set that you want use to update the specified stack.

Instances

Instances details
Eq ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

Read ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

Show ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

Generic ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

Associated Types

type Rep ExecuteChangeSet :: Type -> Type #

NFData ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

Methods

rnf :: ExecuteChangeSet -> () #

Hashable ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

AWSRequest ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

Associated Types

type AWSResponse ExecuteChangeSet #

ToHeaders ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

ToPath ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

ToQuery ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

type Rep ExecuteChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

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

Defined in Amazonka.CloudFormation.ExecuteChangeSet

newExecuteChangeSet Source #

Create a value of ExecuteChangeSet 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:disableRollback:ExecuteChangeSet', executeChangeSet_disableRollback - Preserves the state of previously provisioned resources when an operation fails.

Default: True

$sel:clientRequestToken:ExecuteChangeSet', executeChangeSet_clientRequestToken - A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.

$sel:stackName:ExecuteChangeSet', executeChangeSet_stackName - If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.

$sel:changeSetName:ExecuteChangeSet', executeChangeSet_changeSetName - The name or ARN of the change set that you want use to update the specified stack.

Request Lenses

executeChangeSet_disableRollback :: Lens' ExecuteChangeSet (Maybe Bool) Source #

Preserves the state of previously provisioned resources when an operation fails.

Default: True

executeChangeSet_clientRequestToken :: Lens' ExecuteChangeSet (Maybe Text) Source #

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

executeChangeSet_stackName :: Lens' ExecuteChangeSet (Maybe Text) Source #

If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.

executeChangeSet_changeSetName :: Lens' ExecuteChangeSet Text Source #

The name or ARN of the change set that you want use to update the specified stack.

Destructuring the Response

data ExecuteChangeSetResponse Source #

The output for the ExecuteChangeSet action.

See: newExecuteChangeSetResponse smart constructor.

Constructors

ExecuteChangeSetResponse' 

Fields

Instances

Instances details
Eq ExecuteChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

Read ExecuteChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

Show ExecuteChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

Generic ExecuteChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

Associated Types

type Rep ExecuteChangeSetResponse :: Type -> Type #

NFData ExecuteChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

type Rep ExecuteChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ExecuteChangeSet

type Rep ExecuteChangeSetResponse = D1 ('MetaData "ExecuteChangeSetResponse" "Amazonka.CloudFormation.ExecuteChangeSet" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "ExecuteChangeSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newExecuteChangeSetResponse Source #

Create a value of ExecuteChangeSetResponse 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:httpStatus:ExecuteChangeSetResponse', executeChangeSetResponse_httpStatus - The response's http status code.

Response Lenses