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.

CreateStackInput

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

type CreateStackInput struct { Capabilities []*string `type:"list"` ClientRequestToken *string `min:"1" type:"string"` DisableRollback *bool `type:"boolean"` EnableTerminationProtection *bool `type:"boolean"` NotificationARNs []*string `type:"list"` OnFailure *string `type:"string" enum:"OnFailure"` Parameters []*Parameter `type:"list"` ResourceTypes []*string `type:"list"` RoleARN *string `min:"20" type:"string"` RollbackConfiguration *RollbackConfiguration `type:"structure"` StackName *string `type:"string" required:"true"` StackPolicyBody *string `min:"1" type:"string"` StackPolicyURL *string `min:"1" type:"string"` Tags []*Tag `type:"list"` TemplateBody *string `min:"1" type:"string"` TemplateURL *string `min:"1" type:"string"` TimeoutInMinutes *int64 `min:"1" type:"integer"` }

The input for CreateStack 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.

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 the stack directly from the template using this capability.

You should only create stacks directly from a stack template that contains

macros if you know what processing the macro performs.

Each macro relies on an underlying Lambda service function for processing

stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.

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

Type: *string

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

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

DisableRollback

Type: *bool

Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

Default: false

EnableTerminationProtection

Type: *bool

Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default.

For nested stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), termination protection is set on the root stack and cannot be changed directly on the nested stack.

NotificationARNs

Type: []*string

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

OnFailure

Type: *string

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Default: ROLLBACK

Parameters

The Parameter data type.

ResourceTypes

Type: []*string

The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS resource).

If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html).

RoleARN

Type: *string

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always 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 that is associated with the stack. The name must be unique in the region in which you are creating the stack.

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

StackName is a required field

StackPolicyBody

Type: *string

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

StackPolicyURL

Type: *string

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

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

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to 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

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the 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.

TimeoutInMinutes

Type: *int64

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

Method

GoString

func (s CreateStackInput) GoString() string

GoString returns the string representation

SetCapabilities

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

SetCapabilities sets the Capabilities field's value.

SetClientRequestToken

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

SetClientRequestToken sets the ClientRequestToken field's value.

SetDisableRollback

func (s *CreateStackInput) SetDisableRollback(v bool) *CreateStackInput

SetDisableRollback sets the DisableRollback field's value.

SetEnableTerminationProtection

func (s *CreateStackInput) SetEnableTerminationProtection(v bool) *CreateStackInput

SetEnableTerminationProtection sets the EnableTerminationProtection field's value.

SetNotificationARNs

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

SetNotificationARNs sets the NotificationARNs field's value.

SetOnFailure

func (s *CreateStackInput) SetOnFailure(v string) *CreateStackInput

SetOnFailure sets the OnFailure field's value.

SetParameters

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

SetParameters sets the Parameters field's value.

SetResourceTypes

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

SetResourceTypes sets the ResourceTypes field's value.

SetRoleARN

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

SetRoleARN sets the RoleARN field's value.

SetRollbackConfiguration

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

SetRollbackConfiguration sets the RollbackConfiguration field's value.

SetStackName

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

SetStackName sets the StackName field's value.

SetStackPolicyBody

func (s *CreateStackInput) SetStackPolicyBody(v string) *CreateStackInput

SetStackPolicyBody sets the StackPolicyBody field's value.

SetStackPolicyURL

func (s *CreateStackInput) SetStackPolicyURL(v string) *CreateStackInput

SetStackPolicyURL sets the StackPolicyURL field's value.

SetTags

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

SetTags sets the Tags field's value.

SetTemplateBody

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

SetTemplateBody sets the TemplateBody field's value.

SetTemplateURL

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

SetTemplateURL sets the TemplateURL field's value.

SetTimeoutInMinutes

func (s *CreateStackInput) SetTimeoutInMinutes(v int64) *CreateStackInput

SetTimeoutInMinutes sets the TimeoutInMinutes field's value.

String

func (s CreateStackInput) String() string

String returns the string representation

Validate

func (s *CreateStackInput) Validate() error

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

On this page: