Interface ServiceDeployment.Builder

All Superinterfaces:

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

Enclosing class:

ServiceDeployment

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

Method Summary

Modifier and Type	Method	Description
default ServiceDeployment.Builder	alarms(Consumer<ServiceDeploymentAlarms.Builder> alarms)	The CloudWatch alarms that determine when a service deployment fails.
ServiceDeployment.Builder	alarms(ServiceDeploymentAlarms alarms)	The CloudWatch alarms that determine when a service deployment fails.
ServiceDeployment.Builder	clusterArn(String clusterArn)	The ARN of the cluster that hosts the service.
ServiceDeployment.Builder	createdAt(Instant createdAt)	The time the service deployment was created.
default ServiceDeployment.Builder	deploymentCircuitBreaker(Consumer<ServiceDeploymentCircuitBreaker.Builder> deploymentCircuitBreaker)	The circuit breaker configuration that determines a service deployment failed.
ServiceDeployment.Builder	deploymentCircuitBreaker(ServiceDeploymentCircuitBreaker deploymentCircuitBreaker)	The circuit breaker configuration that determines a service deployment failed.
default ServiceDeployment.Builder	deploymentConfiguration(Consumer<DeploymentConfiguration.Builder> deploymentConfiguration)	Sets the value of the DeploymentConfiguration property for this object.
ServiceDeployment.Builder	deploymentConfiguration(DeploymentConfiguration deploymentConfiguration)	Sets the value of the DeploymentConfiguration property for this object.
ServiceDeployment.Builder	finishedAt(Instant finishedAt)	The time the service deployment finished.
default ServiceDeployment.Builder	rollback(Consumer<Rollback.Builder> rollback)	The rollback options the service deployment uses when the deployment fails.
ServiceDeployment.Builder	rollback(Rollback rollback)	The rollback options the service deployment uses when the deployment fails.
ServiceDeployment.Builder	serviceArn(String serviceArn)	The ARN of the service for this service deployment.
ServiceDeployment.Builder	serviceDeploymentArn(String serviceDeploymentArn)	The ARN of the service deployment.
ServiceDeployment.Builder	sourceServiceRevisions(Collection<ServiceRevisionSummary> sourceServiceRevisions)	The currently deployed workload configuration.
ServiceDeployment.Builder	sourceServiceRevisions(Consumer<ServiceRevisionSummary.Builder>... sourceServiceRevisions)	The currently deployed workload configuration.
ServiceDeployment.Builder	sourceServiceRevisions(ServiceRevisionSummary... sourceServiceRevisions)	The currently deployed workload configuration.
ServiceDeployment.Builder	startedAt(Instant startedAt)	The time the service deployment statred.
ServiceDeployment.Builder	status(String status)	The service deployment state.
ServiceDeployment.Builder	status(ServiceDeploymentStatus status)	The service deployment state.
ServiceDeployment.Builder	statusReason(String statusReason)	Information about why the service deployment is in the current status.
ServiceDeployment.Builder	stoppedAt(Instant stoppedAt)	The time the service deployment stopped.
default ServiceDeployment.Builder	targetServiceRevision(Consumer<ServiceRevisionSummary.Builder> targetServiceRevision)	The workload configuration being deployed.
ServiceDeployment.Builder	targetServiceRevision(ServiceRevisionSummary targetServiceRevision)	The workload configuration being deployed.
ServiceDeployment.Builder	updatedAt(Instant updatedAt)	The time that the service deployment was last updated.

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 Details

serviceDeploymentArn

ServiceDeployment.Builder serviceDeploymentArn(String serviceDeploymentArn)

The ARN of the service deployment.

Parameters:

serviceDeploymentArn - The ARN of the service deployment.

Returns:

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

serviceArn

ServiceDeployment.Builder serviceArn(String serviceArn)

The ARN of the service for this service deployment.

Parameters:

serviceArn - The ARN of the service for this service deployment.

Returns:

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

clusterArn

ServiceDeployment.Builder clusterArn(String clusterArn)

The ARN of the cluster that hosts the service.

Parameters:

clusterArn - The ARN of the cluster that hosts the service.

Returns:

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

createdAt

ServiceDeployment.Builder createdAt(Instant createdAt)

The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

Parameters:

createdAt - The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

Returns:

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

startedAt

ServiceDeployment.Builder startedAt(Instant startedAt)

The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

Parameters:

startedAt - The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

Returns:

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

finishedAt

ServiceDeployment.Builder finishedAt(Instant finishedAt)

The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

Parameters:

finishedAt - The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

Returns:

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

stoppedAt

ServiceDeployment.Builder stoppedAt(Instant stoppedAt)

The time the service deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

The service deployment stops when any of the following actions happen:

• A user manually stops the deployment

• The rollback option is not in use for the failure detection mechanism (the circuit breaker or alarm-based) and the service fails.

Parameters:

stoppedAt - The time the service deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

The service deployment stops when any of the following actions happen:

• A user manually stops the deployment

• The rollback option is not in use for the failure detection mechanism (the circuit breaker or alarm-based) and the service fails.

Returns:

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

updatedAt

ServiceDeployment.Builder updatedAt(Instant updatedAt)

