Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the stack'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 you make a change so that you don't delete or replace 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.
- createChangeSet :: Text -> Text -> CreateChangeSet
- data CreateChangeSet
- ccsUsePreviousTemplate :: Lens' CreateChangeSet (Maybe Bool)
- ccsClientToken :: Lens' CreateChangeSet (Maybe Text)
- ccsNotificationARNs :: Lens' CreateChangeSet [Text]
- ccsParameters :: Lens' CreateChangeSet [Parameter]
- ccsTemplateBody :: Lens' CreateChangeSet (Maybe Text)
- ccsTemplateURL :: Lens' CreateChangeSet (Maybe Text)
- ccsDescription :: Lens' CreateChangeSet (Maybe Text)
- ccsCapabilities :: Lens' CreateChangeSet [Capability]
- ccsResourceTypes :: Lens' CreateChangeSet [Text]
- ccsTags :: Lens' CreateChangeSet [Tag]
- ccsStackName :: Lens' CreateChangeSet Text
- ccsChangeSetName :: Lens' CreateChangeSet Text
- createChangeSetResponse :: Int -> CreateChangeSetResponse
- data CreateChangeSetResponse
- ccsrsId :: Lens' CreateChangeSetResponse (Maybe Text)
- ccsrsResponseStatus :: Lens' CreateChangeSetResponse Int
Creating a Request
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:
data CreateChangeSet Source #
The input for the CreateChangeSet action.
See: createChangeSet
smart constructor.
Request Lenses
ccsUsePreviousTemplate :: Lens' CreateChangeSet (Maybe Bool) Source #
Whether to reuse the template that is associated with the stack to create the change set.
ccsClientToken :: Lens' CreateChangeSet (Maybe Text) Source #
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] Source #
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.
ccsTemplateBody :: 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. 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) Source #
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) Source #
A description to help you identify this change set.
ccsCapabilities :: Lens' CreateChangeSet [Capability] Source #
A list of capabilities 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.
Currently, the only valid value is CAPABILITY_IAM
, which is required
for the following resources:
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 your template contains any of the listed resources and
you don't specify this parameter, this action returns an
InsufficientCapabilities
error.
ccsResourceTypes :: Lens' CreateChangeSet [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, 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] Source #
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.
ccsStackName :: Lens' CreateChangeSet Text Source #
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 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 alphabetic character and cannot exceed 128 characters.
Destructuring the Response
createChangeSetResponse Source #
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:
data CreateChangeSetResponse Source #
The output for the CreateChangeSet action.
See: createChangeSetResponse
smart constructor.
Response Lenses
ccsrsId :: Lens' CreateChangeSetResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the change set.
ccsrsResponseStatus :: Lens' CreateChangeSetResponse Int Source #
The response status code.