Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudFormation.ExecuteChangeSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 hierarchy, IncludeNestedStacks must have been set to True.

Creating a Request

data ExecuteChangeSet Source #

The input for the ExecuteChangeSet action.

See: newExecuteChangeSet smart constructor.

Constructors

ExecuteChangeSet'

Fields

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.
disableRollback :: Maybe Bool
Preserves the state of previously provisioned resources when an operation fails.
Default: True
stackName :: Maybe Text
If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.
changeSetName :: Text
The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

Instances

Instances details

ToHeaders ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods toHeaders :: ExecuteChangeSet -> [Header] #
ToPath ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods toPath :: ExecuteChangeSet -> ByteString #
ToQuery ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods toQuery :: ExecuteChangeSet -> QueryString #
AWSRequest ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Associated Types type AWSResponse ExecuteChangeSet # Methods request :: (Service -> Service) -> ExecuteChangeSet -> Request ExecuteChangeSet # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ExecuteChangeSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ExecuteChangeSet))) #
Generic ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Associated Types type Rep ExecuteChangeSet :: Type -> Type # Methods from :: ExecuteChangeSet -> Rep ExecuteChangeSet x # to :: Rep ExecuteChangeSet x -> ExecuteChangeSet #
Read ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods readsPrec :: Int -> ReadS ExecuteChangeSet # readList :: ReadS [ExecuteChangeSet] # readPrec :: ReadPrec ExecuteChangeSet # readListPrec :: ReadPrec [ExecuteChangeSet] #
Show ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods showsPrec :: Int -> ExecuteChangeSet -> ShowS # show :: ExecuteChangeSet -> String # showList :: [ExecuteChangeSet] -> ShowS #
NFData ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods rnf :: ExecuteChangeSet -> () #
Eq ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods (==) :: ExecuteChangeSet -> ExecuteChangeSet -> Bool # (/=) :: ExecuteChangeSet -> ExecuteChangeSet -> Bool #
Hashable ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods hashWithSalt :: Int -> ExecuteChangeSet -> Int # hash :: ExecuteChangeSet -> Int #
type AWSResponse ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet type AWSResponse ExecuteChangeSet = ExecuteChangeSetResponse
type Rep ExecuteChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet type Rep ExecuteChangeSet = D1 ('MetaData "ExecuteChangeSet" "Amazonka.CloudFormation.ExecuteChangeSet" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ExecuteChangeSet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "disableRollback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "changeSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newExecuteChangeSet Source #

Arguments

:: Text	`ExecuteChangeSet`
-> ExecuteChangeSet

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:

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.

ExecuteChangeSet, executeChangeSet_disableRollback - Preserves the state of previously provisioned resources when an operation fails.

Default: True

ExecuteChangeSet, executeChangeSet_stackName - If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.

ExecuteChangeSet, executeChangeSet_changeSetName - The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

Request Lenses

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_disableRollback :: Lens' ExecuteChangeSet (Maybe Bool) Source #

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

Default: True

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

If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.

executeChangeSet_changeSetName :: Lens' ExecuteChangeSet Text Source #

The name or Amazon Resource Name (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 httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ExecuteChangeSetResponse Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Associated Types type Rep ExecuteChangeSetResponse :: Type -> Type # Methods from :: ExecuteChangeSetResponse -> Rep ExecuteChangeSetResponse x # to :: Rep ExecuteChangeSetResponse x -> ExecuteChangeSetResponse #
Read ExecuteChangeSetResponse Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods readsPrec :: Int -> ReadS ExecuteChangeSetResponse # readList :: ReadS [ExecuteChangeSetResponse] # readPrec :: ReadPrec ExecuteChangeSetResponse # readListPrec :: ReadPrec [ExecuteChangeSetResponse] #
Show ExecuteChangeSetResponse Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods showsPrec :: Int -> ExecuteChangeSetResponse -> ShowS # show :: ExecuteChangeSetResponse -> String # showList :: [ExecuteChangeSetResponse] -> ShowS #
NFData ExecuteChangeSetResponse Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods rnf :: ExecuteChangeSetResponse -> () #
Eq ExecuteChangeSetResponse Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet Methods (==) :: ExecuteChangeSetResponse -> ExecuteChangeSetResponse -> Bool # (/=) :: ExecuteChangeSetResponse -> ExecuteChangeSetResponse -> Bool #
type Rep ExecuteChangeSetResponse Source #
Instance details Defined in Amazonka.CloudFormation.ExecuteChangeSet type Rep ExecuteChangeSetResponse = D1 ('MetaData "ExecuteChangeSetResponse" "Amazonka.CloudFormation.ExecuteChangeSet" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ExecuteChangeSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newExecuteChangeSetResponse Source #

Arguments

:: Int	`$sel:httpStatus:ExecuteChangeSetResponse'`
-> ExecuteChangeSetResponse

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

executeChangeSetResponse_httpStatus :: Lens' ExecuteChangeSetResponse Int Source #

The response's http status code.