class Aws::CloudFormation::Types::CreateChangeSetInput

The input for the CreateChangeSet action.

@note When making an API call, you may pass CreateChangeSetInput

data as a hash:

    {
      stack_name: "StackNameOrId", # required
      template_body: "TemplateBody",
      template_url: "TemplateURL",
      use_previous_template: false,
      parameters: [
        {
          parameter_key: "ParameterKey",
          parameter_value: "ParameterValue",
          use_previous_value: false,
          resolved_value: "ParameterValue",
        },
      ],
      capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
      resource_types: ["ResourceType"],
      role_arn: "RoleARN",
      rollback_configuration: {
        rollback_triggers: [
          {
            arn: "Arn", # required
            type: "Type", # required
          },
        ],
        monitoring_time_in_minutes: 1,
      },
      notification_arns: ["NotificationARN"],
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
      change_set_name: "ChangeSetName", # required
      client_token: "ClientToken",
      description: "Description",
      change_set_type: "CREATE", # accepts CREATE, UPDATE, IMPORT
      resources_to_import: [
        {
          resource_type: "ResourceType", # required
          logical_resource_id: "LogicalResourceId", # required
          resource_identifier: { # required
            "ResourceIdentifierPropertyKey" => "ResourceIdentifierPropertyValue",
          },
        },
      ],
      include_nested_stacks: false,
    }

@!attribute [rw] stack_name

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.
@return [String]

@!attribute [rw] template_body

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`.
@return [String]

@!attribute [rw] template_url

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`.
@return [String]

@!attribute [rw] use_previous_template

Whether to reuse the template that's associated with the stack to
create the change set.
@return [Boolean]

@!attribute [rw] parameters

A list of `Parameter` structures that specify input parameters for
the change set. For more information, see the Parameter data type.
@return [Array<Types::Parameter>]

@!attribute [rw] 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 recommend that
  you review all permissions associated with them and edit their
  permissions if necessary.

  * [ AWS::IAM::AccessKey][1]

  * [ AWS::IAM::Group][2]

  * [AWS::IAM::InstanceProfile][3]

  * [ AWS::IAM::Policy][4]

  * [ AWS::IAM::Role][5]

  * [ AWS::IAM::User][6]

  * [AWS::IAM::UserToGroupAddition][7]

  For more information, see [Acknowledging IAM resources in
  CloudFormation templates][8].

* `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][9]
  and [AWS::Serverless][10] transforms, which are macros hosted by
  CloudFormation.

  <note markdown="1"> 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.

   </note>

  For more information on macros, see [Using CloudFormation macros
  to perform custom processing on templates][11].

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html
[2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html
[3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
[4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html
[5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
[6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
[7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
[8]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
[9]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
[10]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
[11]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
@return [Array<String>]

@!attribute [rw] resource_types

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][1] in the CloudFormation
User Guide.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
@return [Array<String>]

@!attribute [rw] role_arn

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.
@return [String]

@!attribute [rw] rollback_configuration

The rollback triggers for CloudFormation to monitor during stack
creation and updating operations, and for the specified monitoring
period afterwards.
@return [Types::RollbackConfiguration]

@!attribute [rw] notification_arns

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.
@return [Array<String>]

@!attribute [rw] 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.
@return [Array<Types::Tag>]

@!attribute [rw] change_set_name

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.
@return [String]

@!attribute [rw] client_token

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.
@return [String]

@!attribute [rw] description

A description to help you identify this change set.
@return [String]

@!attribute [rw] change_set_type

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` ][1] 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.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995
@return [String]

@!attribute [rw] resources_to_import

The resources to import into your stack.
@return [Array<Types::ResourceToImport>]

@!attribute [rw] include_nested_stacks

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`.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSetInput AWS API Documentation

Constants

SENSITIVE