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

Interface StackSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StackSummary.Builder,StackSummary>, SdkBuilder<StackSummary.Builder,StackSummary>, SdkPojo

Enclosing class:

StackSummary

public static interface StackSummary.Builder
extends SdkPojo, CopyableBuilder<StackSummary.Builder,StackSummary>

Method Summary

Modifier and Type	Method	Description
StackSummary.Builder	creationTime(Instant creationTime)	The time the stack was created.
StackSummary.Builder	deletionTime(Instant deletionTime)	The time the stack was deleted.
default StackSummary.Builder	driftInformation(Consumer<StackDriftInformationSummary.Builder> driftInformation)	Summarizes 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.
StackSummary.Builder	driftInformation(StackDriftInformationSummary driftInformation)	Summarizes 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.
StackSummary.Builder	lastUpdatedTime(Instant lastUpdatedTime)	The time the stack was last updated.
StackSummary.Builder	parentId(String parentId)	For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.
StackSummary.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.
StackSummary.Builder	stackId(String stackId)	Unique stack identifier.
StackSummary.Builder	stackName(String stackName)	The name associated with the stack.
StackSummary.Builder	stackStatus(String stackStatus)	The current status of the stack.
StackSummary.Builder	stackStatus(StackStatus stackStatus)	The current status of the stack.
StackSummary.Builder	stackStatusReason(String stackStatusReason)	Success/Failure message associated with the stack status.
StackSummary.Builder	templateDescription(String templateDescription)	The template description of the template used to create the stack.

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, sdkFieldNameToField, sdkFields

Method Detail

stackId

StackSummary.Builder stackId(String stackId)

Unique stack identifier.

Parameters:

stackId - Unique stack identifier.

Returns:

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

stackName

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

templateDescription

StackSummary.Builder templateDescription(String templateDescription)

The template description of the template used to create the stack.

Parameters:

templateDescription - The template description of the template used to create the stack.

Returns:

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

creationTime

StackSummary.Builder creationTime(Instant creationTime)

The time the stack was created.

Parameters:

creationTime - The time the stack was created.

Returns:

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

lastUpdatedTime

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

deletionTime

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

stackStatus

StackSummary.Builder stackStatus(String stackStatus)

The current status of the stack.

Parameters:

stackStatus - The 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

StackSummary.Builder stackStatus(StackStatus stackStatus)

The current status of the stack.

Parameters:

stackStatus - The 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

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

parentId

StackSummary.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 Embed stacks within other stacks using 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 Embed stacks within other stacks using nested stacks in the CloudFormation User Guide.

Returns:

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

rootId

StackSummary.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 Embed stacks within other stacks using 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 Embed stacks within other stacks using nested stacks in the CloudFormation User Guide.

Returns:

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

driftInformation

StackSummary.Builder driftInformation(StackDriftInformationSummary driftInformation)

Summarizes 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 Detect unmanaged configuration changes to stacks and resources with drift detection.

Parameters:

driftInformation - Summarizes 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 Detect unmanaged configuration changes to stacks and resources with drift detection.

Returns:

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

driftInformation

default StackSummary.Builder driftInformation(Consumer<StackDriftInformationSummary.Builder> driftInformation)

Summarizes 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 Detect unmanaged configuration changes to stacks and resources with drift detection.

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

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

Parameters:

driftInformation - a consumer that will call methods on StackDriftInformationSummary.Builder

Returns:

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

See Also:

driftInformation(StackDriftInformationSummary)