Package software.amazon.awssdk.services.ecs.model

Class ContainerDependency

java.lang.Object
software.amazon.awssdk.services.ecs.model.ContainerDependency
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContainerDependency.Builder,ContainerDependency>
@Generated("software.amazon.awssdk:codegen") public final class ContainerDependency extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContainerDependency.Builder,ContainerDependency>

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks that use the Fargate launch type, the task or service requires the following platforms:

  • Linux platform version 1.3.0 or later.

  • Windows platform version 1.0.0 or later.

For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.

See Also:

  • Method Details

    • containerName

      public final String containerName()

      The name of a container.

      Returns:
      The name of a container.

    • condition

      public final ContainerCondition condition()

      The dependency condition of the container. The following are the available conditions and their behavior:

      • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

      • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

      • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

      • HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

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

      Returns:
      The dependency condition of the container. The following are the available conditions and their behavior:

      • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

      • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

      • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

      • HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

      See Also:

    • conditionAsString

      public final String conditionAsString()

      The dependency condition of the container. The following are the available conditions and their behavior:

      • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

      • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

      • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

      • HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

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

      Returns:
      The dependency condition of the container. The following are the available conditions and their behavior:

      • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

      • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

      • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

      • HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

      See Also:

    • toBuilder

      public ContainerDependency.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ContainerDependency.Builder,ContainerDependency>
      Returns:
      a builder for type T

    • builder

      public static ContainerDependency.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContainerDependency.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.