Package software.amazon.awssdk.services.cloudformation.model

Interface StackSet.Builder

All Superinterfaces:
Buildable, CopyableBuilder<StackSet.Builder,StackSet>, SdkBuilder<StackSet.Builder,StackSet>, SdkPojo
Enclosing class:
StackSet
public static interface StackSet.Builder extends SdkPojo, CopyableBuilder<StackSet.Builder,StackSet>

  • Method Details

    • stackSetName

      StackSet.Builder stackSetName(String stackSetName)

      The name that's associated with the stack set.

      Parameters:
      stackSetName - The name that's associated with the stack set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackSetId

      StackSet.Builder stackSetId(String stackSetId)

      The ID of the stack set.

      Parameters:
      stackSetId - The ID of the stack set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      StackSet.Builder description(String description)

      A description of the stack set that you specify when the stack set is created or updated.

      Parameters:
      description - A description of the stack set that you specify when the stack set is created or updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      StackSet.Builder status(String status)

      The status of the stack set.

      Parameters:
      status - The status of the stack set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      StackSet.Builder status(StackSetStatus status)

      The status of the stack set.

      Parameters:
      status - The status of the stack set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • templateBody

      StackSet.Builder templateBody(String templateBody)

      The structure that contains the body of the template that was used to create or update the stack set.

      Parameters:
      templateBody - The structure that contains the body of the template that was used to create or update the stack set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      StackSet.Builder parameters(Collection<Parameter> parameters)

      A list of input parameters for a stack set.

      Parameters:
      parameters - A list of input parameters for a stack set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      StackSet.Builder parameters(Parameter... parameters)

      A list of input parameters for a stack set.

      Parameters:
      parameters - A list of input parameters for a stack set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      StackSet.Builder parameters(Consumer<Parameter.Builder>... parameters)

      A list of input parameters for a stack set.

      This is a convenience method that creates an instance of the Parameter.Builder avoiding the need to create one manually via Parameter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameters(List<Parameter>).

      Parameters:
      parameters - a consumer that will call methods on Parameter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capabilitiesWithStrings

      StackSet.Builder capabilitiesWithStrings(Collection<String> capabilities)

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

      Parameters:
      capabilities - The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilitiesWithStrings

      StackSet.Builder capabilitiesWithStrings(String... capabilities)

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

      Parameters:
      capabilities - The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      StackSet.Builder capabilities(Collection<Capability> capabilities)

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

      Parameters:
      capabilities - The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      StackSet.Builder capabilities(Capability... capabilities)

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

      Parameters:
      capabilities - The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      StackSet.Builder tags(Collection<Tag> tags)

      A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

      Parameters:
      tags - A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      StackSet.Builder tags(Tag... tags)

      A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

      Parameters:
      tags - A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      StackSet.Builder tags(Consumer<Tag.Builder>... tags)

      A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stackSetARN

      StackSet.Builder stackSetARN(String stackSetARN)

      The Amazon Resource Name (ARN) of the stack set.

      Parameters:
      stackSetARN - The Amazon Resource Name (ARN) of the stack set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • administrationRoleARN

      StackSet.Builder administrationRoleARN(String administrationRoleARN)

      The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

      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 CloudFormation User Guide.

      Parameters:
      administrationRoleARN - The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

      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 CloudFormation User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRoleName

      StackSet.Builder executionRoleName(String executionRoleName)

      The name of the IAM execution role used to create or update the stack set.

      Use customized execution roles to control which stack resources users and groups can include in their stack sets.

      Parameters:
      executionRoleName - The name of the IAM execution role used to create or update the stack set.

      Use customized execution roles to control which stack resources users and groups can include in their stack sets.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackSetDriftDetectionDetails

      StackSet.Builder stackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails)

      Detailed information about the drift status of the stack set.

      For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress isn't included.

      Parameters:
      stackSetDriftDetectionDetails - Detailed information about the drift status of the stack set.

      For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress isn't included.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackSetDriftDetectionDetails

      default StackSet.Builder stackSetDriftDetectionDetails(Consumer<StackSetDriftDetectionDetails.Builder> stackSetDriftDetectionDetails)

      Detailed information about the drift status of the stack set.

      For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress isn't included.

      This is a convenience method that creates an instance of the StackSetDriftDetectionDetails.Builder avoiding the need to create one manually via StackSetDriftDetectionDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stackSetDriftDetectionDetails(StackSetDriftDetectionDetails).

      Parameters:
      stackSetDriftDetectionDetails - a consumer that will call methods on StackSetDriftDetectionDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoDeployment

      StackSet.Builder autoDeployment(AutoDeployment autoDeployment)

      [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

      Parameters:
      autoDeployment - [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoDeployment

      default StackSet.Builder autoDeployment(Consumer<AutoDeployment.Builder> autoDeployment)

      [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

      This is a convenience method that creates an instance of the AutoDeployment.Builder avoiding the need to create one manually via AutoDeployment.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoDeployment(AutoDeployment).

      Parameters:
      autoDeployment - a consumer that will call methods on AutoDeployment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • permissionModel

      StackSet.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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • permissionModel

      StackSet.Builder permissionModel(PermissionModels 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • organizationalUnitIds

      StackSet.Builder organizationalUnitIds(Collection<String> organizationalUnitIds)

      [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

      Parameters:
      organizationalUnitIds - [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationalUnitIds

      StackSet.Builder organizationalUnitIds(String... organizationalUnitIds)

      [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

      Parameters:
      organizationalUnitIds - [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • managedExecution

      StackSet.Builder managedExecution(ManagedExecution managedExecution)

      Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

      Parameters:
      managedExecution - Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • managedExecution

      default StackSet.Builder managedExecution(Consumer<ManagedExecution.Builder> managedExecution)

      Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

      This is a convenience method that creates an instance of the ManagedExecution.Builder avoiding the need to create one manually via ManagedExecution.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to managedExecution(ManagedExecution).

      Parameters:
      managedExecution - a consumer that will call methods on ManagedExecution.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • regions

      StackSet.Builder regions(Collection<String> regions)

      Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.

      Parameters:
      regions - Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      StackSet.Builder regions(String... regions)

      Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.

      Parameters:
      regions - Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.
      Returns:
      Returns a reference to this object so that method calls can be chained together.