Stack.Builder (AWS SDK for Java

All Superinterfaces:

CopyableBuilder<Stack.Builder,Stack>, SdkBuilder<Stack.Builder,Stack>

Enclosing class:

Stack
```
public static interface Stack.Builder
extends CopyableBuilder<Stack.Builder,Stack>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Stack.Builder`	`capabilities(Capability... capabilities)` The capabilities allowed in the stack.
`Stack.Builder`	`capabilities(Collection<Capability> capabilities)` The capabilities allowed in the stack.
`Stack.Builder`	`capabilitiesWithStrings(Collection<String> capabilities)` The capabilities allowed in the stack.
`Stack.Builder`	`capabilitiesWithStrings(String... capabilities)` The capabilities allowed in the stack.
`Stack.Builder`	`changeSetId(String changeSetId)` The unique ID of the change set.
`Stack.Builder`	`creationTime(Instant creationTime)` The time at which the stack was created.
`Stack.Builder`	`deletionTime(Instant deletionTime)` The time the stack was deleted.
`Stack.Builder`	`description(String description)` A user-defined description associated with the stack.
`Stack.Builder`	`disableRollback(Boolean disableRollback)` Boolean to enable or disable rollback on stack creation failures:
`Stack.Builder`	`enableTerminationProtection(Boolean enableTerminationProtection)` Whether termination protection is enabled for the stack.
`Stack.Builder`	`lastUpdatedTime(Instant lastUpdatedTime)` The time the stack was last updated.
`Stack.Builder`	`notificationARNs(Collection<String> notificationARNs)` SNS topic ARNs to which stack related events are published.
`Stack.Builder`	`notificationARNs(String... notificationARNs)` SNS topic ARNs to which stack related events are published.
`Stack.Builder`	`outputs(Collection<Output> outputs)` A list of output structures.
`Stack.Builder`	`outputs(Consumer<Output.Builder>... outputs)` A list of output structures.
`Stack.Builder`	`outputs(Output... outputs)` A list of output structures.
`Stack.Builder`	`parameters(Collection<Parameter> parameters)` A list of `Parameter` structures.
`Stack.Builder`	`parameters(Consumer<Parameter.Builder>... parameters)` A list of `Parameter` structures.
`Stack.Builder`	`parameters(Parameter... parameters)` A list of `Parameter` structures.
`Stack.Builder`	`parentId(String parentId)` For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.
`Stack.Builder`	`roleARN(String roleARN)` The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack.
`default Stack.Builder`	`rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)` The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
`Stack.Builder`	`rollbackConfiguration(RollbackConfiguration rollbackConfiguration)` The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
`Stack.Builder`	`rootId(String rootId)` For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.
`Stack.Builder`	`stackId(String stackId)` Unique identifier of the stack.
`Stack.Builder`	`stackName(String stackName)` The name associated with the stack.
`Stack.Builder`	`stackStatus(StackStatus stackStatus)` Current status of the stack.
`Stack.Builder`	`stackStatus(String stackStatus)` Current status of the stack.
`Stack.Builder`	`stackStatusReason(String stackStatusReason)` Success/failure message associated with the stack status.
`Stack.Builder`	`tags(Collection<Tag> tags)` A list of `Tag`s that specify information about the stack.
`Stack.Builder`	`tags(Consumer<Tag.Builder>... tags)` A list of `Tag`s that specify information about the stack.
`Stack.Builder`	`tags(Tag... tags)` A list of `Tag`s that specify information about the stack.
`Stack.Builder`	`timeoutInMinutes(Integer timeoutInMinutes)` The amount of time within which stack creation should complete.

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
  - stackId
```
Stack.Builder stackId(String stackId)
```
    Unique identifier of the stack.
    
    Parameters:
    
    stackId - Unique identifier of the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - stackName
```
Stack.Builder stackName(String stackName)
```
    The name associated with the stack.
    
    Parameters:
    
    stackName - The name associated with the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - changeSetId
```
Stack.Builder changeSetId(String changeSetId)
```
    The unique ID of the change set.
    
    Parameters:
    
    changeSetId - The unique ID of the change set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - description
```
Stack.Builder description(String description)
```
    A user-defined description associated with the stack.
    
    Parameters:
    
    description - A user-defined description associated with the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - parameters
```
Stack.Builder parameters(Collection<Parameter> parameters)
```
    A list of Parameter structures.
    
    Parameters:
    
    parameters - A list of Parameter structures.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - parameters
```
Stack.Builder parameters(Parameter... parameters)
```
    A list of Parameter structures.
    
    Parameters:
    
    parameters - A list of Parameter structures.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - parameters
```
Stack.Builder parameters(Consumer<Parameter.Builder>... parameters)
```
    A list of Parameter structures.
    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)
  - creationTime
```
Stack.Builder creationTime(Instant creationTime)
```
    The time at which the stack was created.
    
    Parameters:
    
    creationTime - The time at which the stack was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - deletionTime
```
Stack.Builder deletionTime(Instant deletionTime)
```
    The time the stack was deleted.
    
    Parameters:
    
    deletionTime - The time the stack was deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - lastUpdatedTime
```
Stack.Builder lastUpdatedTime(Instant lastUpdatedTime)
```
    The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
    
    Parameters:
    
    lastUpdatedTime - The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - rollbackConfiguration
