StackSet.Builder (AWS Java SDK :: Services :: AWS CloudFormation 2.17.69 API)

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 Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`StackSet.Builder`	`administrationRoleARN(String administrationRoleARN)` The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
`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).
`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).
`StackSet.Builder`	`capabilities(Capability... capabilities)` The capabilities that are allowed in the stack set.
`StackSet.Builder`	`capabilities(Collection<Capability> capabilities)` The capabilities that are allowed in the stack set.
`StackSet.Builder`	`capabilitiesWithStrings(Collection<String> capabilities)` The capabilities that are allowed in the stack set.
`StackSet.Builder`	`capabilitiesWithStrings(String... capabilities)` The capabilities that are allowed in the stack set.
`StackSet.Builder`	`description(String description)` A description of the stack set that you specify when the stack set is created or updated.
`StackSet.Builder`	`executionRoleName(String executionRoleName)` The name of the IAM execution role used to create or update the stack set.
`StackSet.Builder`	`organizationalUnitIds(Collection<String> organizationalUnitIds)` [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
`StackSet.Builder`	`organizationalUnitIds(String... organizationalUnitIds)` [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
`StackSet.Builder`	`parameters(Collection<Parameter> parameters)` A list of input parameters for a stack set.
`StackSet.Builder`	`parameters(Consumer<Parameter.Builder>... parameters)` A list of input parameters for a stack set.
`StackSet.Builder`	`parameters(Parameter... parameters)` A list of input parameters for a stack set.
`StackSet.Builder`	`permissionModel(PermissionModels permissionModel)` Describes how the IAM roles required for stack set operations are created.
`StackSet.Builder`	`permissionModel(String permissionModel)` Describes how the IAM roles required for stack set operations are created.
`StackSet.Builder`	`stackSetARN(String stackSetARN)` The Amazon Resource Number (ARN) of the stack set.
`default StackSet.Builder`	`stackSetDriftDetectionDetails(Consumer<StackSetDriftDetectionDetails.Builder> stackSetDriftDetectionDetails)` Detailed information about the drift status of the stack set.
`StackSet.Builder`	`stackSetDriftDetectionDetails(StackSetDriftDetectionDetails stackSetDriftDetectionDetails)` Detailed information about the drift status of the stack set.
`StackSet.Builder`	`stackSetId(String stackSetId)` The ID of the stack set.
`StackSet.Builder`	`stackSetName(String stackSetName)` The name that's associated with the stack set.
`StackSet.Builder`	`status(StackSetStatus status)` The status of the stack set.
`StackSet.Builder`	`status(String status)` The status of the stack set.
`StackSet.Builder`	`tags(Collection<Tag> tags)` A list of tags that specify information about the stack set.
`StackSet.Builder`	`tags(Consumer<Tag.Builder>... tags)` A list of tags that specify information about the stack set.
`StackSet.Builder`	`tags(Tag... tags)` A list of tags that specify information about the stack set.
`StackSet.Builder`	`templateBody(String templateBody)` The structure that contains the body of the template that was used to create or update the stack set.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - 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:
    
    StackSetStatus, StackSetStatus
  - 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:
    
    StackSetStatus, StackSetStatus
  - 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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #parameters(List).
    
    Parameters:
    
    parameters - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #parameters(List)
  - 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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).
    
    Parameters:
    
    tags - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(List)
  - stackSetARN
```
StackSet.Builder stackSetARN(String stackSetARN)
```
    The Amazon Resource Number (ARN) of the stack set.
    
    Parameters:
    
    stackSetARN - The Amazon Resource Number (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 Number (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 Number (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 is not 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 is not 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 is not included.
    This is a convenience 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:
    
    stackSetDriftDetectionDetails(StackSetDriftDetectionDetails)
  - 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 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:
    
    autoDeployment(AutoDeployment)
  - permissionModel
```
StackSet.Builder permissionModel(String permissionModel)
```
    Describes how the IAM roles required for stack set 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 Stack Set Permissions.
    - With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
    Parameters:
    permissionModel - Describes how the IAM roles required for stack set 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 Stack Set Permissions.
    
    With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PermissionModels, PermissionModels
  - permissionModel
```
StackSet.Builder permissionModel(PermissionModels permissionModel)
```
    Describes how the IAM roles required for stack set 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 Stack Set Permissions.
    - With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
    Parameters:
    permissionModel - Describes how the IAM roles required for stack set 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 Stack Set Permissions.
    
    With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PermissionModels, PermissionModels
  - 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.

Interface StackSet.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

stackSetName

stackSetId

description

status

status

templateBody

parameters

parameters

parameters

capabilitiesWithStrings

capabilitiesWithStrings

capabilities

capabilities

tags

tags

tags

stackSetARN

administrationRoleARN

executionRoleName

stackSetDriftDetectionDetails

stackSetDriftDetectionDetails

autoDeployment

autoDeployment

permissionModel

permissionModel

organizationalUnitIds

organizationalUnitIds