Class ECSTaskSet
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ECSTaskSet.Builder
builder()
final Long
The number of tasks in a task set.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
A unique ID of anECSTaskSet
.final Long
The number of tasks in the task set that are in thePENDING
status during an Amazon ECS deployment.final Long
The number of tasks in the task set that are in theRUNNING
status during an Amazon ECS deployment.static Class
<? extends ECSTaskSet.Builder> final String
status()
The status of the task set.final TargetGroupInfo
The target group associated with the task set.final TargetLabel
A label that identifies whether the ECS task set is an original target (BLUE
) or a replacement target (GREEN
).final String
A label that identifies whether the ECS task set is an original target (BLUE
) or a replacement target (GREEN
).Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Double
The percentage of traffic served by this task set.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
identifer
A unique ID of an
ECSTaskSet
.- Returns:
- A unique ID of an
ECSTaskSet
.
-
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
The number of tasks in the task set that are in the
PENDING
status during an Amazon ECS deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time, or when it is restarted after being in theSTOPPED
state.- Returns:
- The number of tasks in the task set that are in the
PENDING
status during an Amazon ECS deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time, or when it is restarted after being in theSTOPPED
state.
-
runningCount
The number of tasks in the task set that are in the
RUNNING
status during an Amazon ECS deployment. A task in theRUNNING
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 theRUNNING
state is running and ready for use.
-
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
The percentage of traffic served by this task set.
- Returns:
- The percentage of traffic served by this task set.
-
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
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 returnTargetLabel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskSetLabelAsString()
.- Returns:
- A label that identifies whether the ECS task set is an original target (
BLUE
) or a replacement target (GREEN
). - See Also:
-
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 returnTargetLabel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskSetLabelAsString()
.- Returns:
- A label that identifies whether the ECS task set is an original target (
BLUE
) or a replacement target (GREEN
). - See Also:
-
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 interfaceToCopyableBuilder<ECSTaskSet.Builder,
ECSTaskSet> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-