```
Stack.Builder rollbackConfiguration(RollbackConfiguration rollbackConfiguration)
```
    The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
    
    Parameters:
    
    rollbackConfiguration - The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - rollbackConfiguration
```
default Stack.Builder rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)
```
    The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
    This is a convenience that creates an instance of the RollbackConfiguration.Builder avoiding the need to create one manually via RollbackConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rollbackConfiguration(RollbackConfiguration).
    
    Parameters:
    
    rollbackConfiguration - a consumer that will call methods on RollbackConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    rollbackConfiguration(RollbackConfiguration)
  - stackStatus
```
Stack.Builder stackStatus(String stackStatus)
```
    Current status of the stack.
    
    Parameters:
    
    stackStatus - Current status of the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackStatus, StackStatus
  - stackStatus
```
Stack.Builder stackStatus(StackStatus stackStatus)
```
    Current status of the stack.
    
    Parameters:
    
    stackStatus - Current status of the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StackStatus, StackStatus
  - stackStatusReason
```
Stack.Builder stackStatusReason(String stackStatusReason)
```
    Success/failure message associated with the stack status.
    
    Parameters:
    
    stackStatusReason - Success/failure message associated with the stack status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - disableRollback
```
Stack.Builder disableRollback(Boolean disableRollback)
```
    Boolean to enable or disable rollback on stack creation failures:
    - true: disable rollback
    - false: enable rollback
    Parameters:
    disableRollback - Boolean to enable or disable rollback on stack creation failures:
    
    true: disable rollback
    
    false: enable rollback
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - notificationARNs
```
Stack.Builder notificationARNs(Collection<String> notificationARNs)
```
    SNS topic ARNs to which stack related events are published.
    
    Parameters:
    
    notificationARNs - SNS topic ARNs to which stack related events are published.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - notificationARNs
```
Stack.Builder notificationARNs(String... notificationARNs)
```
    SNS topic ARNs to which stack related events are published.
    
    Parameters:
    
    notificationARNs - SNS topic ARNs to which stack related events are published.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - timeoutInMinutes
```
Stack.Builder timeoutInMinutes(Integer timeoutInMinutes)
```
    The amount of time within which stack creation should complete.
    
    Parameters:
    
    timeoutInMinutes - The amount of time within which stack creation should complete.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - capabilitiesWithStrings
```
Stack.Builder capabilitiesWithStrings(Collection<String> capabilities)
```
    The capabilities allowed in the stack.
    
    Parameters:
    
    capabilities - The capabilities allowed in the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - capabilitiesWithStrings
```
Stack.Builder capabilitiesWithStrings(String... capabilities)
```
    The capabilities allowed in the stack.
    
    Parameters:
    
    capabilities - The capabilities allowed in the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - capabilities
```
Stack.Builder capabilities(Collection<Capability> capabilities)
```
    The capabilities allowed in the stack.
    
    Parameters:
    
    capabilities - The capabilities allowed in the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - capabilities
```
Stack.Builder capabilities(Capability... capabilities)
```
    The capabilities allowed in the stack.
    
    Parameters:
    
    capabilities - The capabilities allowed in the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputs
```
Stack.Builder outputs(Collection<Output> outputs)
```
    A list of output structures.
    
    Parameters:
    
    outputs - A list of output structures.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputs
```
Stack.Builder outputs(Output... outputs)
```
    A list of output structures.
    
    Parameters:
    
    outputs - A list of output structures.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputs
```
Stack.Builder outputs(Consumer<Output.Builder>... outputs)
```
    A list of output structures.
    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 #outputs(List).
    
    Parameters:
    
    outputs - 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:
    
    #outputs(List)
  - roleARN
```
Stack.Builder roleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
Stack.Builder tags(Collection<Tag> tags)
```
    A list of Tags that specify information about the stack.
    
    Parameters:
    
    tags - A list of Tags that specify information about the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
Stack.Builder tags(Tag... tags)
```
    A list of Tags that specify information about the stack.
    
    Parameters:
    
    tags - A list of Tags that specify information about the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
Stack.Builder tags(Consumer<Tag.Builder>... tags)
```
    A list of Tags that specify information about the stack.
    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)
  - enableTerminationProtection
```
Stack.Builder enableTerminationProtection(Boolean enableTerminationProtection)
```
    Whether termination protection is enabled for the stack.
    
    For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
    
    Parameters:
    
    enableTerminationProtection - Whether termination protection is enabled for the stack.
    
    For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - parentId
```
Stack.Builder parentId(String parentId)
```
    For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
    
    For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
    
    Parameters:
    
    parentId - For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
    
    For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - rootId
```
Stack.Builder rootId(String rootId)
```
    For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.
    
    For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
    
    Parameters:
    
    rootId - For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.
    
    For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface Stack.Builder

Method Summary

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

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

Method Detail

stackId

stackName

changeSetId

description

parameters

parameters

parameters

creationTime

deletionTime

lastUpdatedTime

rollbackConfiguration

rollbackConfiguration

stackStatus

stackStatus

stackStatusReason

disableRollback

notificationARNs

notificationARNs

timeoutInMinutes

capabilitiesWithStrings

capabilitiesWithStrings

capabilities

capabilities

outputs

outputs

outputs

roleARN

tags

tags

tags

enableTerminationProtection

parentId

rootId