@Generated(value="software.amazon.awssdk:codegen") public final class TaskSet extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TaskSet.Builder,TaskSet>
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL
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.
Modifier and Type | Class and Description |
---|---|
static interface |
TaskSet.Builder |
Modifier and Type | Method and Description |
---|---|
static TaskSet.Builder |
builder() |
List<CapacityProviderStrategyItem> |
capacityProviderStrategy()
The capacity provider strategy associated with the task set.
|
String |
clusterArn()
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
|
Integer |
computedDesiredCount()
The computed desired count for the task set.
|
Instant |
createdAt()
The Unix timestamp for when the task set was created.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
externalId()
The external ID associated with the task set.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCapacityProviderStrategy()
Returns true if the CapacityProviderStrategy property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasLoadBalancers()
Returns true if the LoadBalancers property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasServiceRegistries()
Returns true if the ServiceRegistries property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
String |
id()
The ID of the task set.
|
LaunchType |
launchType()
The launch type the tasks in the task set are using.
|
String |
launchTypeAsString()
The launch type the tasks in the task set are using.
|
List<LoadBalancer> |
loadBalancers()
Details on a load balancer that is used with a task set.
|
NetworkConfiguration |
networkConfiguration()
The network configuration for the task set.
|
Integer |
pendingCount()
The number of tasks in the task set that are in the
PENDING status during a deployment. |
String |
platformVersion()
The platform version on which the tasks in the task set are running.
|
Integer |
runningCount()
The number of tasks in the task set that are in the
RUNNING status during a deployment. |
Scale |
scale()
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends TaskSet.Builder> |
serializableBuilderClass() |
String |
serviceArn()
The Amazon Resource Name (ARN) of the service the task set exists in.
|
List<ServiceRegistry> |
serviceRegistries()
The details of the service discovery registries to assign to this task set.
|
StabilityStatus |
stabilityStatus()
The stability status, which indicates whether the task set has reached a steady state.
|
String |
stabilityStatusAsString()
The stability status, which indicates whether the task set has reached a steady state.
|
Instant |
stabilityStatusAt()
The Unix timestamp for when the task set stability status was retrieved.
|
String |
startedBy()
The tag specified when a task set is started.
|
String |
status()
The status of the task set.
|
List<Tag> |
tags()
The metadata that you apply to the task set to help you categorize and organize them.
|
String |
taskDefinition()
The task definition the task set is using.
|
String |
taskSetArn()
The Amazon Resource Name (ARN) of the task set.
|
TaskSet.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Instant |
updatedAt()
The Unix timestamp for when the task set was last updated.
|
copy
public final String id()
The ID of the task set.
public final String taskSetArn()
The Amazon Resource Name (ARN) of the task set.
public final String serviceArn()
The Amazon Resource Name (ARN) of the service the task set exists in.
public final String clusterArn()
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
public final String startedBy()
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the
startedBy
parameter is CODE_DEPLOY
. For a task set created for an external deployment,
the startedBy field isn't used.
startedBy
parameter is CODE_DEPLOY
. For a task set created for an external
deployment, the startedBy field isn't used.public final String externalId()
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId
parameter contains the AWS
CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the
externalId
parameter contains the ECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map attribute.
If a task set is created by an AWS CodeDeploy deployment, the externalId
parameter contains
the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry,
the externalId
parameter contains the ECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map
attribute.
public final String status()
The status of the task set. The following describes each state:
The task set is serving production traffic.
The task set is not serving production traffic.
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
The task set is serving production traffic.
The task set is not serving production traffic.
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
public final String taskDefinition()
The task definition the task set is using.
public final Integer computedDesiredCount()
The computed desired count for the task set. This is calculated by multiplying the service's
desiredCount
by the task set's scale
percentage. The result is always rounded up. For
example, if the computed desired count is 1.2, it rounds up to 2 tasks.
desiredCount
by the task set's scale
percentage. The result is always rounded
up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.public final Integer pendingCount()
The number of tasks in the task set that are in the PENDING
status during a 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.
PENDING
status during a 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.public final Integer runningCount()
The number of tasks in the task set that are in the RUNNING
status during a deployment. A task in
the RUNNING
state is running and ready for use.
RUNNING
status during a deployment. A
task in the RUNNING
state is running and ready for use.public final Instant createdAt()
The Unix timestamp for when the task set was created.
public final Instant updatedAt()
The Unix timestamp for when the task set was last updated.
public final LaunchType launchType()
The launch type the tasks in the task set 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()
.
LaunchType
public final String launchTypeAsString()
The launch type the tasks in the task set 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()
.
LaunchType
public final boolean hasCapacityProviderStrategy()
public final List<CapacityProviderStrategyItem> capacityProviderStrategy()
The capacity provider strategy associated with the task set.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasCapacityProviderStrategy()
to see if a value was sent in this field.
public final String platformVersion()
The platform version on which the tasks in the task set are running. A platform version is only specified for
tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by
default. For more information, see AWS Fargate Platform
Versions in the Amazon Elastic Container Service Developer Guide.
LATEST
platform
version is used by default. For more information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.public final NetworkConfiguration networkConfiguration()
The network configuration for the task set.
public final boolean hasLoadBalancers()
public final List<LoadBalancer> loadBalancers()
Details on a load balancer that is used with a task set.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasLoadBalancers()
to see if a value was sent in this field.
public final boolean hasServiceRegistries()
public final List<ServiceRegistry> serviceRegistries()
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasServiceRegistries()
to see if a value was sent in this field.
public final Scale scale()
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
public final StabilityStatus stabilityStatus()
The stability status, which indicates whether the task set has reached a steady state. If the following
conditions are met, the task set will be in STEADY_STATE
:
The task runningCount
is equal to the computedDesiredCount
.
The pendingCount
is 0
.
There are no tasks running on container instances in the DRAINING
status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns STABILIZING
.
If the service returns an enum value that is not available in the current SDK version, stabilityStatus
will return StabilityStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from stabilityStatusAsString()
.
STEADY_STATE
:
The task runningCount
is equal to the computedDesiredCount
.
The pendingCount
is 0
.
There are no tasks running on container instances in the DRAINING
status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns STABILIZING
.
StabilityStatus
public final String stabilityStatusAsString()
The stability status, which indicates whether the task set has reached a steady state. If the following
conditions are met, the task set will be in STEADY_STATE
:
The task runningCount
is equal to the computedDesiredCount
.
The pendingCount
is 0
.
There are no tasks running on container instances in the DRAINING
status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns STABILIZING
.
If the service returns an enum value that is not available in the current SDK version, stabilityStatus
will return StabilityStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from stabilityStatusAsString()
.
STEADY_STATE
:
The task runningCount
is equal to the computedDesiredCount
.
The pendingCount
is 0
.
There are no tasks running on container instances in the DRAINING
status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns STABILIZING
.
StabilityStatus
public final Instant stabilityStatusAt()
The Unix timestamp for when the task set stability status was retrieved.
public final boolean hasTags()
public final List<Tag> tags()
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for
either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
prefix. Tags with this prefix do not count against your tags per resource limit.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a
prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or
values with this prefix. Tags with this prefix do not count against your tags per resource limit.
public TaskSet.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<TaskSet.Builder,TaskSet>
public static TaskSet.Builder builder()
public static Class<? extends TaskSet.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.