interface StackSetsConstraintOptions
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.ServiceCatalog.StackSetsConstraintOptions |
Java | software.amazon.awscdk.services.servicecatalog.StackSetsConstraintOptions |
Python | aws_cdk.aws_servicecatalog.StackSetsConstraintOptions |
TypeScript (source) | @aws-cdk/aws-servicecatalog » StackSetsConstraintOptions |
Properties for deploying with Stackset, which creates a StackSet constraint.
Example
import * as iam from '@aws-cdk/aws-iam';
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
Name | Type | Description |
---|---|---|
accounts | string[] | List of accounts to deploy stacks to. |
admin | IRole | IAM role used to administer the StackSets configuration. |
execution | string | IAM role used to provision the products in the Stacks. |
regions | string[] | List of regions to deploy stacks to. |
allow | boolean | Wether to allow end users to create, update, and delete stacks. |
description? | string | The description of the constraint. |
message | Message | The 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:
Message
(optional, default: English)
The language code.
Configures the language for error messages from service catalog.