interface CfnStackSetProps

Language	Type name
.NET	`Amazon.CDK.AWS.CloudFormation.CfnStackSetProps`
Java	`software.amazon.awscdk.services.cloudformation.CfnStackSetProps`
Python	`aws_cdk.aws_cloudformation.CfnStackSetProps`
TypeScript	`@aws-cdk/aws-cloudformation` » `CfnStackSetProps`

Properties for defining a CfnStackSet.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloudformation from '@aws-cdk/aws-cloudformation';

declare const managedExecution: any;
const cfnStackSetProps: cloudformation.CfnStackSetProps = {
  permissionModel: 'permissionModel',
  stackSetName: 'stackSetName',

  // the properties below are optional
  administrationRoleArn: 'administrationRoleArn',
  autoDeployment: {
    enabled: false,
    retainStacksOnAccountRemoval: false,
  },
  callAs: 'callAs',
  capabilities: ['capabilities'],
  description: 'description',
  executionRoleName: 'executionRoleName',
  managedExecution: managedExecution,
  operationPreferences: {
    failureToleranceCount: 123,
    failureTolerancePercentage: 123,
    maxConcurrentCount: 123,
    maxConcurrentPercentage: 123,
    regionConcurrencyType: 'regionConcurrencyType',
    regionOrder: ['regionOrder'],
  },
  parameters: [{
    parameterKey: 'parameterKey',
    parameterValue: 'parameterValue',
  }],
  stackInstancesGroup: [{
    deploymentTargets: {
      accountFilterType: 'accountFilterType',
      accounts: ['accounts'],
      organizationalUnitIds: ['organizationalUnitIds'],
    },
    regions: ['regions'],

    // the properties below are optional
    parameterOverrides: [{
      parameterKey: 'parameterKey',
      parameterValue: 'parameterValue',
    }],
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  templateBody: 'templateBody',
  templateUrl: 'templateUrl',
};

Properties

Name	Type	Description
permissionModel	`string`	Describes how the IAM roles required for stack set operations are created.
stackSetName	`string`	The name to associate with the stack set.
administrationRoleArn?	`string`	The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
autoDeployment?	`IResolvable` `\|` `AutoDeploymentProperty`	[ `Service-managed` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
callAs?	`string`	[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
capabilities?	`string[]`	The capabilities that are allowed in the stack set.
description?	`string`	A description of the stack set.
executionRoleName?	`string`	The name of the IAM execution role to use to create the stack set.
managedExecution?	`any`	Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
operationPreferences?	`IResolvable` `\|` `OperationPreferencesProperty`	The user-specified preferences for how AWS CloudFormation performs a stack set operation.
parameters?	`IResolvable` `\|` `IResolvable` `\|` `ParameterProperty[]`	The input parameters for the stack set template.
stackInstancesGroup?	`IResolvable` `\|` `IResolvable` `\|` `StackInstancesProperty[]`	A group of stack instances with parameters in some specific accounts and Regions.
tags?	`CfnTag[]`	The key-value pairs to associate with this stack set and the stacks created from it.
templateBody?	`string`	The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
templateUrl?	`string`	Location of file containing the template body.

permissionModel

Type: string

Describes how the IAM roles required for stack set operations are created.

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 Stack Set Permissions .
With SERVICE_MANAGED permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see Grant Service-Managed Stack Set Permissions .

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.

Maximum : 128

Pattern : ^[a-zA-Z][a-zA-Z0-9-]{0,127}$

The StackSetName property is required.

administrationRoleArn?

Type: string (optional)

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.

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

Minimum : 20

Maximum : 2048

autoDeployment?

Type: IResolvable | AutoDeploymentProperty (optional)

[ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

callAs?

Type: string (optional)

[Service-managed permissions] 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 AWS account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the AWS 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 Values : SELF | DELEGATED_ADMIN

capabilities?

Type: string[] (optional)

The capabilities that are allowed in the stack set.

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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

description?

Type: string (optional)

A description of the stack set.

Minimum : 1

Maximum : 1024

executionRoleName?

Type: string (optional)

The name of the IAM execution role to use to create the stack set.

If you don't specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Minimum : 1

Maximum : 64

Pattern : [a-zA-Z_0-9+=,.@-]+

managedExecution?

Type: any (optional)

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

When inactive (default), StackSets performs one operation at a time in request order.

operationPreferences?

Type: IResolvable | OperationPreferencesProperty (optional)

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

parameters?

Type: IResolvable | IResolvable | ParameterProperty[] (optional)

The input parameters for the stack set template.

stackInstancesGroup?

Type: IResolvable | IResolvable | StackInstancesProperty[] (optional)

A group of stack instances with parameters in some specific accounts and Regions.

tags?

Type: CfnTag[] (optional)

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.

templateBody?

Type: string (optional)

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

You must include either TemplateURL or TemplateBody in a StackSet, but you can't use both. Dynamic references in the TemplateBody may not work correctly in all cases. It's recommended to pass templates containing dynamic references through TemplateUrl instead.

Minimum : 1

Maximum : 51200

templateUrl?

Type: string (optional)

Location of file containing the template body.

The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket.

You must include either TemplateURL or TemplateBody in a StackSet, but you can't use both.

Minimum : 1

Maximum : 1024