Package software.amazon.awscdk.services.servicecatalog

Interface StackSetsConstraintOptions

All Superinterfaces:

CommonConstraintOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StackSetsConstraintOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:39.821Z")
@Stability(Stable)
public interface StackSetsConstraintOptions
extends software.amazon.jsii.JsiiSerializable, 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	Description
static final class	StackSetsConstraintOptions.Builder	A builder for StackSetsConstraintOptions
static final class	StackSetsConstraintOptions.Jsii$Proxy	An implementation for StackSetsConstraintOptions

Method Summary

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

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

getDescription, getMessageLanguage

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccounts

@Stability(Stable)
@NotNull
List<String> getAccounts()

List of accounts to deploy stacks to.

getAdminRole

@Stability(Stable)
@NotNull
IRole getAdminRole()

IAM role used to administer the StackSets configuration.

getExecutionRoleName

@Stability(Stable)
@NotNull
String getExecutionRoleName()

IAM role used to provision the products in the Stacks.

getRegions

@Stability(Stable)
@NotNull
List<String> getRegions()

List of regions to deploy stacks to.

getAllowStackSetInstanceOperations

@Stability(Stable)
@Nullable
default Boolean getAllowStackSetInstanceOperations()

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

Default: false

builder

@Stability(Stable)
static StackSetsConstraintOptions.Builder builder()

Returns:

a StackSetsConstraintOptions.Builder of StackSetsConstraintOptions