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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.

To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.

To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.

Synopsis

data CreateChangeSet = CreateChangeSet' {
- capabilities :: Maybe [Capability]
- changeSetType :: Maybe ChangeSetType
- clientToken :: Maybe Text
- description :: Maybe Text
- includeNestedStacks :: Maybe Bool
- notificationARNs :: Maybe [Text]
- parameters :: Maybe [Parameter]
- resourceTypes :: Maybe [Text]
- resourcesToImport :: Maybe [ResourceToImport]
- roleARN :: Maybe Text
- rollbackConfiguration :: Maybe RollbackConfiguration
- tags :: Maybe [Tag]
- templateBody :: Maybe Text
- templateURL :: Maybe Text
- usePreviousTemplate :: Maybe Bool
- stackName :: Text
- changeSetName :: Text
}
newCreateChangeSet :: Text -> Text -> CreateChangeSet
createChangeSet_capabilities :: Lens' CreateChangeSet (Maybe [Capability])
createChangeSet_changeSetType :: Lens' CreateChangeSet (Maybe ChangeSetType)
createChangeSet_clientToken :: Lens' CreateChangeSet (Maybe Text)
createChangeSet_description :: Lens' CreateChangeSet (Maybe Text)
createChangeSet_includeNestedStacks :: Lens' CreateChangeSet (Maybe Bool)
createChangeSet_notificationARNs :: Lens' CreateChangeSet (Maybe [Text])
createChangeSet_parameters :: Lens' CreateChangeSet (Maybe [Parameter])
createChangeSet_resourceTypes :: Lens' CreateChangeSet (Maybe [Text])
createChangeSet_resourcesToImport :: Lens' CreateChangeSet (Maybe [ResourceToImport])
createChangeSet_roleARN :: Lens' CreateChangeSet (Maybe Text)
createChangeSet_rollbackConfiguration :: Lens' CreateChangeSet (Maybe RollbackConfiguration)
createChangeSet_tags :: Lens' CreateChangeSet (Maybe [Tag])
createChangeSet_templateBody :: Lens' CreateChangeSet (Maybe Text)
createChangeSet_templateURL :: Lens' CreateChangeSet (Maybe Text)
createChangeSet_usePreviousTemplate :: Lens' CreateChangeSet (Maybe Bool)
createChangeSet_stackName :: Lens' CreateChangeSet Text
createChangeSet_changeSetName :: Lens' CreateChangeSet Text
data CreateChangeSetResponse = CreateChangeSetResponse' {
- id :: Maybe Text
- stackId :: Maybe Text
- httpStatus :: Int
}
newCreateChangeSetResponse :: Int -> CreateChangeSetResponse
createChangeSetResponse_id :: Lens' CreateChangeSetResponse (Maybe Text)
createChangeSetResponse_stackId :: Lens' CreateChangeSetResponse (Maybe Text)
createChangeSetResponse_httpStatus :: Lens' CreateChangeSetResponse Int

Creating a Request

data CreateChangeSet Source #

The input for the CreateChangeSet action.

See: newCreateChangeSet smart constructor.

Constructors

CreateChangeSet'

Fields

capabilities :: Maybe [Capability]
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
- CAPABILITY_IAM and CAPABILITY_NAMED_IAM
  Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
  The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
  - If you have IAM resources, you can specify either capability.
  - If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
  - If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
  If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
  For more information, see Acknowledging IAM resources in CloudFormation templates.
- ```
CAPABILITY_AUTO_EXPAND
```
  Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
  This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
  If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
  For more information about macros, see Using CloudFormation macros to perform custom processing on templates.
