Menu
AWS CloudFormation
API Reference (API Version 2010-05-15)

CreateStackSet

Creates a stack set.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Capabilities.member.N

A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set 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 their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter:

  • AWS::IAM::AccessKey

  • AWS::IAM::Group

  • AWS::IAM::InstanceProfile

  • AWS::IAM::Policy

  • AWS::IAM::Role

  • AWS::IAM::User

  • AWS::IAM::UserToGroupAddition

If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.

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 this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Type: Array of strings

Valid Values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM

Required: No

ClientRequestToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Required: No

Description

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Parameters.member.N

The input parameters for the stack set template.

Type: Array of Parameter objects

Required: No

StackSetName

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

Note

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.

Type: String

Required: Yes

Tags.member.N

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Type: Array of Tag objects

Array Members: Maximum number of 50 items.

Required: No

TemplateBody

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 in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Type: String

Length Constraints: Minimum length of 1.

Required: No

TemplateURL

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 in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Elements

The following element is returned by the service.

StackSetId

The ID of the stack set that you're creating.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

CreatedButModified

The specified resource exists, but has been changed.

HTTP Status Code: 409

LimitExceeded

The quota for the resource has already been reached.

For information on stack set limitations, see Limitations of StackSets.

HTTP Status Code: 400

NameAlreadyExists

The specified name is already in use.

HTTP Status Code: 409

Example

CreateStackSet

Sample Request


https://cloudformation.us-east-1.amazonaws.com/
 ?Action=CreateStackSet
 &TemplateURL=https://s3.amazonaws.com/cloudformation-stackset-sample-templates-us-east-1/EnableAWSConfig.yml
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &ClientRequestToken=61806005-bde9-46f1-949d-6791example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
         

Sample Response


<CreateStackSetResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <CreateStackSetResult>
    <StackSetId>stack-set-example:22f04391-472b-4e36-b11a-727example</StackSetId>
  </CreateStackSetResult>
  <ResponseMetadata>
    <RequestId>ad9647cb-7949-11e7-ac43-9938example</RequestId>
  </ResponseMetadata>
</CreateStackSetResponse>          
         

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: