StackSetsConstraintOptions

class aws_cdk.aws_servicecatalog.StackSetsConstraintOptions(*, description=None, message_language=None, accounts, admin_role, execution_role_name, regions, allow_stack_set_instance_operations=None)

Bases: CommonConstraintOptions

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

Parameters:

  • description (Optional[str]) – The description of the constraint. Default: - No description provided

  • message_language (Optional[MessageLanguage]) – The language code. Configures the language for error messages from service catalog. Default: - English

  • accounts (Sequence[str]) – List of accounts to deploy stacks to.

  • admin_role (IRole) – IAM role used to administer the StackSets configuration.

  • execution_role_name (str) – IAM role used to provision the products in the Stacks.

  • regions (Sequence[str]) – List of regions to deploy stacks to.

  • allow_stack_set_instance_operations (Optional[bool]) – Wether to allow end users to create, update, and delete stacks. Default: false

ExampleMetadata:

infused

Example:

import aws_cdk.aws_iam as iam

# portfolio: servicecatalog.Portfolio
# product: servicecatalog.CloudFormationProduct


admin_role = iam.Role(self, "AdminRole",
    assumed_by=iam.AccountRootPrincipal()
)

portfolio.deploy_with_stack_sets(product,
    accounts=["012345678901", "012345678902", "012345678903"],
    regions=["us-west-1", "us-east-1", "us-west-2", "us-east-1"],
    admin_role=admin_role,
    execution_role_name="SCStackSetExecutionRole",  # Name of role deployed in end users accounts.
    allow_stack_set_instance_operations=True
)

Attributes

accounts

List of accounts to deploy stacks to.

admin_role

IAM role used to administer the StackSets configuration.

allow_stack_set_instance_operations

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

Default:

false

description

The description of the constraint.

Default:

  • No description provided

execution_role_name

IAM role used to provision the products in the Stacks.

message_language

The language code.

Configures the language for error messages from service catalog.

Default:

  • English

regions

List of regions to deploy stacks to.