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.

UpdateStackSetInput

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

type UpdateStackSetInput struct { Accounts []*string `type:"list"` AdministrationRoleARN *string `min:"20" type:"string"` Capabilities []*string `type:"list"` Description *string `min:"1" type:"string"` ExecutionRoleName *string `min:"1" type:"string"` OperationId *string `min:"1" type:"string" idempotencyToken:"true"` OperationPreferences *StackSetOperationPreferences `type:"structure"` Parameters []*Parameter `type:"list"` Regions []*string `type:"list"` StackSetName *string `type:"string" required:"true"` Tags []*Tag `type:"list"` TemplateBody *string `min:"1" type:"string"` TemplateURL *string `min:"1" type:"string"` UsePreviousTemplate *bool `type:"boolean"` }

Accounts

Type: []*string

The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.

AdministrationRoleARN

Type: *string

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) in the AWS CloudFormation User Guide.

If you specify a customized administrator role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized administrator role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

Capabilities

Type: []*string

In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

  • 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 sets, 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 templates contain macros. If your stack template contains one or more

macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).

Stack sets do not currently support macros in stack templates. (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.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
Description

Type: *string

A brief description of updates that you are making.

ExecutionRoleName

Type: *string

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

OperationId

Type: *string

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

OperationPreferences

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).

Parameters

The Parameter data type.

Regions

Type: []*string

The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.

StackSetName

Type: *string

The name or unique ID of the stack set that you want to update.

StackSetName 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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

TemplateURL

Type: *string

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

UsePreviousTemplate

Type: *bool

Use the existing template that's associated with the stack set that you're updating.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

Method

GoString

func (s UpdateStackSetInput) GoString() string

GoString returns the string representation

SetAccounts

func (s *UpdateStackSetInput) SetAccounts(v []*string) *UpdateStackSetInput

SetAccounts sets the Accounts field's value.

SetAdministrationRoleARN

func (s *UpdateStackSetInput) SetAdministrationRoleARN(v string) *UpdateStackSetInput

SetAdministrationRoleARN sets the AdministrationRoleARN field's value.

SetCapabilities

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

SetCapabilities sets the Capabilities field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetExecutionRoleName

func (s *UpdateStackSetInput) SetExecutionRoleName(v string) *UpdateStackSetInput

SetExecutionRoleName sets the ExecutionRoleName field's value.

SetOperationId

func (s *UpdateStackSetInput) SetOperationId(v string) *UpdateStackSetInput

SetOperationId sets the OperationId field's value.

SetOperationPreferences

func (s *UpdateStackSetInput) SetOperationPreferences(v *StackSetOperationPreferences) *UpdateStackSetInput

SetOperationPreferences sets the OperationPreferences field's value.

SetParameters

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

SetParameters sets the Parameters field's value.

SetRegions

func (s *UpdateStackSetInput) SetRegions(v []*string) *UpdateStackSetInput

SetRegions sets the Regions field's value.

SetStackSetName

func (s *UpdateStackSetInput) SetStackSetName(v string) *UpdateStackSetInput

SetStackSetName sets the StackSetName field's value.

SetTags

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

SetTags sets the Tags field's value.

SetTemplateBody

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

SetTemplateBody sets the TemplateBody field's value.

SetTemplateURL

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

SetTemplateURL sets the TemplateURL field's value.

SetUsePreviousTemplate

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

SetUsePreviousTemplate sets the UsePreviousTemplate field's value.

String

func (s UpdateStackSetInput) String() string

String returns the string representation

Validate

func (s *UpdateStackSetInput) Validate() error

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

On this page: