software.amazon.awssdk.services.ecs.model

Class ContainerInstance

java.lang.Object

software.amazon.awssdk.services.ecs.model.ContainerInstance

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ContainerInstance.Builder,ContainerInstance>

@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ContainerInstance.Builder

Method Summary

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 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()
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.
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()
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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

containerInstanceArn

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 .

Returns:

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 .

ec2InstanceId

public String ec2InstanceId()

The EC2 instance ID of the container instance.

Returns:

The EC2 instance ID of the container instance.

version

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.

Returns:

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.

versionInfo

public VersionInfo versionInfo()

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

Returns:

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

remainingResources

public 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.

Returns:

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.

registeredResources

public 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.

Returns:

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.

status

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 Elastic Container Service Developer Guide.

Returns:

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 Elastic Container Service Developer Guide.

agentConnected

public 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.

Returns:

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.

runningTasksCount

public Integer runningTasksCount()

The number of tasks on the container instance that are in the RUNNING status.

Returns:

The number of tasks on the container instance that are in the RUNNING status.

pendingTasksCount

public Integer pendingTasksCount()

The number of tasks on the container instance that are in the PENDING status.

Returns:

The number of tasks on the container instance that are in the PENDING status.

agentUpdateStatus

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 agentUpdateStatusAsString().

Returns:

The status of the most recent agent update. If an update has never been requested, this value is NULL.

See Also:

AgentUpdateStatus

agentUpdateStatusAsString

public 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().

Returns:

The status of the most recent agent update. If an update has never been requested, this value is NULL.

See Also:

AgentUpdateStatus

attributes

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.

Returns:

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

registeredAt

public Instant registeredAt()

The Unix timestamp for when the container instance was registered.

Returns:

The Unix timestamp for when the container instance was registered.

attachments

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.

Returns:

The elastic network interfaces associated with the container instance.

tags

public 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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

toBuilder

public ContainerInstance.Builder 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 interface ToCopyableBuilder<ContainerInstance.Builder,ContainerInstance>

Returns:

a builder for type T

builder

public static ContainerInstance.Builder builder()

serializableBuilderClass

public static Class<? extends ContainerInstance.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.