Interface Stack.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<Stack.Builder,Stack>
,SdkBuilder<Stack.Builder,Stack>
,SdkPojo
- Enclosing class:
- Stack
public static interface Stack.Builder extends SdkPojo, CopyableBuilder<Stack.Builder,Stack>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Stack.Builder
capabilities(Collection<Capability> capabilities)
The capabilities allowed in the stack.Stack.Builder
capabilities(Capability... capabilities)
The capabilities allowed in the stack.Stack.Builder
capabilitiesWithStrings(String... capabilities)
The capabilities allowed in the stack.Stack.Builder
capabilitiesWithStrings(Collection<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:default Stack.Builder
driftInformation(Consumer<StackDriftInformation.Builder> driftInformation)
Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.Stack.Builder
driftInformation(StackDriftInformation driftInformation)
Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.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(String... notificationARNs)
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.Stack.Builder
notificationARNs(Collection<String> notificationARNs)
Amazon SNS topic Amazon Resource Names (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 ofParameter
structures.Stack.Builder
parameters(Consumer<Parameter.Builder>... parameters)
A list ofParameter
structures.Stack.Builder
parameters(Parameter... parameters)
A list ofParameter
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
retainExceptOnCreate(Boolean retainExceptOnCreate)
When set totrue
, newly created resources are deleted when the operation rolls back.Stack.Builder
roleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack.default Stack.Builder
rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)
The rollback triggers for 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 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 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(String stackStatus)
Current status of the stack.Stack.Builder
stackStatus(StackStatus 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 ofTag
s that specify information about the stack.Stack.Builder
tags(Consumer<Tag.Builder>... tags)
A list ofTag
s that specify information about the stack.Stack.Builder
tags(Tag... tags)
A list ofTag
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
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
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 ofParameter
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 ofParameter
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
This is a convenience method that creates an instance of theParameter
structures.Parameter.Builder
avoiding the need to create one manually viaParameter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#parameters(List
.) - Parameters:
parameters
- a consumer that will call methods onParameter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#parameters(java.util.Collection
)
-
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 CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
- Parameters:
rollbackConfiguration
- The rollback triggers for 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 CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
This is a convenience method that creates an instance of theRollbackConfiguration.Builder
avoiding the need to create one manually viaRollbackConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torollbackConfiguration(RollbackConfiguration)
.- Parameters:
rollbackConfiguration
- a consumer that will call methods onRollbackConfiguration.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)
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
- Parameters:
notificationARNs
- Amazon SNS topic Amazon Resource Names (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)
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
- Parameters:
notificationARNs
- Amazon SNS topic Amazon Resource Names (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 method that creates an instance of theOutput.Builder
avoiding the need to create one manually viaOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#outputs(List
.- Parameters:
outputs
- a consumer that will call methods onOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#outputs(java.util.Collection
-
roleARN
Stack.Builder roleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
- Parameters:
roleARN
- The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, 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
Tag
s that specify information about the stack.- Parameters:
tags
- A list ofTag
s 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
Tag
s that specify information about the stack.- Parameters:
tags
- A list ofTag
s 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
This is a convenience method that creates an instance of theTag
s that specify information about the stack.Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tags(List
.) - Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection
)
-
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 can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the 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 can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the 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 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 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 top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the CloudFormation User Guide.
- Parameters:
rootId
- For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.For more information, see Working with Nested Stacks in the CloudFormation User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
driftInformation
Stack.Builder driftInformation(StackDriftInformation driftInformation)
Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
- Parameters:
driftInformation
- Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
driftInformation
default Stack.Builder driftInformation(Consumer<StackDriftInformation.Builder> driftInformation)
Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
This is a convenience method that creates an instance of theStackDriftInformation.Builder
avoiding the need to create one manually viaStackDriftInformation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todriftInformation(StackDriftInformation)
.- Parameters:
driftInformation
- a consumer that will call methods onStackDriftInformation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
driftInformation(StackDriftInformation)
-
retainExceptOnCreate
Stack.Builder retainExceptOnCreate(Boolean retainExceptOnCreate)
When set to
true
, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy ofRetain
.Default:
false
- Parameters:
retainExceptOnCreate
- When set totrue
, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy ofRetain
.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-