Network.AWS.CloudFormation.CreateChangeSet

Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change, and how it will change them, before you update your stack. Change sets allow you to check before making a change to avoid deleting or replacing critical resources.

AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the ExecuteChangeSet action.

After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the DescribeChangeSet action.

Creating a Request

createChangeSet

Arguments

:: Text

ccsStackName

-> Text

ccsChangeSetName

-> CreateChangeSet

Creates a value of CreateChangeSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ccsChangeSetType - 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 . If you create a change set for a new stack, AWS 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, AWS 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.
• ccsUsePreviousTemplate - Whether to reuse the template that is associated with the stack to create the change set.
• ccsClientToken - A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully received them.
• ccsNotificationARNs - The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
• ccsParameters - A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.
• ccsTemplateBody - 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. AWS 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 .
• ccsTemplateURL - The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified. Conditional: You must specify only TemplateBody or TemplateURL .
• ccsDescription - A description to help you identify this change set.
• ccsCapabilities - A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM . The following resources require you to specify this parameter: AWS::IAM::AccessKey , AWS::IAM::Group , AWS::IAM::InstanceProfile , AWS::IAM::Policy , AWS::IAM::Role , AWS::IAM::User , and AWS::IAM::UserToGroupAddition . If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. 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 this parameter, this action returns an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .
• ccsResourceTypes - 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, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
• ccsTags - Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.
• ccsRoleARN - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
• ccsStackName - The name or the unique ID of the stack for which you are creating a change set. AWS 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.
• ccsChangeSetName - 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 alphabetic character and cannot exceed 128 characters.

data CreateChangeSet

The input for the CreateChangeSet action.

See: createChangeSet smart constructor.

Instances

Eq CreateChangeSet

Methods

(==) :: CreateChangeSet -> CreateChangeSet -> Bool

(/=) :: CreateChangeSet -> CreateChangeSet -> Bool

Data CreateChangeSet

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateChangeSet -> c CreateChangeSet

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateChangeSet

toConstr :: CreateChangeSet -> Constr

dataTypeOf :: CreateChangeSet -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateChangeSet)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateChangeSet)

gmapT :: (forall b. Data b => b -> b) -> CreateChangeSet -> CreateChangeSet

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateChangeSet -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateChangeSet -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateChangeSet -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateChangeSet -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateChangeSet -> m CreateChangeSet

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateChangeSet -> m CreateChangeSet

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateChangeSet -> m CreateChangeSet

Read CreateChangeSet

Methods

readsPrec :: Int -> ReadS CreateChangeSet

readList :: ReadS [CreateChangeSet]

readPrec :: ReadPrec CreateChangeSet

readListPrec :: ReadPrec [CreateChangeSet]

Show CreateChangeSet

Methods

showsPrec :: Int -> CreateChangeSet -> ShowS

show :: CreateChangeSet -> String

showList :: [CreateChangeSet] -> ShowS

Generic CreateChangeSet

Associated Types

type Rep CreateChangeSet :: * -> *

Methods

from :: CreateChangeSet -> Rep CreateChangeSet x

to :: Rep CreateChangeSet x -> CreateChangeSet

Hashable CreateChangeSet

Methods

hashWithSalt :: Int -> CreateChangeSet -> Int

hash :: CreateChangeSet -> Int

NFData CreateChangeSet

Methods

rnf :: CreateChangeSet -> ()

AWSRequest CreateChangeSet

Associated Types

type Rs CreateChangeSet :: *

Methods

request :: CreateChangeSet -> Request CreateChangeSet

response :: MonadResource m => Logger -> Service -> Proxy * CreateChangeSet -> ClientResponse -> m (Response CreateChangeSet)

ToPath CreateChangeSet

Methods

toPath :: CreateChangeSet -> ByteString

ToHeaders CreateChangeSet

Methods

toHeaders :: CreateChangeSet -> [Header]

ToQuery CreateChangeSet

Methods

toQuery :: CreateChangeSet -> QueryString

type Rep CreateChangeSet