changeSetType :: Maybe ChangeSetType
The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.
By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
clientToken :: Maybe Text
A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
description :: Maybe Text
A description to help you identify this change set.
includeNestedStacks :: Maybe Bool
Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to False. To include nested sets in a change set, specify True.
notificationARNs :: Maybe [Text]
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
parameters :: Maybe [Parameter]
A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.
resourceTypes :: Maybe [Text]
The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
resourcesToImport :: Maybe [ResourceToImport]
The resources to import into your stack.
roleARN :: Maybe Text
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
rollbackConfiguration :: Maybe RollbackConfiguration
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
tags :: Maybe [Tag]
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.
templateBody :: Maybe Text
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified.
Conditional: You must specify only TemplateBody or TemplateURL.
templateURL :: Maybe Text
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified.
Conditional: You must specify only TemplateBody or TemplateURL.
usePreviousTemplate :: Maybe Bool
Whether to reuse the template that's associated with the stack to create the change set.
stackName :: Text
The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.
changeSetName :: Text
The name of the change set. The name must be unique among all change sets that are associated with the specified stack.
A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters.

Instances

Instances details

ToHeaders CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet Methods toHeaders :: CreateChangeSet -> [Header] #
ToPath CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet Methods toPath :: CreateChangeSet -> ByteString #
ToQuery CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet Methods toQuery :: CreateChangeSet -> QueryString #
AWSRequest CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet Associated Types type AWSResponse CreateChangeSet # Methods request :: (Service -> Service) -> CreateChangeSet -> Request CreateChangeSet # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateChangeSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateChangeSet))) #
Generic CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet Associated Types type Rep CreateChangeSet :: Type -> Type # Methods from :: CreateChangeSet -> Rep CreateChangeSet x # to :: Rep CreateChangeSet x -> CreateChangeSet #
Read CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet Methods readsPrec :: Int -> ReadS CreateChangeSet # readList :: ReadS [CreateChangeSet] # readPrec :: ReadPrec CreateChangeSet # readListPrec :: ReadPrec [CreateChangeSet] #
Show CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet Methods showsPrec :: Int -> CreateChangeSet -> ShowS # show :: CreateChangeSet -> String # showList :: [CreateChangeSet] -> ShowS #
NFData CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet Methods rnf :: CreateChangeSet -> () #
Eq CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet Methods (==) :: CreateChangeSet -> CreateChangeSet -> Bool # (/=) :: CreateChangeSet -> CreateChangeSet -> Bool #
Hashable CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet Methods hashWithSalt :: Int -> CreateChangeSet -> Int # hash :: CreateChangeSet -> Int #
type AWSResponse CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet type AWSResponse CreateChangeSet = CreateChangeSetResponse
type Rep CreateChangeSet Source #
Instance details Defined in Amazonka.CloudFormation.CreateChangeSet type Rep CreateChangeSet = D1 ('MetaData "CreateChangeSet" "Amazonka.CloudFormation.CreateChangeSet" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "CreateChangeSet'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Capability])) :: S1 ('MetaSel ('Just "changeSetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChangeSetType))) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "includeNestedStacks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "notificationARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :: S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: (((S1 ('MetaSel ('Just "resourcesToImport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceToImport])) :: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "rollbackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RollbackConfiguration)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: ((S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "templateURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "usePreviousTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "changeSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCreateChangeSet Source #

Arguments

:: Text	`CreateChangeSet`
-> Text	`CreateChangeSet`
-> CreateChangeSet

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

CreateChangeSet, createChangeSet_capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
- If you have IAM resources, you can specify either capability.
- If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
- If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
```
CAPABILITY_AUTO_EXPAND
```
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information about macros, see Using CloudFormation macros to perform custom processing on templates.

$sel:changeSetType:CreateChangeSet', createChangeSet_changeSetType - The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

$sel:clientToken:CreateChangeSet', createChangeSet_clientToken - A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.

CreateChangeSet, createChangeSet_description - A description to help you identify this change set.

CreateChangeSet, createChangeSet_includeNestedStacks - Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to False. To include nested sets in a change set, specify True.

CreateChangeSet, createChangeSet_notificationARNs - The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

CreateChangeSet, createChangeSet_parameters - A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

$sel:resourceTypes:CreateChangeSet', createChangeSet_resourceTypes - The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.

