Class ECSTaskSet

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

Information about a set of Amazon ECS tasks in an CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set.

See Also:

  • Method Details

    • identifer

      public final String identifer()

      A unique ID of an ECSTaskSet.

      Returns:
      A unique ID of an ECSTaskSet.

    • desiredCount

      public final Long desiredCount()

      The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.

      Returns:
      The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.

    • pendingCount

      public final Long pendingCount()

      The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.

      Returns:
      The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.

    • runningCount

      public final Long runningCount()

      The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment. A task in the RUNNING state is running and ready for use.

      Returns:
      The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment. A task in the RUNNING state is running and ready for use.

    • status

      public final String status()

      The status of the task set. There are three valid task set statuses:

      • PRIMARY: Indicates the task set is serving production traffic.

      • ACTIVE: Indicates the task set is not serving production traffic.

      • DRAINING: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

      Returns:
      The status of the task set. There are three valid task set statuses:

      • PRIMARY: Indicates the task set is serving production traffic.

      • ACTIVE: Indicates the task set is not serving production traffic.

      • DRAINING: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

    • trafficWeight

      public final Double trafficWeight()

      The percentage of traffic served by this task set.

      Returns:
      The percentage of traffic served by this task set.

    • targetGroup

      public final TargetGroupInfo targetGroup()

      The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.

      Returns:
      The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.

    • taskSetLabel

      public final TargetLabel taskSetLabel()

      A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).

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

      Returns:
      A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
      See Also:

    • taskSetLabelAsString

      public final String taskSetLabelAsString()

      A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).

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

      Returns:
      A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
      See Also:

    • toBuilder

      public ECSTaskSet.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<ECSTaskSet.Builder,ECSTaskSet>
      Returns:
      a builder for type T

    • builder

      public static ECSTaskSet.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ECSTaskSet.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.