Class ContainerInstance
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ContainerInstance.Builder,
ContainerInstance>
An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered with a cluster.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
This parameter returnstrue
if the agent is connected to Amazon ECS.final AgentUpdateStatus
The status of the most recent agent update.final String
The status of the most recent agent update.final List
<Attachment> The resources attached to a container instance, such as an elastic network interface.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()
final String
The capacity provider that's associated with the container instance.final String
The Amazon Resource Name (ARN) of the container instance.final String
The ID of the container instance.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Attachments property.final boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RegisteredResources property.final boolean
For responses, this returns true if the service returned a value for the RemainingResources property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.An object representing the health status of the container instance.final Integer
The number of tasks on the container instance that are in thePENDING
status.final Instant
The Unix timestamp for the time when the container instance was registered.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.For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already allocated to tasks and is therefore available for new tasks.final Integer
The number of tasks on the container instance that have a desired status (desiredStatus
) ofRUNNING
.static Class
<? extends ContainerInstance.Builder> final String
status()
The status of the container instance.final String
The reason that the container instance reached its current status.tags()
The metadata that you apply to the container instance to help you categorize and organize them.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Long
version()
The version counter for the container instance.final VersionInfo
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
containerInstanceArn
The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
- Returns:
- The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
-
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
The capacity provider that's associated with the container instance.
- Returns:
- The capacity provider that's associated with the container instance.
-
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're 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're 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
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 theisEmpty()
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
For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't already 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
orbridge
network mode). Any port that's 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 wasn't
already 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
orbridge
network mode). Any port that's 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 theisEmpty()
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
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
The status of the container instance. The valid values are
REGISTERING
,REGISTRATION_FAILED
,ACTIVE
,INACTIVE
,DEREGISTERING
, orDRAINING
.If your account has opted in to the
awsvpcTrunking
account setting, then any newly registered container instance will transition to aREGISTERING
status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to aREGISTRATION_FAILED
status. You can describe the container instance and see the reason for failure in thestatusReason
parameter. Once the container instance is terminated, the instance transitions to aDEREGISTERING
status while the trunk elastic network interface is deprovisioned. The instance then transitions to anINACTIVE
status.The
ACTIVE
status indicates that the container instance can accept tasks. TheDRAINING
indicates that new tasks aren't 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
, orDRAINING
.If your account has opted in to the
awsvpcTrunking
account setting, then any newly registered container instance will transition to aREGISTERING
status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to aREGISTRATION_FAILED
status. You can describe the container instance and see the reason for failure in thestatusReason
parameter. Once the container instance is terminated, the instance transitions to aDEREGISTERING
status while the trunk elastic network interface is deprovisioned. The instance then transitions to anINACTIVE
status.The
ACTIVE
status indicates that the container instance can accept tasks. TheDRAINING
indicates that new tasks aren't 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
The reason that the container instance reached its current status.
- Returns:
- The reason that the container instance reached its current status.
-
agentConnected
This parameter returns
true
if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped returnfalse
. Only instances connected to an agent can accept task placement requests.- Returns:
- This parameter returns
true
if the agent is connected to Amazon ECS. An instance with an agent that may be unhealthy or stopped returnfalse
. Only instances connected to an agent can accept task placement requests.
-
runningTasksCount
The number of tasks on the container instance that have a desired status (
desiredStatus
) ofRUNNING
.- Returns:
- The number of tasks on the container instance that have a desired status (
desiredStatus
) ofRUNNING
.
-
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
The status of the most recent agent update. If an update wasn't ever requested, this value is
NULL
.If the service returns an enum value that is not available in the current SDK version,
agentUpdateStatus
will returnAgentUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromagentUpdateStatusAsString()
.- Returns:
- The status of the most recent agent update. If an update wasn't ever requested, this value is
NULL
. - See Also:
-
agentUpdateStatusAsString
The status of the most recent agent update. If an update wasn't ever requested, this value is
NULL
.If the service returns an enum value that is not available in the current SDK version,
agentUpdateStatus
will returnAgentUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromagentUpdateStatusAsString()
.- Returns:
- The status of the most recent agent update. If an update wasn't ever requested, this value is
NULL
. - See Also:
-
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 theisEmpty()
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
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
The Unix timestamp for the time when the container instance was registered.
- Returns:
- The Unix timestamp for the time 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 theisEmpty()
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
The resources attached to a container instance, such as an elastic network interface.
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 an elastic network interface.
-
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 theisEmpty()
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
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. You define both.
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. You define both.
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.
-
-
-
healthStatus
An object representing the health status of the container instance.
- Returns:
- An object representing the health status of the container instance.
-
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 interfaceToCopyableBuilder<ContainerInstance.Builder,
ContainerInstance> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-