AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CreateChangeSetInput

import "github.com/aws/aws-sdk-go/service/cloudformation"

type CreateChangeSetInput struct { Capabilities []*string `type:"list"` ChangeSetName *string `min:"1" type:"string" required:"true"` ChangeSetType *string `type:"string" enum:"ChangeSetType"` ClientToken *string `min:"1" type:"string"` Description *string `min:"1" type:"string"` NotificationARNs []*string `type:"list"` Parameters []*Parameter `type:"list"` ResourceTypes []*string `type:"list"` RoleARN *string `min:"20" type:"string"` RollbackConfiguration *RollbackConfiguration `type:"structure"` StackName *string `min:"1" type:"string" required:"true"` Tags []*Tag `type:"list"` TemplateBody *string `min:"1" type:"string"` TemplateURL *string `min:"1" type:"string"` UsePreviousTemplate *bool `type:"boolean"` }

The input for the CreateChangeSet action.

Capabilities

Type: []*string

In some cases, you must explicity 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.

AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)

AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)

AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)

AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)

AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)

AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)

AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)

For more information, see Acknowledging IAM Resources in AWS CloudFormation

Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
  • 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 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) 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 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
ChangeSetName

Type: *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 alphabetic character and cannot exceed 128 characters.

ChangeSetName is a required field

ChangeSetType

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.

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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995) 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.

ClientToken

Type: *string

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.

Description

Type: *string

A description to help you identify this change set.

NotificationARNs

Type: []*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.

Parameters

The Parameter data type.

ResourceTypes

Type: []*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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) in the AWS CloudFormation User Guide.

RoleARN

Type: *string

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.

RollbackConfiguration

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

Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html).

StackName

Type: *string

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.

StackName is a required field

Tags

The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.

TemplateBody

Type: *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. 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.

TemplateURL

Type: *string

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.

UsePreviousTemplate

Type: *bool

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

Method

GoString

func (s CreateChangeSetInput) GoString() string

GoString returns the string representation

SetCapabilities

func (s *CreateChangeSetInput) SetCapabilities(v []*string) *CreateChangeSetInput

SetCapabilities sets the Capabilities field's value.

SetChangeSetName

func (s *CreateChangeSetInput) SetChangeSetName(v string) *CreateChangeSetInput

SetChangeSetName sets the ChangeSetName field's value.

SetChangeSetType

func (s *CreateChangeSetInput) SetChangeSetType(v string) *CreateChangeSetInput

SetChangeSetType sets the ChangeSetType field's value.

SetClientToken

func (s *CreateChangeSetInput) SetClientToken(v string) *CreateChangeSetInput

SetClientToken sets the ClientToken field's value.

SetDescription

func (s *CreateChangeSetInput) SetDescription(v string) *CreateChangeSetInput

SetDescription sets the Description field's value.

SetNotificationARNs

func (s *CreateChangeSetInput) SetNotificationARNs(v []*string) *CreateChangeSetInput

SetNotificationARNs sets the NotificationARNs field's value.

SetParameters

func (s *CreateChangeSetInput) SetParameters(v []*Parameter) *CreateChangeSetInput

SetParameters sets the Parameters field's value.

SetResourceTypes

func (s *CreateChangeSetInput) SetResourceTypes(v []*string) *CreateChangeSetInput

SetResourceTypes sets the ResourceTypes field's value.

SetRoleARN

func (s *CreateChangeSetInput) SetRoleARN(v string) *CreateChangeSetInput

SetRoleARN sets the RoleARN field's value.

SetRollbackConfiguration

func (s *CreateChangeSetInput) SetRollbackConfiguration(v *RollbackConfiguration) *CreateChangeSetInput

SetRollbackConfiguration sets the RollbackConfiguration field's value.

SetStackName

func (s *CreateChangeSetInput) SetStackName(v string) *CreateChangeSetInput

SetStackName sets the StackName field's value.

SetTags

func (s *CreateChangeSetInput) SetTags(v []*Tag) *CreateChangeSetInput

SetTags sets the Tags field's value.

SetTemplateBody

func (s *CreateChangeSetInput) SetTemplateBody(v string) *CreateChangeSetInput

SetTemplateBody sets the TemplateBody field's value.

SetTemplateURL

func (s *CreateChangeSetInput) SetTemplateURL(v string) *CreateChangeSetInput

SetTemplateURL sets the TemplateURL field's value.

SetUsePreviousTemplate

func (s *CreateChangeSetInput) SetUsePreviousTemplate(v bool) *CreateChangeSetInput

SetUsePreviousTemplate sets the UsePreviousTemplate field's value.

String

func (s CreateChangeSetInput) String() string

String returns the string representation

Validate

func (s *CreateChangeSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: