Package software.amazon.awssdk.services.opsworks.model

Interface Deployment.Builder

All Superinterfaces:

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

Enclosing class:

Deployment

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

Method Summary

Modifier and Type	Method	Description
Deployment.Builder	appId(String appId)	The app ID.
default Deployment.Builder	command(Consumer<DeploymentCommand.Builder> command)	Used to specify a stack or deployment command.
Deployment.Builder	command(DeploymentCommand command)	Used to specify a stack or deployment command.
Deployment.Builder	comment(String comment)	A user-defined comment.
Deployment.Builder	completedAt(String completedAt)	Date when the deployment completed.
Deployment.Builder	createdAt(String createdAt)	Date when the deployment was created.
Deployment.Builder	customJson(String customJson)	A string that contains user-defined custom JSON.
Deployment.Builder	deploymentId(String deploymentId)	The deployment ID.
Deployment.Builder	duration(Integer duration)	The deployment duration.
Deployment.Builder	iamUserArn(String iamUserArn)	The user's IAM ARN.
Deployment.Builder	instanceIds(String... instanceIds)	The IDs of the target instances.
Deployment.Builder	instanceIds(Collection<String> instanceIds)	The IDs of the target instances.
Deployment.Builder	stackId(String stackId)	The stack ID.
Deployment.Builder	status(String status)	The deployment status:

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

deploymentId

Deployment.Builder deploymentId(String deploymentId)

The deployment ID.

Parameters:

deploymentId - The deployment ID.

Returns:

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

stackId

Deployment.Builder stackId(String stackId)

The stack ID.

Parameters:

stackId - The stack ID.

Returns:

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

appId

Deployment.Builder appId(String appId)

The app ID.

Parameters:

appId - The app ID.

Returns:

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

createdAt

Deployment.Builder createdAt(String createdAt)

Date when the deployment was created.

Parameters:

createdAt - Date when the deployment was created.

Returns:

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

completedAt

Deployment.Builder completedAt(String completedAt)

Date when the deployment completed.

Parameters:

completedAt - Date when the deployment completed.

Returns:

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

duration

Deployment.Builder duration(Integer duration)

The deployment duration.

Parameters:

duration - The deployment duration.

Returns:

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

iamUserArn

Deployment.Builder iamUserArn(String iamUserArn)

The user's IAM ARN.

Parameters:

iamUserArn - The user's IAM ARN.

Returns:

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

comment

Deployment.Builder comment(String comment)

A user-defined comment.

Parameters:

comment - A user-defined comment.

Returns:

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

command

Deployment.Builder command(DeploymentCommand command)

Used to specify a stack or deployment command.

Parameters:

command - Used to specify a stack or deployment command.

Returns:

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

command

default Deployment.Builder command(Consumer<DeploymentCommand.Builder> command)

Used to specify a stack or deployment command.

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

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

Parameters:

command - a consumer that will call methods on DeploymentCommand.Builder

Returns:

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

See Also:

command(DeploymentCommand)

status

Deployment.Builder status(String status)

The deployment status:

• running

• successful

• failed

Parameters:

status - The deployment status:

• running

• successful

• failed

Returns:

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

customJson

Deployment.Builder customJson(String customJson)

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Parameters:

customJson - A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Returns:

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

instanceIds

Deployment.Builder instanceIds(Collection<String> instanceIds)

The IDs of the target instances.

Parameters:

instanceIds - The IDs of the target instances.

Returns:

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

instanceIds

Deployment.Builder instanceIds(String... instanceIds)

The IDs of the target instances.

Parameters:

instanceIds - The IDs of the target instances.

Returns:

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