ECSTaskSet (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.codedeploy.model

Class ECSTaskSet

java.lang.Object
- com.amazonaws.services.codedeploy.model.ECSTaskSet

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ECSTaskSet
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ECSTaskSet ()

Constructors
Constructor and Description
`ECSTaskSet ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`ECSTaskSet`	`clone ()`
`boolean`	`equals (Object obj)`
`Long`	`getDesiredCount ()` The number of tasks in a task set.
`String`	`getIdentifer ()` A unique ID of an `ECSTaskSet`.
`Long`	`getPendingCount ()` The number of tasks in the task set that are in the `PENDING` status during an Amazon ECS deployment.
`Long`	`getRunningCount ()` The number of tasks in the task set that are in the `RUNNING` status during an Amazon ECS deployment.
`String`	`getStatus ()` The status of the task set.
`TargetGroupInfo`	`getTargetGroup ()` The target group associated with the task set.
`String`	`getTaskSetLabel ()` A label that identifies whether the ECS task set is an original target (`BLUE`) or a replacement target (`GREEN`).
`Double`	`getTrafficWeight ()` The percentage of traffic served by this task set.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDesiredCount (Long desiredCount)` The number of tasks in a task set.
`void`	`setIdentifer (String identifer)` A unique ID of an `ECSTaskSet`.
`void`	`setPendingCount (Long pendingCount)` The number of tasks in the task set that are in the `PENDING` status during an Amazon ECS deployment.
`void`	`setRunningCount (Long runningCount)` The number of tasks in the task set that are in the `RUNNING` status during an Amazon ECS deployment.
`void`	`setStatus (String status)` The status of the task set.
`void`	`setTargetGroup (TargetGroupInfo targetGroup)` The target group associated with the task set.
`void`	`setTaskSetLabel (String taskSetLabel)` A label that identifies whether the ECS task set is an original target (`BLUE`) or a replacement target (`GREEN`).
`void`	`setTrafficWeight (Double trafficWeight)` The percentage of traffic served by this task set.
`String`	`toString ()` Returns a string representation of this object.
`ECSTaskSet`	`withDesiredCount (Long desiredCount)` The number of tasks in a task set.
`ECSTaskSet`	`withIdentifer (String identifer)` A unique ID of an `ECSTaskSet`.
`ECSTaskSet`	`withPendingCount (Long pendingCount)` The number of tasks in the task set that are in the `PENDING` status during an Amazon ECS deployment.
`ECSTaskSet`	`withRunningCount (Long runningCount)` The number of tasks in the task set that are in the `RUNNING` status during an Amazon ECS deployment.
`ECSTaskSet`	`withStatus (String status)` The status of the task set.
`ECSTaskSet`	`withTargetGroup (TargetGroupInfo targetGroup)` The target group associated with the task set.
`ECSTaskSet`	`withTaskSetLabel (String taskSetLabel)` A label that identifies whether the ECS task set is an original target (`BLUE`) or a replacement target (`GREEN`).
`ECSTaskSet`	`withTaskSetLabel (TargetLabel taskSetLabel)` A label that identifies whether the ECS task set is an original target (`BLUE`) or a replacement target (`GREEN`).
`ECSTaskSet`	`withTrafficWeight (Double trafficWeight)` The percentage of traffic served by this task set.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ECSTaskSet
```
public ECSTaskSet()
```
- Method Detail
  - setIdentifer
```
public void setIdentifer(String identifer)
```
    A unique ID of an ECSTaskSet.
    
    Parameters:
    
    identifer - A unique ID of an ECSTaskSet.
  - getIdentifer
```
public String getIdentifer()
```
    A unique ID of an ECSTaskSet.
    
    Returns:
    
    A unique ID of an ECSTaskSet.
  - withIdentifer
```
public ECSTaskSet withIdentifer(String identifer)
```
    A unique ID of an ECSTaskSet.
    
    Parameters:
    
    identifer - A unique ID of an ECSTaskSet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesiredCount
```
public void setDesiredCount(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.
    
    Parameters:
    
    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.
  - getDesiredCount
```
public Long getDesiredCount()
```
    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.
  - withDesiredCount
```
public ECSTaskSet withDesiredCount(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPendingCount
```
public void setPendingCount(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.
    
    Parameters:
    
    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.
  - getPendingCount
```
public Long getPendingCount()
```
    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.
  - withPendingCount
```
public ECSTaskSet withPendingCount(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRunningCount
```
public void setRunningCount(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.
    
    Parameters:
    
    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.
  - getRunningCount
```
public Long getRunningCount()
```
    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.
  - withRunningCount
```
public ECSTaskSet withRunningCount(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(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.
    Parameters:
    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.
  - getStatus
```
public String getStatus()
```
    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.
  - withStatus
```
public ECSTaskSet withStatus(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrafficWeight
```
public void setTrafficWeight(Double trafficWeight)
```
    The percentage of traffic served by this task set.
    
    Parameters:
    
    trafficWeight - The percentage of traffic served by this task set.
  - getTrafficWeight
```
public Double getTrafficWeight()
```
    The percentage of traffic served by this task set.
    
    Returns:
    
    The percentage of traffic served by this task set.
  - withTrafficWeight
```
public ECSTaskSet withTrafficWeight(Double trafficWeight)
```
    The percentage of traffic served by this task set.
    
    Parameters:
    
    trafficWeight - The percentage of traffic served by this task set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetGroup
```
public void setTargetGroup(TargetGroupInfo targetGroup)
```
    The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.
    
    Parameters:
    
    targetGroup - The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.
  - getTargetGroup
```
public TargetGroupInfo getTargetGroup()
```
    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.
  - withTargetGroup
```
public ECSTaskSet withTargetGroup(TargetGroupInfo targetGroup)
```
    The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.
    
    Parameters:
    
    targetGroup - The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskSetLabel
```
public void setTaskSetLabel(String taskSetLabel)
```
    A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
    
    Parameters:
    
    taskSetLabel - A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
    
    See Also:
    
    TargetLabel
  - getTaskSetLabel
```
public String getTaskSetLabel()
```
    A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
    
    Returns:
    
    A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
    
    See Also:
    
    TargetLabel
  - withTaskSetLabel
```
public ECSTaskSet withTaskSetLabel(String taskSetLabel)
```
    A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
    
    Parameters:
    
    taskSetLabel - A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetLabel
  - withTaskSetLabel
```
public ECSTaskSet withTaskSetLabel(TargetLabel taskSetLabel)
```
    A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
    
    Parameters:
    
    taskSetLabel - A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetLabel
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ECSTaskSet clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class ECSTaskSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ECSTaskSet

Method Detail

setIdentifer

getIdentifer

withIdentifer

setDesiredCount

getDesiredCount

withDesiredCount

setPendingCount

getPendingCount

withPendingCount

setRunningCount

getRunningCount

withRunningCount

setStatus

getStatus

withStatus

setTrafficWeight

getTrafficWeight

withTrafficWeight

setTargetGroup

getTargetGroup

withTargetGroup

setTaskSetLabel

getTaskSetLabel

withTaskSetLabel

withTaskSetLabel

toString

equals

hashCode

clone

marshall