The time that the service deployment was last updated. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

Parameters:

updatedAt - The time that the service deployment was last updated. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

Returns:

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

sourceServiceRevisions

ServiceDeployment.Builder sourceServiceRevisions(Collection<ServiceRevisionSummary> sourceServiceRevisions)

The currently deployed workload configuration.

Parameters:

sourceServiceRevisions - The currently deployed workload configuration.

Returns:

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

sourceServiceRevisions

ServiceDeployment.Builder sourceServiceRevisions(ServiceRevisionSummary... sourceServiceRevisions)

The currently deployed workload configuration.

Parameters:

sourceServiceRevisions - The currently deployed workload configuration.

Returns:

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

sourceServiceRevisions

ServiceDeployment.Builder sourceServiceRevisions(Consumer<ServiceRevisionSummary.Builder>... sourceServiceRevisions)

The currently deployed workload configuration.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceServiceRevisions(List<ServiceRevisionSummary>).

Parameters:

sourceServiceRevisions - a consumer that will call methods on ServiceRevisionSummary.Builder

Returns:

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

See Also:

• sourceServiceRevisions(java.util.Collection<ServiceRevisionSummary>)

targetServiceRevision

ServiceDeployment.Builder targetServiceRevision(ServiceRevisionSummary targetServiceRevision)

The workload configuration being deployed.

Parameters:

targetServiceRevision - The workload configuration being deployed.

Returns:

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

targetServiceRevision

default ServiceDeployment.Builder targetServiceRevision(Consumer<ServiceRevisionSummary.Builder> targetServiceRevision)

The workload configuration being deployed.

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

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

Parameters:

targetServiceRevision - a consumer that will call methods on ServiceRevisionSummary.Builder

Returns:

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

See Also:

• targetServiceRevision(ServiceRevisionSummary)

status

ServiceDeployment.Builder status(String status)

The service deployment state.

Parameters:

status - The service deployment state.

Returns:

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

See Also:

• ServiceDeploymentStatus
• ServiceDeploymentStatus

status

ServiceDeployment.Builder status(ServiceDeploymentStatus status)

The service deployment state.

Parameters:

status - The service deployment state.

Returns:

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

See Also:

• ServiceDeploymentStatus
• ServiceDeploymentStatus

statusReason

ServiceDeployment.Builder statusReason(String statusReason)

Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.

Parameters:

statusReason - Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.

Returns:

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

deploymentConfiguration

ServiceDeployment.Builder deploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

Sets the value of the DeploymentConfiguration property for this object.

Parameters:

deploymentConfiguration - The new value for the DeploymentConfiguration property for this object.

Returns:

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

deploymentConfiguration

default ServiceDeployment.Builder deploymentConfiguration(Consumer<DeploymentConfiguration.Builder> deploymentConfiguration)

Sets the value of the DeploymentConfiguration property for this object. This is a convenience method that creates an instance of the DeploymentConfiguration.Builder avoiding the need to create one manually via DeploymentConfiguration.builder().

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

Parameters:

deploymentConfiguration - a consumer that will call methods on DeploymentConfiguration.Builder

Returns:

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

See Also:

• deploymentConfiguration(DeploymentConfiguration)

rollback

ServiceDeployment.Builder rollback(Rollback rollback)

The rollback options the service deployment uses when the deployment fails.

Parameters:

rollback - The rollback options the service deployment uses when the deployment fails.

Returns:

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

rollback

default ServiceDeployment.Builder rollback(Consumer<Rollback.Builder> rollback)

The rollback options the service deployment uses when the deployment fails.

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

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

Parameters:

rollback - a consumer that will call methods on Rollback.Builder

Returns:

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

See Also:

• rollback(Rollback)

deploymentCircuitBreaker

ServiceDeployment.Builder deploymentCircuitBreaker(ServiceDeploymentCircuitBreaker deploymentCircuitBreaker)

The circuit breaker configuration that determines a service deployment failed.

Parameters:

deploymentCircuitBreaker - The circuit breaker configuration that determines a service deployment failed.

Returns:

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

deploymentCircuitBreaker

default ServiceDeployment.Builder deploymentCircuitBreaker(Consumer<ServiceDeploymentCircuitBreaker.Builder> deploymentCircuitBreaker)

The circuit breaker configuration that determines a service deployment failed.

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

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

Parameters:

deploymentCircuitBreaker - a consumer that will call methods on ServiceDeploymentCircuitBreaker.Builder

Returns:

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

See Also:

• deploymentCircuitBreaker(ServiceDeploymentCircuitBreaker)

alarms

ServiceDeployment.Builder alarms(ServiceDeploymentAlarms alarms)

The CloudWatch alarms that determine when a service deployment fails.

Parameters:

alarms - The CloudWatch alarms that determine when a service deployment fails.

Returns:

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

alarms

default ServiceDeployment.Builder alarms(Consumer<ServiceDeploymentAlarms.Builder> alarms)

The CloudWatch alarms that determine when a service deployment fails.

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

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

Parameters:

alarms - a consumer that will call methods on ServiceDeploymentAlarms.Builder

Returns:

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

See Also:

• alarms(ServiceDeploymentAlarms)