You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudFormation::Types::CreateChangeSetInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

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",
      },
    },
  ],
}

The input for the CreateChangeSet action.

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

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

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    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 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, AWS 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.

    For more information, see Acknowledging IAM Resources in AWS 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 AWS CloudFormation.

    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.

    Also, change sets do not currently support nested stacks. 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 on macros, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

Returns:

  • (Array<String>)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#change_set_nameString

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.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#change_set_typeString

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

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#client_tokenString

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.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#descriptionString

A description to help you identify this change set.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#notification_arnsArray<String>

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.

Returns:

  • (Array<String>)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#parametersArray<Types::Parameter>

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

Returns:



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#resource_typesArray<String>

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.

Returns:

  • (Array<String>)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#resources_to_importArray<Types::ResourceToImport>

The resources to import into your stack.

Returns:



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#role_arnString

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.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#rollback_configurationTypes::RollbackConfiguration

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



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#stack_nameString

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.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#tagsArray<Types::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 50 tags.

Returns:



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#template_bodyString

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.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#template_urlString

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.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end

#use_previous_templateBoolean

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

Returns:

  • (Boolean)


623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 623

class CreateChangeSetInput < Struct.new(
  :stack_name,
  :template_body,
  :template_url,
  :use_previous_template,
  :parameters,
  :capabilities,
  :resource_types,
  :role_arn,
  :rollback_configuration,
  :notification_arns,
  :tags,
  :change_set_name,
  :client_token,
  :description,
  :change_set_type,
  :resources_to_import)
  include Aws::Structure
end