aws-cdk-lib.aws_servicecatalog.StackSetsConstraintOptions

interface StackSetsConstraintOptions

LanguageType name
.NETAmazon.CDK.AWS.Servicecatalog.StackSetsConstraintOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsservicecatalog#StackSetsConstraintOptions
Javasoftware.amazon.awscdk.services.servicecatalog.StackSetsConstraintOptions
Pythonaws_cdk.aws_servicecatalog.StackSetsConstraintOptions
TypeScript (source)aws-cdk-lib » aws_servicecatalog » StackSetsConstraintOptions

Properties for deploying with Stackset, which creates a StackSet constraint.

Example

declare const portfolio: servicecatalog.Portfolio;
declare const product: servicecatalog.CloudFormationProduct;

const adminRole = new iam.Role(this, 'AdminRole', {
  assumedBy: new iam.AccountRootPrincipal(),
});

portfolio.deployWithStackSets(product, {
  accounts: ['012345678901', '012345678902', '012345678903'],
  regions: ['us-west-1', 'us-east-1', 'us-west-2', 'us-east-1'],
  adminRole: adminRole,
  executionRoleName: 'SCStackSetExecutionRole', // Name of role deployed in end users accounts.
  allowStackSetInstanceOperations: true,
});

Properties

NameTypeDescription
accountsstring[]List of accounts to deploy stacks to.
adminRoleIRoleIAM role used to administer the StackSets configuration.
executionRoleNamestringIAM role used to provision the products in the Stacks.
regionsstring[]List of regions to deploy stacks to.
allowStackSetInstanceOperations?booleanWether to allow end users to create, update, and delete stacks.
description?stringThe description of the constraint.
messageLanguage?MessageLanguageThe language code.

accounts

Type: string[]

List of accounts to deploy stacks to.


adminRole

Type: IRole

IAM role used to administer the StackSets configuration.


executionRoleName

Type: string

IAM role used to provision the products in the Stacks.


regions

Type: string[]

List of regions to deploy stacks to.


allowStackSetInstanceOperations?

Type: boolean (optional, default: false)

Wether to allow end users to create, update, and delete stacks.


description?

Type: string (optional, default: No description provided)

The description of the constraint.


messageLanguage?

Type: MessageLanguage (optional, default: English)

The language code.

Configures the language for error messages from service catalog.