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.

CreateStackSetInput

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

type CreateStackSetInput struct { AdministrationRoleARN *string `min:"20" type:"string"` Capabilities []*string `type:"list"` ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` Description *string `min:"1" type:"string"` ExecutionRoleName *string `min:"1" type:"string"` Parameters []*Parameter `type:"list"` StackSetName *string `type:"string" required:"true"` Tags []*Tag `type:"list"` TemplateBody *string `min:"1" type:"string"` TemplateURL *string `min:"1" type:"string"` }

AdministrationRoleARN

Type: *string

The Amazon Resource Number (ARN) of the IAM role to use to create 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 Prerequisites: Granting Permissions for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) in the AWS CloudFormation User Guide.

Capabilities

Type: []*string

In some cases, you must explicity acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related 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 stack 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 create 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.
ClientRequestToken

Type: *string

A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Description

Type: *string

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

ExecutionRoleName

Type: *string

The name of the IAM execution role to use to create 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.

Parameters

The Parameter data type.

StackSetName

Type: *string

The name to associate with the stack set. The name must be unique in the region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

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 either the TemplateBody or the TemplateURL parameter, but not both.

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's 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 either the TemplateBody or the TemplateURL parameter, but not both.

Method

GoString

func (s CreateStackSetInput) GoString() string

GoString returns the string representation

SetAdministrationRoleARN

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

SetAdministrationRoleARN sets the AdministrationRoleARN field's value.

SetCapabilities

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

SetCapabilities sets the Capabilities field's value.

SetClientRequestToken

func (s *CreateStackSetInput) SetClientRequestToken(v string) *CreateStackSetInput

SetClientRequestToken sets the ClientRequestToken field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetExecutionRoleName

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

SetExecutionRoleName sets the ExecutionRoleName field's value.

SetParameters

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

SetParameters sets the Parameters field's value.

SetStackSetName

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

SetStackSetName sets the StackSetName field's value.

SetTags

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

SetTags sets the Tags field's value.

SetTemplateBody

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

SetTemplateBody sets the TemplateBody field's value.

SetTemplateURL

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

SetTemplateURL sets the TemplateURL field's value.

String

func (s CreateStackSetInput) String() string

String returns the string representation

Validate

func (s *CreateStackSetInput) Validate() error

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

On this page: