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

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

Overview

The input for the CreateChangeSet action.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capabilities ⇒ Array<String>

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

    • 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].

  • ‘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.

    <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 about macros, see [Perform custom processing on CloudFormation templates with template macros].

<note markdown=“1”> Only one of the ‘Capabilities` and `ResourceType` parameters can be specified.

</note>

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

Returns:

  • (Array<String>) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#change_set_name ⇒ String

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.

Returns:

  • (String) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#change_set_type ⇒ String

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.

Returns:

  • (String) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

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.

Returns:

  • (String) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description to help you identify this change set.

Returns:

  • (String) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#import_existing_resources ⇒ Boolean

Indicates if the change set imports resources that already exist.

<note markdown=“1”> This parameter can only import resources that have custom names in templates. For more information, see [name type] in the *CloudFormation User Guide*. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see [Import Amazon Web Services resources into a CloudFormation stack with a resource import] in the *CloudFormation User Guide*.

</note>

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html

Returns:

  • (Boolean) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#include_nested_stacks ⇒ Boolean

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

Returns:

  • (Boolean) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#notification_arns ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#on_stack_failure ⇒ String

Determines what action will be taken if stack creation fails. If this parameter is specified, the ‘DisableRollback` parameter to the

ExecuteChangeSet][1

API operation must not be specified. This must

be one of these values:

  • ‘DELETE` - Deletes the change set if the stack creation fails. This is only valid when the `ChangeSetType` parameter is set to `CREATE`. If the deletion of the stack fails, the status of the stack is `DELETE_FAILED`.

  • ‘DO_NOTHING` - if the stack creation fails, do nothing. This is equivalent to specifying `true` for the `DisableRollback` parameter to the [ExecuteChangeSet] API operation.

  • ‘ROLLBACK` - if the stack creation fails, roll back the stack. This is equivalent to specifying `false` for the `DisableRollback` parameter to the [ExecuteChangeSet] API operation.

For nested stacks, when the ‘OnStackFailure` parameter is set to `DELETE` for the change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to be deleted.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html

Returns:

  • (String) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Array<Types::Parameter>

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

Returns:



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#resource_types ⇒ Array<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, CloudFormation grants permissions to all resource types. IAM uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see [Control access with Identity and Access Management] in the *CloudFormation User Guide*.

<note markdown=“1”> Only one of the ‘Capabilities` and `ResourceType` parameters can be specified.

</note>

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html

Returns:

  • (Array<String>) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#resources_to_import ⇒ Array<Types::ResourceToImport>

The resources to import into your stack.

Returns:



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an 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.

Returns:

  • (String) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#rollback_configuration ⇒ Types::RollbackConfiguration

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

Returns:



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#stack_name ⇒ String

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.

Returns:

  • (String) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::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.

Returns:



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#template_body ⇒ String

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

Returns:

  • (String) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#template_url ⇒ String

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. The location for an Amazon S3 bucket must start with ‘https://`.

Conditional: You must specify only ‘TemplateBody` or `TemplateURL`.

Returns:

  • (String) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end

#use_previous_template ⇒ Boolean

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

Returns:

  • (Boolean) 


1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 1000

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_nested_stacks,
  :on_stack_failure,
  :import_existing_resources)
  SENSITIVE = []
  include Aws::Structure
end