Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

CreateStackSetCommand

Creates a stack set.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CloudFormationClient, CreateStackSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
// const { CloudFormationClient, CreateStackSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
const client = new CloudFormationClient(config);
const input = { // CreateStackSetInput
  StackSetName: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  TemplateBody: "STRING_VALUE",
  TemplateURL: "STRING_VALUE",
  StackId: "STRING_VALUE",
  Parameters: [ // Parameters
    { // Parameter
      ParameterKey: "STRING_VALUE",
      ParameterValue: "STRING_VALUE",
      UsePreviousValue: true || false,
      ResolvedValue: "STRING_VALUE",
    },
  ],
  Capabilities: [ // Capabilities
    "CAPABILITY_IAM" || "CAPABILITY_NAMED_IAM" || "CAPABILITY_AUTO_EXPAND",
  ],
  Tags: [ // Tags
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
  AdministrationRoleARN: "STRING_VALUE",
  ExecutionRoleName: "STRING_VALUE",
  PermissionModel: "SERVICE_MANAGED" || "SELF_MANAGED",
  AutoDeployment: { // AutoDeployment
    Enabled: true || false,
    RetainStacksOnAccountRemoval: true || false,
  },
  CallAs: "SELF" || "DELEGATED_ADMIN",
  ClientRequestToken: "STRING_VALUE",
  ManagedExecution: { // ManagedExecution
    Active: true || false,
  },
};
const command = new CreateStackSetCommand(input);
const response = await client.send(command);
// { // CreateStackSetOutput
//   StackSetId: "STRING_VALUE",
// };

CreateStackSetCommand Input

See CreateStackSetCommandInput for more details

Parameter	Type	Description
`StackSetName` Required	`string \| undefined`	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.
`AdministrationRoleARN`	`string \| undefined`	The Amazon Resource Name (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 Grant self-managed permissions in the CloudFormation User Guide. Valid only if the permissions model is `SELF_MANAGED`.
`AutoDeployment`	`AutoDeployment \| undefined`	Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). For more information, see Manage automatic deployments for CloudFormation StackSets that use service-managed permissions in the CloudFormation User Guide. Required if the permissions model is `SERVICE_MANAGED`. (Not used with self-managed permissions.)
`CallAs`	`CallAs \| undefined`	Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default, `SELF` is specified. Use `SELF` for stack sets with self-managed permissions. To create a stack set with service-managed permissions while signed in to the management account, specify `SELF`. To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify `DELEGATED_ADMIN`. Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide. Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators. Valid only if the permissions model is `SERVICE_MANAGED`.
`Capabilities`	`Capability[] \| undefined`	In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for 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 Amazon Web Services account; for example, by creating new 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, 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 AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM resources in CloudFormation templates . `CAPABILITY_AUTO_EXPAND` Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Perform custom processing on CloudFormation templates with template macros . Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.
`ClientRequestToken`	`string \| undefined`	A unique identifier for this `CreateStackSet` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry `CreateStackSet` requests to ensure that CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically.
`Description`	`string \| undefined`	A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
`ExecutionRoleName`	`string \| undefined`	The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, 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. Valid only if the permissions model is `SELF_MANAGED`.
`ManagedExecution`	`ManagedExecution \| undefined`	Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
`Parameters`	`Parameter[] \| undefined`	The input parameters for the stack set template.
`PermissionModel`	`PermissionModels \| undefined`	Describes how the IAM roles required for stack set operations are created. By default, `SELF-MANAGED` is specified. With `self-managed` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant self-managed permissions . With `service-managed` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for stack sets with Organizations .
`StackId`	`string \| undefined`	The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.
`Tags`	`Tag[] \| undefined`	The key-value pairs to associate with this stack set and the stacks created from it. 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, 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.
`TemplateBody`	`string \| undefined`	The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
`TemplateURL`	`string \| undefined`	The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with `https://`. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

CreateStackSetCommand Output

See CreateStackSetCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`StackSetId`	`string \| undefined`	The ID of the stack set that you're creating.

Throws

Name	Fault	Details
CreatedButModifiedException	client	The specified resource exists, but has been changed.
LimitExceededException	client	The quota for the resource has already been reached. For information about resource and stack limitations, see CloudFormation quotas in the CloudFormation User Guide.
NameAlreadyExistsException	client	The specified name is already in use.
CloudFormationServiceException		Base exception class for all service exceptions from CloudFormation service.

Getting Started

References

CreateStackSetCommand

Example Syntax

CreateStackSetCommand Input

CreateStackSetCommand Output

Throws

Table of Contents

Search