Interface StackSetsConstraintOptions

All Superinterfaces:
CommonConstraintOptions, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
StackSetsConstraintOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-17T05:10:18.064Z") @Stability(Stable) public interface StackSetsConstraintOptions extends software.amazon.jsii.JsiiSerializable, CommonConstraintOptions
Properties for deploying with Stackset, which creates a StackSet constraint.

Example:

 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());
 
  • 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