Deployment (AWS Java SDK :: Services :: Amazon EC2 Container Service 2.17.94 API)

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 only when a service uses the ECS deployment controller type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Deployment.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Deployment.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Deployment.Builder`	`builder()`
`List<CapacityProviderStrategyItem>`	`capacityProviderStrategy()` The capacity provider strategy that the deployment is using.
`Instant`	`createdAt()` The Unix timestamp for the time 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)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`failedTasks()` The number of consecutively failed tasks in the deployment.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCapacityProviderStrategy()` For responses, this returns true if the service returned a value for the CapacityProviderStrategy property.
`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`	`platformFamily()` The operating system that your tasks in the service, or tasks are running on.
`String`	`platformVersion()` The platform version that your tasks in the service run on.
`DeploymentRolloutState`	`rolloutState()`
`String`	`rolloutStateAsString()`
`String`	`rolloutStateReason()` A description of the rollout state of a deployment.
`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 the time 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 final String id()
```
    The ID of the deployment.
    
    Returns:
    
    The ID of the deployment.
  - status
```
public final 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 final 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 final 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 final 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 final 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.
  - failedTasks
```
public final Integer failedTasks()
```
    The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.
    
    Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
    
    Returns:
    
    The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.
    
    Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
  - createdAt
```
public final Instant createdAt()
```
    The Unix timestamp for the time when the service deployment was created.
    
    Returns:
    
    The Unix timestamp for the time when the service deployment was created.
  - updatedAt
```
public final Instant updatedAt()
```
    The Unix timestamp for the time when the service deployment was last updated.
    
    Returns:
    
    The Unix timestamp for the time when the service deployment was last updated.
  - hasCapacityProviderStrategy
```
public final boolean hasCapacityProviderStrategy()
```
    For responses, this returns true if the service returned a value for the CapacityProviderStrategy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - capacityProviderStrategy
```
public final List<CapacityProviderStrategyItem> capacityProviderStrategy()
```
    The capacity provider strategy that the deployment is using.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCapacityProviderStrategy() method.
    
    Returns:
    
    The capacity provider strategy that the deployment is using.
  - launchType
```
public final 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 final 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 final String platformVersion()
```
    The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
  - platformFamily
```
public final String platformFamily()
```
    The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.
    
    All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..
    
    Returns:
    
    The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.
    
    All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..
  - networkConfiguration
```
public final 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.
  - rolloutState
```
public final DeploymentRolloutState rolloutState()
```
    The rolloutState of a service is only returned for services that use the rolling update ( ECS) deployment type that aren't behind a Classic Load Balancer.
    
    The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.
    
    If the service returns an enum value that is not available in the current SDK version, rolloutState will return DeploymentRolloutState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rolloutStateAsString().
    
    Returns:
    
    The rolloutState of a service is only returned for services that use the rolling update ( ECS) deployment type that aren't behind a Classic Load Balancer.
    
    The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.
    
    See Also:
    
    DeploymentRolloutState
  - rolloutStateAsString
```
public final String rolloutStateAsString()
```
    The rolloutState of a service is only returned for services that use the rolling update ( ECS) deployment type that aren't behind a Classic Load Balancer.
    
    The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.
    
    If the service returns an enum value that is not available in the current SDK version, rolloutState will return DeploymentRolloutState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rolloutStateAsString().
    
    Returns:
    
    The rolloutState of a service is only returned for services that use the rolling update ( ECS) deployment type that aren't behind a Classic Load Balancer.
    
    The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.
    
    See Also:
    
    DeploymentRolloutState
  - rolloutStateReason
```
public final String rolloutStateReason()
```
    A description of the rollout state of a deployment.
    
    Returns:
    
    A description of the rollout state of a deployment.
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Deployment

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

status

taskDefinition

desiredCount

pendingCount

runningCount

failedTasks

createdAt

updatedAt

hasCapacityProviderStrategy

capacityProviderStrategy

launchType

launchTypeAsString

platformVersion

platformFamily

networkConfiguration

rolloutState

rolloutStateAsString

rolloutStateReason

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields