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

Interface Stack.Builder

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

Modifier and Type	Method	Description
Stack.Builder	capabilities(String... capabilities)	The capabilities allowed in the stack.
Stack.Builder	capabilities(Collection<String> capabilities)	The capabilities allowed in the stack.
Stack.Builder	capabilities(Capability... capabilities)	The capabilities allowed in the stack.
Stack.Builder	changeSetId(String changeSetId)	The unique ID of the change set.
Stack.Builder	creationTime(Date creationTime)	The time at which the stack was created.
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	lastUpdatedTime(Date lastUpdatedTime)	The time the stack was last updated.
Stack.Builder	notificationARNs(String... notificationARNs)	SNS topic ARNs to which stack related events are published.
Stack.Builder	notificationARNs(Collection<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(Output... outputs)	A list of output structures.
Stack.Builder	parameters(Collection<Parameter> parameters)	A list of Parameter structures.
Stack.Builder	parameters(Parameter... parameters)	A list of Parameter structures.
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.
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 of Tags that specify information about the stack.
Stack.Builder	tags(Tag... tags)	A list of Tags 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

apply, 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.

NOTE: This method appends the values to the existing list (if any). Use #setParameters(java.util.Collection) or #withParameters(java.util.Collection) if you want to override the existing values.

Parameters:

parameters - A list of Parameter structures.

Returns:

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

creationTime

Stack.Builder creationTime(Date 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.

lastUpdatedTime

Stack.Builder lastUpdatedTime(Date 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.

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

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

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.

NOTE: This method appends the values to the existing list (if any). Use #setNotificationARNs(java.util.Collection) or #withNotificationARNs(java.util.Collection) if you want to override the existing values.

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.

capabilities

Stack.Builder capabilities(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.

See Also:

Capability

capabilities

Stack.Builder capabilities(String... capabilities)

The capabilities allowed in the stack.

NOTE: This method appends the values to the existing list (if any). Use #setCapabilities(java.util.Collection) or #withCapabilities(java.util.Collection) if you want to override the existing values.

Parameters:

capabilities - The capabilities allowed in the stack.

Returns:

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

See Also:

Capability

capabilities

Stack.Builder capabilities(Capability... capabilities)

The capabilities allowed in the stack.

NOTE: This method appends the values to the existing list (if any). Use #setCapabilities(java.util.Collection) or #withCapabilities(java.util.Collection) if you want to override the existing values.

Parameters:

capabilities - The capabilities allowed in the stack.

Returns:

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

See Also:

Capability

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.

NOTE: This method appends the values to the existing list (if any). Use #setOutputs(java.util.Collection) or #withOutputs(java.util.Collection) if you want to override the existing values.

Parameters:

outputs - A list of output structures.

Returns:

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

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.

NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.

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.