software.amazon.awssdk.services.ecs.model

Class Deployment

java.lang.Object

software.amazon.awssdk.services.ecs.model.Deployment

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Deployment.Builder,Deployment>

@Generated(value="software.amazon.awssdk:codegen")
public final class Deployment
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Deployment.Builder,Deployment>

The details of an Amazon ECS service deployment. This is used when a service uses the CODE_DEPLOY deployment controller type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Deployment.Builder

Method Summary

Modifier and Type	Method and Description
static Deployment.Builder	builder()
Instant	createdAt() The Unix timestamp for when the service deployment was created.
Integer	desiredCount() The most recent desired count of tasks that was specified for the service to deploy or maintain.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The ID of the deployment.
LaunchType	launchType() The launch type the tasks in the service are using.
String	launchTypeAsString() The launch type the tasks in the service are using.
NetworkConfiguration	networkConfiguration() The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
Integer	pendingCount() The number of tasks in the deployment that are in the PENDING status.
String	platformVersion() The platform version on which your tasks in the service are running.
Integer	runningCount() The number of tasks in the deployment that are in the RUNNING status.
List<SdkField<?>>	sdkFields()
static Class<? extends Deployment.Builder>	serializableBuilderClass()
String	status() The status of the deployment.
String	taskDefinition() The most recent task definition that was specified for the tasks in the service to use.
Deployment.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() The Unix timestamp for when the service deployment was last updated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public String id()

The ID of the deployment.

Returns:

The ID of the deployment.

status

public String status()

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

Returns:

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

taskDefinition

public String taskDefinition()

The most recent task definition that was specified for the tasks in the service to use.

Returns:

The most recent task definition that was specified for the tasks in the service to use.

desiredCount

public Integer desiredCount()

The most recent desired count of tasks that was specified for the service to deploy or maintain.

Returns:

The most recent desired count of tasks that was specified for the service to deploy or maintain.

pendingCount

public Integer pendingCount()

The number of tasks in the deployment that are in the PENDING status.

Returns:

The number of tasks in the deployment that are in the PENDING status.

runningCount

public Integer runningCount()

The number of tasks in the deployment that are in the RUNNING status.

Returns:

The number of tasks in the deployment that are in the RUNNING status.

createdAt

public Instant createdAt()

The Unix timestamp for when the service deployment was created.

Returns:

The Unix timestamp for when the service deployment was created.

updatedAt

public Instant updatedAt()

The Unix timestamp for when the service deployment was last updated.

Returns:

The Unix timestamp for when the service deployment was last updated.

launchType

public LaunchType launchType()

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

If the service returns an enum value that is not available in the current SDK version, launchType will return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from launchTypeAsString().

Returns:

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

See Also:

LaunchType

launchTypeAsString

public String launchTypeAsString()

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

If the service returns an enum value that is not available in the current SDK version, launchType will return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from launchTypeAsString().

Returns:

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

See Also:

LaunchType

platformVersion

public String platformVersion()

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

networkConfiguration

public NetworkConfiguration networkConfiguration()

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Returns:

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

toBuilder

public Deployment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Deployment.Builder,Deployment>

builder

public static Deployment.Builder builder()

serializableBuilderClass

public static Class<? extends Deployment.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo