Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Class CfnStackSetMixinProps.Builder

java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnStackSetMixinProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStackSetMixinProps>
Enclosing interface:
CfnStackSetMixinProps
@Stability(Stable) public static final class CfnStackSetMixinProps.Builder extends Object implements software.amazon.jsii.Builder<CfnStackSetMixinProps>
A builder for CfnStackSetMixinProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • administrationRoleArn

      @Stability(Stable) public CfnStackSetMixinProps.Builder administrationRoleArn(String administrationRoleArn)
      Sets the value of CfnStackSetMixinProps.getAdministrationRoleArn()
      Parameters:
      administrationRoleArn - The Amazon Resource Number (ARN) of the IAM role to use to create this StackSet. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account.

      Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide .

      Valid only if the permissions model is SELF_MANAGED .

      Returns:
      this

    • administrationRoleArn

      @Stability(Stable) public CfnStackSetMixinProps.Builder administrationRoleArn(IRoleRef administrationRoleArn)
      Sets the value of CfnStackSetMixinProps.getAdministrationRoleArn()
      Parameters:
      administrationRoleArn - The Amazon Resource Number (ARN) of the IAM role to use to create this StackSet. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account.

      Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide .

      Valid only if the permissions model is SELF_MANAGED .

      Returns:
      this

    • autoDeployment

      @Stability(Stable) public CfnStackSetMixinProps.Builder autoDeployment(IResolvable autoDeployment)
      Sets the value of CfnStackSetMixinProps.getAutoDeployment()
      Parameters:
      autoDeployment - Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see Enable or disable automatic deployments for StackSets in AWS Organizations in the CloudFormation User Guide .

      Required if the permissions model is SERVICE_MANAGED . (Not used with self-managed permissions.)

      Returns:
      this

    • autoDeployment

      @Stability(Stable) public CfnStackSetMixinProps.Builder autoDeployment(CfnStackSetPropsMixin.AutoDeploymentProperty autoDeployment)
      Sets the value of CfnStackSetMixinProps.getAutoDeployment()
      Parameters:
      autoDeployment - Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see Enable or disable automatic deployments for StackSets in AWS Organizations in the CloudFormation User Guide .

      Required if the permissions model is SERVICE_MANAGED . (Not used with self-managed permissions.)

      Returns:
      this

    • callAs

      @Stability(Stable) public CfnStackSetMixinProps.Builder callAs(String callAs)
      Sets the value of CfnStackSetMixinProps.getCallAs()
      Parameters:
      callAs - 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 StackSets with self-managed permissions.

      • To create a StackSet with service-managed permissions while signed in to the management account, specify SELF .
      • To create a StackSet 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 CloudFormation User Guide .

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

      Valid only if the permissions model is SERVICE_MANAGED .

      Returns:
      this

    • capabilities

      @Stability(Stable) public CfnStackSetMixinProps.Builder capabilities(List<String> capabilities)
      Sets the value of CfnStackSetMixinProps.getCapabilities()
      Parameters:
      capabilities - The capabilities that are allowed in the StackSet. Some StackSet templates might include resources that can affect permissions in your AWS account —for example, by creating new IAM users. For more information, see Acknowledging IAM resources in CloudFormation templates in the CloudFormation User Guide .
      Returns:
      this

    • description

      @Stability(Stable) public CfnStackSetMixinProps.Builder description(String description)
      Sets the value of CfnStackSetMixinProps.getDescription()
      Parameters:
      description - A description of the StackSet.
      Returns:
      this

    • executionRoleName

      @Stability(Stable) public CfnStackSetMixinProps.Builder executionRoleName(String executionRoleName)
      Sets the value of CfnStackSetMixinProps.getExecutionRoleName()
      Parameters:
      executionRoleName - The name of the IAM execution role to use to create the StackSet. If you don't specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the StackSet operation.

      Valid only if the permissions model is SELF_MANAGED .

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

      Returns:
      this

    • executionRoleName

      @Stability(Stable) public CfnStackSetMixinProps.Builder executionRoleName(IRoleRef executionRoleName)
      Sets the value of CfnStackSetMixinProps.getExecutionRoleName()
      Parameters:
      executionRoleName - The name of the IAM execution role to use to create the StackSet. If you don't specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the StackSet operation.

      Valid only if the permissions model is SELF_MANAGED .

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

      Returns:
      this

    • managedExecution

      @Stability(Stable) public CfnStackSetMixinProps.Builder managedExecution(Object managedExecution)
      Sets the value of CfnStackSetMixinProps.getManagedExecution()
      Parameters:
      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 StackSet's execution configuration while there are running or queued operations for that StackSet.

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

      Returns:
      this

    • operationPreferences

      @Stability(Stable) public CfnStackSetMixinProps.Builder operationPreferences(IResolvable operationPreferences)
      Sets the value of CfnStackSetMixinProps.getOperationPreferences()
      Parameters:
      operationPreferences - The user-specified preferences for how CloudFormation performs a StackSet operation.
      Returns:
      this

    • operationPreferences

      @Stability(Stable) public CfnStackSetMixinProps.Builder operationPreferences(CfnStackSetPropsMixin.OperationPreferencesProperty operationPreferences)
      Sets the value of CfnStackSetMixinProps.getOperationPreferences()
      Parameters:
      operationPreferences - The user-specified preferences for how CloudFormation performs a StackSet operation.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnStackSetMixinProps.Builder parameters(IResolvable parameters)
      Sets the value of CfnStackSetMixinProps.getParameters()
      Parameters:
      parameters - The input parameters for the StackSet template.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnStackSetMixinProps.Builder parameters(List<? extends Object> parameters)
      Sets the value of CfnStackSetMixinProps.getParameters()
      Parameters:
      parameters - The input parameters for the StackSet template.
      Returns:
      this

    • permissionModel

      @Stability(Stable) public CfnStackSetMixinProps.Builder permissionModel(String permissionModel)
      Sets the value of CfnStackSetMixinProps.getPermissionModel()
      Parameters:
      permissionModel - Describes how the IAM roles required for StackSet operations are created.
      • With SELF_MANAGED permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant self-managed permissions in the CloudFormation User Guide .
      • With SERVICE_MANAGED permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see Activate trusted access for StackSets with AWS Organizations in the CloudFormation User Guide .
      Returns:
      this

    • stackInstancesGroup

      @Stability(Stable) public CfnStackSetMixinProps.Builder stackInstancesGroup(IResolvable stackInstancesGroup)
      Sets the value of CfnStackSetMixinProps.getStackInstancesGroup()
      Parameters:
      stackInstancesGroup - A group of stack instances with parameters in some specific accounts and Regions.
      Returns:
      this

    • stackInstancesGroup

      @Stability(Stable) public CfnStackSetMixinProps.Builder stackInstancesGroup(List<? extends Object> stackInstancesGroup)
      Sets the value of CfnStackSetMixinProps.getStackInstancesGroup()
      Parameters:
      stackInstancesGroup - A group of stack instances with parameters in some specific accounts and Regions.
      Returns:
      this

    • stackSetName

      @Stability(Stable) public CfnStackSetMixinProps.Builder stackSetName(String stackSetName)
      Sets the value of CfnStackSetMixinProps.getStackSetName()
      Parameters:
      stackSetName - The name to associate with the StackSet. The name must be unique in the Region where you create your StackSet.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnStackSetMixinProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnStackSetMixinProps.getTags()
      Parameters:
      tags - Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.

      If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

      Returns:
      this

    • templateBody

      @Stability(Stable) public CfnStackSetMixinProps.Builder templateBody(String templateBody)
      Sets the value of CfnStackSetMixinProps.getTemplateBody()
      Parameters:
      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 that contain dynamic references through TemplateUrl instead.
      Returns:
      this

    • templateUrl

      @Stability(Stable) public CfnStackSetMixinProps.Builder templateUrl(String templateUrl)
      Sets the value of CfnStackSetMixinProps.getTemplateUrl()
      Parameters:
      templateUrl - The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https:// .

      Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL .

      Returns:
      this

    • build

      @Stability(Stable) public CfnStackSetMixinProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnStackSetMixinProps>
      Returns:
      a new instance of CfnStackSetMixinProps
      Throws:
      NullPointerException - if any required attribute was not provided