ContainerInstance (AWS SDK for Java

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ContainerInstance.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 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()` For responses, this returns true if the service returned a value for the Attachments property.
`boolean`	`hasAttributes()` For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`boolean`	`hasRegisteredResources()` For responses, this returns true if the service returned a value for the RegisteredResources property.
`boolean`	`hasRemainingResources()` For responses, this returns true if the service returned a value for the RemainingResources property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`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.

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 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 Amazon Web Services 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 Amazon Web Services 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 final String ec2InstanceId()
```
    The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
    
    Returns:
    
    The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
  - capacityProviderName
```
public final String capacityProviderName()
```
    The capacity provider associated with the container instance.
    
    Returns:
    
    The capacity provider associated with the container instance.
  - version
```
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.
    
    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 final 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.
  - hasRemainingResources
```
public final boolean hasRemainingResources()
```
    For responses, this returns true if the service returned a value for the RemainingResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - remainingResources
```
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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRemainingResources() method.
    
    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.
  - hasRegisteredResources
```
public final boolean hasRegisteredResources()
```
    For responses, this returns true if the service returned a value for the RegisteredResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - registeredResources
```
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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRegisteredResources() method.
    
    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 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.
    
    Returns:
    
    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.
  - statusReason
```
public final String statusReason()
```
    The reason that the container instance reached its current status.
    
    Returns:
    
    The reason that the container instance reached its current status.
  - agentConnected
```
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.
    
    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 final 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 final 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 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().
    
    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 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().
    
    Returns:
    
    The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    See Also:
    
    AgentUpdateStatus
  - hasAttributes
```
public final boolean hasAttributes()
```
    For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - attributes
```
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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.
    
    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 final Instant registeredAt()
```
    The Unix timestamp for when the container instance was registered.
    
    Returns:
    
    The Unix timestamp for when the container instance was registered.
  - hasAttachments
```
public final boolean hasAttachments()
```
    For responses, this returns true if the service returned a value for the Attachments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - attachments
```
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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttachments() method.
    
    Returns:
    
    The resources attached to a container instance, such as elastic network interfaces.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
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 Amazon Web Services 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    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.
    
    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 Amazon Web Services 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.
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    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 an 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final 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.

AWS SDK for Java API Reference - 2.17.41

Class ContainerInstance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

containerInstanceArn

ec2InstanceId

capacityProviderName

version

versionInfo

hasRemainingResources

remainingResources

hasRegisteredResources

registeredResources

status

statusReason

agentConnected

runningTasksCount

pendingTasksCount

agentUpdateStatus

agentUpdateStatusAsString

hasAttributes

attributes

registeredAt

hasAttachments

attachments

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields