Package software.amazon.awscdk.core

Class CfnStackSet.Builder

java.lang.Object
software.amazon.awscdk.core.CfnStackSet.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStackSet>
Enclosing class:
CfnStackSet
@Stability(Stable) public static final class CfnStackSet.Builder extends Object implements software.amazon.jsii.Builder<CfnStackSet>
A fluent builder for CfnStackSet.

  • Method Details

    • create

      @Stability(Stable) public static CfnStackSet.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnStackSet.Builder.

    • permissionModel

      @Stability(Stable) public CfnStackSet.Builder permissionModel(String permissionModel)
      Describes how the IAM roles required for stack set operations are created.

      Parameters:
      permissionModel - Describes how the IAM roles required for stack set operations are created. This parameter is required.
      Returns:
      this

    • stackSetName

      @Stability(Stable) public CfnStackSet.Builder stackSetName(String stackSetName)
      The name to associate with the stack set.

      The name must be unique in the Region where you create your stack set.

      Maximum : 128

      Pattern : ^[a-zA-Z][a-zA-Z0-9-]{0,127}$

      The StackSetName property is required.

      Parameters:
      stackSetName - The name to associate with the stack set. This parameter is required.
      Returns:
      this

    • administrationRoleArn

      @Stability(Stable) public CfnStackSet.Builder administrationRoleArn(String administrationRoleArn)
      The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.

      Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.

      Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide .

      Minimum : 20

      Maximum : 2048

      Parameters:
      administrationRoleArn - The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. This parameter is required.
      Returns:
      this

    • autoDeployment

      @Stability(Stable) public CfnStackSet.Builder autoDeployment(IResolvable autoDeployment)
      [ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

      Parameters:
      autoDeployment - [ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). This parameter is required.
      Returns:
      this

    • autoDeployment

      @Stability(Stable) public CfnStackSet.Builder autoDeployment(CfnStackSet.AutoDeploymentProperty autoDeployment)
      [ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

      Parameters:
      autoDeployment - [ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). This parameter is required.
      Returns:
      this

    • callAs

      @Stability(Stable) public CfnStackSet.Builder callAs(String callAs)
      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • To create a stack set with service-managed permissions while signed in to the management account, specify SELF .
      • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN .

      Your AWS account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .

      Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

      Valid Values : SELF | DELEGATED_ADMIN

      Parameters:
      callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. This parameter is required.
      Returns:
      this

    • capabilities

      @Stability(Stable) public CfnStackSet.Builder capabilities(List<String> capabilities)
      The capabilities that are allowed in the stack set.

      Some stack set templates might include resources that can affect permissions in your AWS account —for example, by creating new AWS Identity and Access Management ( IAM ) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

      Parameters:
      capabilities - The capabilities that are allowed in the stack set. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnStackSet.Builder description(String description)
      A description of the stack set.

      Minimum : 1

      Maximum : 1024

      Parameters:
      description - A description of the stack set. This parameter is required.
      Returns:
      this

    • executionRoleName

      @Stability(Stable) public CfnStackSet.Builder executionRoleName(String executionRoleName)
      The name of the IAM execution role to use to create the stack set.

      If you don't specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

      Minimum : 1

      Maximum : 64

      Pattern : [a-zA-Z_0-9+=,.@-]+

      Parameters:
      executionRoleName - The name of the IAM execution role to use to create the stack set. This parameter is required.
      Returns:
      this

    • managedExecution

      @Stability(Stable) public CfnStackSet.Builder managedExecution(Object managedExecution)
      Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

      When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

      If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.

      You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.

      When inactive (default), StackSets performs one operation at a time in request order.

      Parameters:
      managedExecution - Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations. This parameter is required.
      Returns:
      this

    • operationPreferences

      @Stability(Stable) public CfnStackSet.Builder operationPreferences(IResolvable operationPreferences)
      The user-specified preferences for how AWS CloudFormation performs a stack set operation.

      Parameters:
      operationPreferences - The user-specified preferences for how AWS CloudFormation performs a stack set operation. This parameter is required.
      Returns:
      this

    • operationPreferences

      @Stability(Stable) public CfnStackSet.Builder operationPreferences(CfnStackSet.OperationPreferencesProperty operationPreferences)
      The user-specified preferences for how AWS CloudFormation performs a stack set operation.

      Parameters:
      operationPreferences - The user-specified preferences for how AWS CloudFormation performs a stack set operation. This parameter is required.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnStackSet.Builder parameters(IResolvable parameters)
      The input parameters for the stack set template.

      Parameters:
      parameters - The input parameters for the stack set template. This parameter is required.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnStackSet.Builder parameters(List<? extends Object> parameters)
      The input parameters for the stack set template.

      Parameters:
      parameters - The input parameters for the stack set template. This parameter is required.
      Returns:
      this

    • stackInstancesGroup

      @Stability(Stable) public CfnStackSet.Builder stackInstancesGroup(IResolvable stackInstancesGroup)
      A group of stack instances with parameters in some specific accounts and Regions.

      Parameters:
      stackInstancesGroup - A group of stack instances with parameters in some specific accounts and Regions. This parameter is required.
      Returns:
      this

    • stackInstancesGroup

      @Stability(Stable) public CfnStackSet.Builder stackInstancesGroup(List<? extends Object> stackInstancesGroup)
      A group of stack instances with parameters in some specific accounts and Regions.

      Parameters:
      stackInstancesGroup - A group of stack instances with parameters in some specific accounts and Regions. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnStackSet.Builder tags(List<? extends CfnTag> tags)
      The key-value pairs to associate with this stack set and the stacks created from it.

      AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

      Parameters:
      tags - The key-value pairs to associate with this stack set and the stacks created from it. This parameter is required.
      Returns:
      this

    • templateBody

      @Stability(Stable) public CfnStackSet.Builder templateBody(String templateBody)
      The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

      You must include either TemplateURL or TemplateBody in a StackSet, but you can't use both. Dynamic references in the TemplateBody may not work correctly in all cases. It's recommended to pass templates containing dynamic references through TemplateUrl instead.

      Minimum : 1

      Maximum : 51200

      Parameters:
      templateBody - The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. This parameter is required.
      Returns:
      this

    • templateUrl

      @Stability(Stable) public CfnStackSet.Builder templateUrl(String templateUrl)
      Location of file containing the template body.

      The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket.

      You must include either TemplateURL or TemplateBody in a StackSet, but you can't use both.

      Minimum : 1

      Maximum : 1024

      Parameters:
      templateUrl - Location of file containing the template body. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnStackSet build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnStackSet>
      Returns:
      a newly built instance of CfnStackSet.