Skip to content
v2.274.0

StackSetsConstraintOptions Struct ​

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

Example ​

ts
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 ​

accountsstring[]accountstyping.List[str]accountsList<String>Accountsstring[]Accounts*[]*stringrequired#
List of accounts to deploy stacks to.
adminRoleIRoleRefadmin_roleIRoleRefadminRoleIRoleRefAdminRoleIRoleRefAdminRoleIRoleRefrequired#
IAM role used to administer the StackSets configuration.
allowStackSetInstanceOperationsoptionalbooleanallow_stack_set_instance_operationsoptionalboolallowStackSetInstanceOperationsoptionalBooleanAllowStackSetInstanceOperationsoptionalboolAllowStackSetInstanceOperationsoptional*bool= false#
Whether to allow end users to create, update, and delete stacks.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the constraint.

Default: No description provided

executionRoleNamestringexecution_role_namestrexecutionRoleNameStringExecutionRoleNamestringExecutionRoleName*stringrequired#
IAM role used to provision the products in the Stacks.
messageLanguageoptionalMessageLanguagemessage_languageoptionalMessageLanguagemessageLanguageoptionalMessageLanguageMessageLanguageoptionalMessageLanguageMessageLanguageoptionalMessageLanguage= English#
The language code.

Configures the language for error messages from service catalog.

regionsstring[]regionstyping.List[str]regionsList<String>Regionsstring[]Regions*[]*stringrequired#
List of regions to deploy stacks to.