@Generated(value="software.amazon.awssdk:codegen") public class ContainerInstance extends Object implements StructuredPojo, 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 actually connected to Amazon ECS. |
AgentUpdateStatus |
agentUpdateStatus()
The status of the most recent agent update.
|
String |
agentUpdateStatusString()
The status of the most recent agent update.
|
List<Attachment> |
attachments()
The Elastic Network Interfaces associated with the container instance.
|
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 |
containerInstanceArn()
The Amazon Resource Name (ARN) of the container instance.
|
String |
ec2InstanceId()
The EC2 instance ID of the container instance.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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 most resource types, this parameter describes the registered resources on the container instance that are in
use by current tasks.
|
List<Resource> |
remainingResources()
For most resource types, this parameter describes the remaining resources of the container instance that are
available for new tasks.
|
Integer |
runningTasksCount()
The number of tasks on the container instance that are in the
RUNNING status. |
static Class<? extends ContainerInstance.Builder> |
serializableBuilderClass() |
String |
status()
The status of the container instance.
|
ContainerInstance.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
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 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 String ec2InstanceId()
The EC2 instance ID of the container instance.
public 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 VersionInfo versionInfo()
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
public List<Resource> remainingResources()
For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; 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.
public List<Resource> registeredResources()
For most resource types, this parameter describes the registered resources on the container instance that are in use by current 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.
public String status()
The status of the container instance. The valid values are ACTIVE
, INACTIVE
, or
DRAINING
. ACTIVE
indicates that the container instance can accept tasks.
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 EC2 Container Service Developer Guide.
ACTIVE
, INACTIVE
, or
DRAINING
. ACTIVE
indicates that the container instance can accept tasks.
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 EC2 Container Service Developer Guide.public Boolean agentConnected()
This parameter returns true
if the agent is actually connected to Amazon ECS. Registered instances
with an agent that may be unhealthy or stopped return false
, and instances without a connected agent
cannot accept placement requests.
true
if the agent is actually connected to Amazon ECS. Registered
instances with an agent that may be unhealthy or stopped return false
, and instances without
a connected agent cannot accept placement requests.public Integer runningTasksCount()
The number of tasks on the container instance that are in the RUNNING
status.
RUNNING
status.public Integer pendingTasksCount()
The number of tasks on the container instance that are in the PENDING
status.
PENDING
status.public 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 agentUpdateStatusString()
.
NULL
.AgentUpdateStatus
public String agentUpdateStatusString()
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 agentUpdateStatusString()
.
NULL
.AgentUpdateStatus
public 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.
public Instant registeredAt()
The Unix timestamp for when the container instance was registered.
public List<Attachment> attachments()
The Elastic Network Interfaces associated with the container instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.