type Rep CreateChangeSet = D1 (MetaData "CreateChangeSet" "Network.AWS.CloudFormation.CreateChangeSet" "amazonka-cloudformation-1.4.5-G0stfcEaDzC4JoYZoVvUrE" False) (C1 (MetaCons "CreateChangeSet'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccsChangeSetType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ChangeSetType))) ((:*:) (S1 (MetaSel (Just Symbol "_ccsUsePreviousTemplate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_ccsClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccsNotificationARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_ccsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Parameter])))) ((:*:) (S1 (MetaSel (Just Symbol "_ccsTemplateBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccsTemplateURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ccsCapabilities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Capability]))) (S1 (MetaSel (Just Symbol "_ccsResourceTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) (S1 (MetaSel (Just Symbol "_ccsRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ccsStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ccsChangeSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs CreateChangeSet

type Rs CreateChangeSet = CreateChangeSetResponse

Request Lenses

ccsChangeSetType :: Lens' CreateChangeSet (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 . If you create a change set for a new stack, AWS 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, AWS 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.

ccsUsePreviousTemplate :: Lens' CreateChangeSet (Maybe Bool)

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

ccsClientToken :: Lens' CreateChangeSet (Maybe Text)

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

ccsNotificationARNs :: Lens' CreateChangeSet [Text]

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

ccsParameters :: Lens' CreateChangeSet [Parameter]

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

ccsTemplateBody :: Lens' CreateChangeSet (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. AWS 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 .

ccsTemplateURL :: Lens' CreateChangeSet (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 is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified. Conditional: You must specify only TemplateBody or TemplateURL .

ccsDescription :: Lens' CreateChangeSet (Maybe Text)

A description to help you identify this change set.

ccsCapabilities :: Lens' CreateChangeSet [Capability]

A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM . The following resources require you to specify this parameter: AWS::IAM::AccessKey , AWS::IAM::Group , AWS::IAM::InstanceProfile , AWS::IAM::Policy , AWS::IAM::Role , AWS::IAM::User , and AWS::IAM::UserToGroupAddition . If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. 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 this parameter, this action returns an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

ccsResourceTypes :: Lens' CreateChangeSet [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, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

ccsTags :: Lens' CreateChangeSet [Tag]

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

ccsRoleARN :: Lens' CreateChangeSet (Maybe Text)

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

ccsStackName :: Lens' CreateChangeSet Text

The name or the unique ID of the stack for which you are creating a change set. AWS 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.

ccsChangeSetName :: Lens' CreateChangeSet 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 alphabetic character and cannot exceed 128 characters.

Destructuring the Response

createChangeSetResponse

Arguments

:: Int

ccsrsResponseStatus

-> CreateChangeSetResponse

Creates a value of CreateChangeSetResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ccsrsId - The Amazon Resource Name (ARN) of the change set.
• ccsrsStackId - The unique ID of the stack.
• ccsrsResponseStatus - -- | The response status code.

data CreateChangeSetResponse

The output for the CreateChangeSet action.

See: createChangeSetResponse smart constructor.

Instances

Eq CreateChangeSetResponse

Methods

(==) :: CreateChangeSetResponse -> CreateChangeSetResponse -> Bool

(/=) :: CreateChangeSetResponse -> CreateChangeSetResponse -> Bool

Data CreateChangeSetResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateChangeSetResponse -> c CreateChangeSetResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateChangeSetResponse

toConstr :: CreateChangeSetResponse -> Constr

dataTypeOf :: CreateChangeSetResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateChangeSetResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateChangeSetResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateChangeSetResponse -> CreateChangeSetResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateChangeSetResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateChangeSetResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateChangeSetResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateChangeSetResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateChangeSetResponse -> m CreateChangeSetResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateChangeSetResponse -> m CreateChangeSetResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateChangeSetResponse -> m CreateChangeSetResponse

Read CreateChangeSetResponse

Methods

readsPrec :: Int -> ReadS CreateChangeSetResponse

readList :: ReadS [CreateChangeSetResponse]

readPrec :: ReadPrec CreateChangeSetResponse

readListPrec :: ReadPrec [CreateChangeSetResponse]

Show CreateChangeSetResponse

Methods

showsPrec :: Int -> CreateChangeSetResponse -> ShowS

show :: CreateChangeSetResponse -> String

showList :: [CreateChangeSetResponse] -> ShowS

Generic CreateChangeSetResponse

Associated Types

type Rep CreateChangeSetResponse :: * -> *

Methods

from :: CreateChangeSetResponse -> Rep CreateChangeSetResponse x

to :: Rep CreateChangeSetResponse x -> CreateChangeSetResponse

NFData CreateChangeSetResponse

Methods

rnf :: CreateChangeSetResponse -> ()

type Rep CreateChangeSetResponse

type Rep CreateChangeSetResponse = D1 (MetaData "CreateChangeSetResponse" "Network.AWS.CloudFormation.CreateChangeSet" "amazonka-cloudformation-1.4.5-G0stfcEaDzC4JoYZoVvUrE" False) (C1 (MetaCons "CreateChangeSetResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ccsrsId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ccsrsStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

ccsrsId :: Lens' CreateChangeSetResponse (Maybe Text)

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

ccsrsStackId :: Lens' CreateChangeSetResponse (Maybe Text)

The unique ID of the stack.

ccsrsResponseStatus :: Lens' CreateChangeSetResponse Int

• - | The response status code.