software.amazon.awscdk.services.servicecatalog

Interface StackSetsConstraintOptions

All Superinterfaces:

CommonConstraintOptions

All Known Implementing Classes:

StackSetsConstraintOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-07-01T09:58:36.518Z")
public interface StackSetsConstraintOptions
extends CommonConstraintOptions

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

Example:

 import software.amazon.awscdk.services.iam.*;
 Portfolio portfolio;
 CloudFormationProduct product;
 Role adminRole = Role.Builder.create(this, "AdminRole")
         .assumedBy(new AccountRootPrincipal())
         .build();
 portfolio.deployWithStackSets(product, StackSetsConstraintOptions.builder()
         .accounts(List.of("012345678901", "012345678902", "012345678903"))
         .regions(List.of("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)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StackSetsConstraintOptions.Builder A builder for StackSetsConstraintOptions
static class	StackSetsConstraintOptions.Jsii$Proxy An implementation for StackSetsConstraintOptions

Method Summary

Modifier and Type	Method and Description
static StackSetsConstraintOptions.Builder	builder()
java.util.List<java.lang.String>	getAccounts() List of accounts to deploy stacks to.
IRole	getAdminRole() IAM role used to administer the StackSets configuration.
default java.lang.Boolean	getAllowStackSetInstanceOperations() Wether to allow end users to create, update, and delete stacks.
java.lang.String	getExecutionRoleName() IAM role used to provision the products in the Stacks.
java.util.List<java.lang.String>	getRegions() List of regions to deploy stacks to.

Methods inherited from interface software.amazon.awscdk.services.servicecatalog.CommonConstraintOptions

getDescription, getMessageLanguage

Method Detail

getAccounts

java.util.List<java.lang.String> getAccounts()

List of accounts to deploy stacks to.

getAdminRole

IRole getAdminRole()

IAM role used to administer the StackSets configuration.

getExecutionRoleName

java.lang.String getExecutionRoleName()

IAM role used to provision the products in the Stacks.

getRegions

java.util.List<java.lang.String> getRegions()

List of regions to deploy stacks to.

getAllowStackSetInstanceOperations

default java.lang.Boolean getAllowStackSetInstanceOperations()

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

Default: false

builder

static StackSetsConstraintOptions.Builder builder()

Specified by:

builder in interface CommonConstraintOptions

Returns:

a StackSetsConstraintOptions.Builder of StackSetsConstraintOptions