$sel:resourcesToImport:CreateChangeSet', createChangeSet_resourcesToImport - The resources to import into your stack.

CreateChangeSet, createChangeSet_roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

CreateChangeSet, createChangeSet_rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

CreateChangeSet, createChangeSet_tags - Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

CreateChangeSet, createChangeSet_templateBody - A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

$sel:templateURL:CreateChangeSet', createChangeSet_templateURL - The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

$sel:usePreviousTemplate:CreateChangeSet', createChangeSet_usePreviousTemplate - Whether to reuse the template that's associated with the stack to create the change set.

CreateChangeSet, createChangeSet_stackName - The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

CreateChangeSet, createChangeSet_changeSetName - The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters.

Request Lenses

createChangeSet_capabilities :: Lens' CreateChangeSet (Maybe [Capability]) Source #

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
- If you have IAM resources, you can specify either capability.
- If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
- If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in CloudFormation templates.
```
CAPABILITY_AUTO_EXPAND
```
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information about macros, see Using CloudFormation macros to perform custom processing on templates.

createChangeSet_changeSetType :: Lens' CreateChangeSet (Maybe ChangeSetType) Source #

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

createChangeSet_clientToken :: Lens' CreateChangeSet (Maybe Text) Source #

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

createChangeSet_description :: Lens' CreateChangeSet (Maybe Text) Source #

A description to help you identify this change set.

createChangeSet_includeNestedStacks :: Lens' CreateChangeSet (Maybe Bool) Source #

Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to False. To include nested sets in a change set, specify True.

createChangeSet_notificationARNs :: Lens' CreateChangeSet (Maybe [Text]) Source #

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

createChangeSet_parameters :: Lens' CreateChangeSet (Maybe [Parameter]) Source #

A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

createChangeSet_resourceTypes :: Lens' CreateChangeSet (Maybe [Text]) Source #

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.

createChangeSet_resourcesToImport :: Lens' CreateChangeSet (Maybe [ResourceToImport]) Source #

The resources to import into your stack.

createChangeSet_roleARN :: Lens' CreateChangeSet (Maybe Text) Source #

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

createChangeSet_rollbackConfiguration :: Lens' CreateChangeSet (Maybe RollbackConfiguration) Source #

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

createChangeSet_tags :: Lens' CreateChangeSet (Maybe [Tag]) Source #

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

createChangeSet_templateBody :: Lens' CreateChangeSet (Maybe Text) Source #

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

createChangeSet_templateURL :: Lens' CreateChangeSet (Maybe Text) Source #

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

createChangeSet_usePreviousTemplate :: Lens' CreateChangeSet (Maybe Bool) Source #

Whether to reuse the template that's associated with the stack to create the change set.

createChangeSet_stackName :: Lens' CreateChangeSet Text Source #

The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

createChangeSet_changeSetName :: Lens' CreateChangeSet Text Source #

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters.

Destructuring the Response

data CreateChangeSetResponse Source #

The output for the CreateChangeSet action.

See: newCreateChangeSetResponse smart constructor.

Constructors

CreateChangeSetResponse'
Fields id :: Maybe Text The Amazon Resource Name (ARN) of the change set. stackId :: Maybe Text The unique ID of the stack. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateChangeSetResponse Source #

Arguments

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

Create a value of CreateChangeSetResponse 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:id:CreateChangeSetResponse', createChangeSetResponse_id - The Amazon Resource Name (ARN) of the change set.

CreateChangeSetResponse, createChangeSetResponse_stackId - The unique ID of the stack.

$sel:httpStatus:CreateChangeSetResponse', createChangeSetResponse_httpStatus - The response's http status code.

Response Lenses

createChangeSetResponse_id :: Lens' CreateChangeSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the change set.

createChangeSetResponse_stackId :: Lens' CreateChangeSetResponse (Maybe Text) Source #

The unique ID of the stack.

createChangeSetResponse_httpStatus :: Lens' CreateChangeSetResponse Int Source #

The response's http status code.