@Generated(value="software.amazon.awssdk:codegen") public final class ContainerInstance extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContainerInstance.Builder,ContainerInstance>
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
Modifier and Type | Class and Description |
---|---|
static interface |
ContainerInstance.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
agentConnected()
This parameter returns
true if the agent is connected to Amazon ECS. |
AgentUpdateStatus |
agentUpdateStatus()
The status of the most recent agent update.
|
String |
agentUpdateStatusAsString()
The status of the most recent agent update.
|
List<Attachment> |
attachments()
The resources attached to a container instance, such as elastic network interfaces.
|
List<Attribute> |
attributes()
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration
or manually with the PutAttributes operation.
|
static ContainerInstance.Builder |
builder() |
String |
capacityProviderName()
The capacity provider associated with the container instance.
|
String |
containerInstanceArn()
The Amazon Resource Name (ARN) of the container instance.
|
String |
ec2InstanceId()
The EC2 instance ID of the container instance.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAttachments()
Returns true if the Attachments 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 |
hasAttributes()
Returns true if the Attributes 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 |
hasRegisteredResources()
Returns true if the RegisteredResources 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 |
hasRemainingResources()
Returns true if the RemainingResources 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).
|
Integer |
pendingTasksCount()
The number of tasks on the container instance that are in the
PENDING status. |
Instant |
registeredAt()
The Unix timestamp for when the container instance was registered.
|
List<Resource> |
registeredResources()
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the
container instance when the container agent registered it with Amazon ECS.
|
List<Resource> |
remainingResources()
For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already
been allocated to tasks and is therefore available for new tasks.
|
Integer |
runningTasksCount()
The number of tasks on the container instance that are in the
RUNNING status. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ContainerInstance.Builder> |
serializableBuilderClass() |
String |
status()
The status of the container instance.
|
String |
statusReason()
The reason that the container instance reached its current status.
|
List<Tag> |
tags()
The metadata that you apply to the container instance to help you categorize and organize them.
|
ContainerInstance.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.
|
Long |
version()
The version counter for the container instance.
|
VersionInfo |
versionInfo()
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
|
copy
public final String containerInstanceArn()
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner,
the container-instance
namespace, and then the container instance ID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance
owner, the container-instance
namespace, and then the container instance ID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.public final String ec2InstanceId()
The EC2 instance ID of the container instance.
public final String capacityProviderName()
The capacity provider associated with the container instance.
public final Long version()
The version counter for the container instance. Every time a container instance experiences a change that
triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container
instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon
ECS APIs with the version reported in CloudWatch Events for the container instance (inside the
detail
object) to verify that the version in your event stream is current.
detail
object) to verify that the version in your event stream is current.public final VersionInfo versionInfo()
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
public final boolean hasRemainingResources()
public final List<Resource> remainingResources()
For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already
been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter
describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any
task containers that have reserved port mappings on the host (with the host
or bridge
network mode). Any port that is not specified here is available for new tasks.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasRemainingResources()
to see if a value was sent in this field.
host
or bridge
network mode). Any port that is not specified here is available
for new tasks.public final boolean hasRegisteredResources()
public final List<Resource> registeredResources()
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasRegisteredResources()
to see if a value was sent in this field.
public final String status()
The status of the container instance. The valid values are REGISTERING
,
REGISTRATION_FAILED
, ACTIVE
, INACTIVE
, DEREGISTERING
, or
DRAINING
.
If your account has opted in to the awsvpcTrunking
account setting, then any newly registered
container instance will transition to a REGISTERING
status while the trunk elastic network interface
is provisioned for the instance. If the registration fails, the instance will transition to a
REGISTRATION_FAILED
status. You can describe the container instance and see the reason for failure
in the statusReason
parameter. Once the container instance is terminated, the instance transitions
to a DEREGISTERING
status while the trunk elastic network interface is deprovisioned. The instance
then transitions to an INACTIVE
status.
The ACTIVE
status indicates that the container instance can accept tasks. The DRAINING
indicates that new tasks are not placed on the container instance and any service tasks running on the container
instance are removed if possible. For more information, see Container
Instance Draining in the Amazon Elastic Container Service Developer Guide.
REGISTERING
,
REGISTRATION_FAILED
, ACTIVE
, INACTIVE
, DEREGISTERING
,
or DRAINING
.
If your account has opted in to the awsvpcTrunking
account setting, then any newly
registered container instance will transition to a REGISTERING
status while the trunk
elastic network interface is provisioned for the instance. If the registration fails, the instance will
transition to a REGISTRATION_FAILED
status. You can describe the container instance and see
the reason for failure in the statusReason
parameter. Once the container instance is
terminated, the instance transitions to a DEREGISTERING
status while the trunk elastic
network interface is deprovisioned. The instance then transitions to an INACTIVE
status.
The ACTIVE
status indicates that the container instance can accept tasks. The
DRAINING
indicates that new tasks are not placed on the container instance and any service
tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.
public final String statusReason()
The reason that the container instance reached its current status.
public final Boolean agentConnected()
This parameter returns true
if the agent is connected to Amazon ECS. Registered instances with an
agent that may be unhealthy or stopped return false
. Only instances connected to an agent can accept
placement requests.
true
if the agent is connected to Amazon ECS. Registered instances
with an agent that may be unhealthy or stopped return false
. Only instances connected to an
agent can accept placement requests.public final Integer runningTasksCount()
The number of tasks on the container instance that are in the RUNNING
status.
RUNNING
status.public final Integer pendingTasksCount()
The number of tasks on the container instance that are in the PENDING
status.
PENDING
status.public final AgentUpdateStatus agentUpdateStatus()
The status of the most recent agent update. If an update has never been requested, this value is
NULL
.
If the service returns an enum value that is not available in the current SDK version, agentUpdateStatus
will return AgentUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from agentUpdateStatusAsString()
.
NULL
.AgentUpdateStatus
public final String agentUpdateStatusAsString()
The status of the most recent agent update. If an update has never been requested, this value is
NULL
.
If the service returns an enum value that is not available in the current SDK version, agentUpdateStatus
will return AgentUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from agentUpdateStatusAsString()
.
NULL
.AgentUpdateStatus
public final boolean hasAttributes()
public final List<Attribute> attributes()
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
public final Instant registeredAt()
The Unix timestamp for when the container instance was registered.
public final boolean hasAttachments()
public final List<Attachment> attachments()
The resources attached to a container instance, such as elastic network interfaces.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttachments()
to see if a value was sent in this field.
public final boolean hasTags()
public final List<Tag> tags()
The metadata that you apply to the container instance 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 ContainerInstance.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ContainerInstance.Builder,ContainerInstance>
public static ContainerInstance.Builder builder()
public static Class<? extends ContainerInstance.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.