ContainerInstance (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.ContainerInstance

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ContainerInstance
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ContainerInstance()

Constructors
Constructor and Description
`ContainerInstance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContainerInstance`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAgentConnected()` This parameter returns `true` if the agent is connected to Amazon ECS.
`String`	`getAgentUpdateStatus()` The status of the most recent agent update.
`List<Attachment>`	`getAttachments()` The resources attached to a container instance, such as elastic network interfaces.
`List<Attribute>`	`getAttributes()` The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
`String`	`getCapacityProviderName()` The capacity provider associated with the container instance.
`String`	`getContainerInstanceArn()` The Amazon Resource Name (ARN) of the container instance.
`String`	`getEc2InstanceId()` The ID of the container instance.
`Integer`	`getPendingTasksCount()` The number of tasks on the container instance that are in the `PENDING` status.
`Date`	`getRegisteredAt()` The Unix timestamp for when the container instance was registered.
`List<Resource>`	`getRegisteredResources()` 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>`	`getRemainingResources()` 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`	`getRunningTasksCount()` The number of tasks on the container instance that are in the `RUNNING` status.
`String`	`getStatus()` The status of the container instance.
`String`	`getStatusReason()` The reason that the container instance reached its current status.
`List<Tag>`	`getTags()` The metadata that you apply to the container instance to help you categorize and organize them.
`Long`	`getVersion()` The version counter for the container instance.
`VersionInfo`	`getVersionInfo()` The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
`int`	`hashCode()`
`Boolean`	`isAgentConnected()` This parameter returns `true` if the agent is connected to Amazon ECS.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAgentConnected(Boolean agentConnected)` This parameter returns `true` if the agent is connected to Amazon ECS.
`void`	`setAgentUpdateStatus(AgentUpdateStatus agentUpdateStatus)` The status of the most recent agent update.
`void`	`setAgentUpdateStatus(String agentUpdateStatus)` The status of the most recent agent update.
`void`	`setAttachments(Collection<Attachment> attachments)` The resources attached to a container instance, such as elastic network interfaces.
`void`	`setAttributes(Collection<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.
`void`	`setCapacityProviderName(String capacityProviderName)` The capacity provider associated with the container instance.
`void`	`setContainerInstanceArn(String containerInstanceArn)` The Amazon Resource Name (ARN) of the container instance.
`void`	`setEc2InstanceId(String ec2InstanceId)` The ID of the container instance.
`void`	`setPendingTasksCount(Integer pendingTasksCount)` The number of tasks on the container instance that are in the `PENDING` status.
`void`	`setRegisteredAt(Date registeredAt)` The Unix timestamp for when the container instance was registered.
`void`	`setRegisteredResources(Collection<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.
`void`	`setRemainingResources(Collection<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.
`void`	`setRunningTasksCount(Integer runningTasksCount)` The number of tasks on the container instance that are in the `RUNNING` status.
`void`	`setStatus(String status)` The status of the container instance.
`void`	`setStatusReason(String statusReason)` The reason that the container instance reached its current status.
`void`	`setTags(Collection<Tag> tags)` The metadata that you apply to the container instance to help you categorize and organize them.
`void`	`setVersion(Long version)` The version counter for the container instance.
`void`	`setVersionInfo(VersionInfo versionInfo)` The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
`String`	`toString()` Returns a string representation of this object.
`ContainerInstance`	`withAgentConnected(Boolean agentConnected)` This parameter returns `true` if the agent is connected to Amazon ECS.
`ContainerInstance`	`withAgentUpdateStatus(AgentUpdateStatus agentUpdateStatus)` The status of the most recent agent update.
`ContainerInstance`	`withAgentUpdateStatus(String agentUpdateStatus)` The status of the most recent agent update.
`ContainerInstance`	`withAttachments(Attachment... attachments)` The resources attached to a container instance, such as elastic network interfaces.
`ContainerInstance`	`withAttachments(Collection<Attachment> attachments)` The resources attached to a container instance, such as elastic network interfaces.
`ContainerInstance`	`withAttributes(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.
`ContainerInstance`	`withAttributes(Collection<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.
`ContainerInstance`	`withCapacityProviderName(String capacityProviderName)` The capacity provider associated with the container instance.
`ContainerInstance`	`withContainerInstanceArn(String containerInstanceArn)` The Amazon Resource Name (ARN) of the container instance.
`ContainerInstance`	`withEc2InstanceId(String ec2InstanceId)` The ID of the container instance.
`ContainerInstance`	`withPendingTasksCount(Integer pendingTasksCount)` The number of tasks on the container instance that are in the `PENDING` status.
`ContainerInstance`	`withRegisteredAt(Date registeredAt)` The Unix timestamp for when the container instance was registered.
`ContainerInstance`	`withRegisteredResources(Collection<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.
`ContainerInstance`	`withRegisteredResources(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.
`ContainerInstance`	`withRemainingResources(Collection<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.
`ContainerInstance`	`withRemainingResources(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.
`ContainerInstance`	`withRunningTasksCount(Integer runningTasksCount)` The number of tasks on the container instance that are in the `RUNNING` status.
`ContainerInstance`	`withStatus(String status)` The status of the container instance.
`ContainerInstance`	`withStatusReason(String statusReason)` The reason that the container instance reached its current status.
`ContainerInstance`	`withTags(Collection<Tag> tags)` The metadata that you apply to the container instance to help you categorize and organize them.
`ContainerInstance`	`withTags(Tag... tags)` The metadata that you apply to the container instance to help you categorize and organize them.
`ContainerInstance`	`withVersion(Long version)` The version counter for the container instance.
`ContainerInstance`	`withVersionInfo(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

- Constructor Detail
  - ContainerInstance
```
public ContainerInstance()
```
- Method Detail
  - setContainerInstanceArn
```
public void setContainerInstanceArn(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.
    
    Parameters:
    
    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.
  - getContainerInstanceArn
```
public String getContainerInstanceArn()
```
    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.
  - withContainerInstanceArn
```
public ContainerInstance withContainerInstanceArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEc2InstanceId
```
public void setEc2InstanceId(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.
    
    Parameters:
    
    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.
  - getEc2InstanceId
```
public String getEc2InstanceId()
```
    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.
  - withEc2InstanceId
```
public ContainerInstance withEc2InstanceId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCapacityProviderName
```
public void setCapacityProviderName(String capacityProviderName)
```
    The capacity provider associated with the container instance.
    
    Parameters:
    
    capacityProviderName - The capacity provider associated with the container instance.
  - getCapacityProviderName
```
public String getCapacityProviderName()
```
    The capacity provider associated with the container instance.
    
    Returns:
    
    The capacity provider associated with the container instance.
  - withCapacityProviderName
```
public ContainerInstance withCapacityProviderName(String capacityProviderName)
```
    The capacity provider associated with the container instance.
    
    Parameters:
    
    capacityProviderName - The capacity provider associated with the container instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(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.
    
    Parameters:
    
    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.
  - getVersion
```
public Long getVersion()
```
    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.
  - withVersion
```
public ContainerInstance withVersion(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersionInfo
```
public void setVersionInfo(VersionInfo versionInfo)
```
    The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
    
    Parameters:
    
    versionInfo - The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
  - getVersionInfo
```
public VersionInfo getVersionInfo()
```
    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.
  - withVersionInfo
```
public ContainerInstance withVersionInfo(VersionInfo versionInfo)
```
    The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
    
    Parameters:
    
    versionInfo - The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRemainingResources
```
public List<Resource> getRemainingResources()
```
    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.
    
    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.
  - setRemainingResources
```
public void setRemainingResources(Collection<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.
    
    Parameters:
    
    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.
  - withRemainingResources
```
public ContainerInstance withRemainingResources(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setRemainingResources(java.util.Collection) or withRemainingResources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRemainingResources
```
public ContainerInstance withRemainingResources(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRegisteredResources
```
public List<Resource> getRegisteredResources()
```
    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.
    
    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.
  - setRegisteredResources
```
public void setRegisteredResources(Collection<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.
    
    Parameters:
    
    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.
  - withRegisteredResources
```
public ContainerInstance withRegisteredResources(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setRegisteredResources(java.util.Collection) or withRegisteredResources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRegisteredResources
```
public ContainerInstance withRegisteredResources(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(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.
    
    Parameters:
    
    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.
  - getStatus
```
public String getStatus()
```
    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.
  - withStatus
```
public ContainerInstance withStatus(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    The reason that the container instance reached its current status.
    
    Parameters:
    
    statusReason - The reason that the container instance reached its current status.
  - getStatusReason
```
public String getStatusReason()
```
    The reason that the container instance reached its current status.
    
    Returns:
    
    The reason that the container instance reached its current status.
  - withStatusReason
```
public ContainerInstance withStatusReason(String statusReason)
```
    The reason that the container instance reached its current status.
    
    Parameters:
    
    statusReason - The reason that the container instance reached its current status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentConnected
```
public void setAgentConnected(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.
    
    Parameters:
    
    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.
  - getAgentConnected
```
public Boolean getAgentConnected()
```
    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.
  - withAgentConnected
```
public ContainerInstance withAgentConnected(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAgentConnected
```
public Boolean isAgentConnected()
```
    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.
  - setRunningTasksCount
```
public void setRunningTasksCount(Integer runningTasksCount)
```
    The number of tasks on the container instance that are in the RUNNING status.
    
    Parameters:
    
    runningTasksCount - The number of tasks on the container instance that are in the RUNNING status.
  - getRunningTasksCount
```
public Integer getRunningTasksCount()
```
    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.
  - withRunningTasksCount
```
public ContainerInstance withRunningTasksCount(Integer runningTasksCount)
```
    The number of tasks on the container instance that are in the RUNNING status.
    
    Parameters:
    
    runningTasksCount - The number of tasks on the container instance that are in the RUNNING status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPendingTasksCount
```
public void setPendingTasksCount(Integer pendingTasksCount)
```
    The number of tasks on the container instance that are in the PENDING status.
    
    Parameters:
    
    pendingTasksCount - The number of tasks on the container instance that are in the PENDING status.
  - getPendingTasksCount
```
public Integer getPendingTasksCount()
```
    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.
  - withPendingTasksCount
```
public ContainerInstance withPendingTasksCount(Integer pendingTasksCount)
```
    The number of tasks on the container instance that are in the PENDING status.
    
    Parameters:
    
    pendingTasksCount - The number of tasks on the container instance that are in the PENDING status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentUpdateStatus
```
public void setAgentUpdateStatus(String agentUpdateStatus)
```
    The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    Parameters:
    
    agentUpdateStatus - The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    See Also:
    
    AgentUpdateStatus
  - getAgentUpdateStatus
```
public String getAgentUpdateStatus()
```
    The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    Returns:
    
    The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    See Also:
    
    AgentUpdateStatus
  - withAgentUpdateStatus
```
public ContainerInstance withAgentUpdateStatus(String agentUpdateStatus)
```
    The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    Parameters:
    
    agentUpdateStatus - The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AgentUpdateStatus
  - setAgentUpdateStatus
```
public void setAgentUpdateStatus(AgentUpdateStatus agentUpdateStatus)
```
    The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    Parameters:
    
    agentUpdateStatus - The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    See Also:
    
    AgentUpdateStatus
  - withAgentUpdateStatus
```
public ContainerInstance withAgentUpdateStatus(AgentUpdateStatus agentUpdateStatus)
```
    The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    Parameters:
    
    agentUpdateStatus - The status of the most recent agent update. If an update has never been requested, this value is NULL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AgentUpdateStatus
  - getAttributes
```
public List<Attribute> getAttributes()
```
    The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
    
    Returns:
    
    The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
  - setAttributes
```
public void setAttributes(Collection<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.
    
    Parameters:
    
    attributes - The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
  - withAttributes
```
public ContainerInstance withAttributes(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttributes(java.util.Collection) or withAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attributes - The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttributes
```
public ContainerInstance withAttributes(Collection<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.
    
    Parameters:
    
    attributes - The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegisteredAt
```
public void setRegisteredAt(Date registeredAt)
```
    The Unix timestamp for when the container instance was registered.
    
    Parameters:
    
    registeredAt - The Unix timestamp for when the container instance was registered.
  - getRegisteredAt
```
public Date getRegisteredAt()
```
    The Unix timestamp for when the container instance was registered.
    
    Returns:
    
    The Unix timestamp for when the container instance was registered.
  - withRegisteredAt
```
public ContainerInstance withRegisteredAt(Date registeredAt)
```
    The Unix timestamp for when the container instance was registered.
    
    Parameters:
    
    registeredAt - The Unix timestamp for when the container instance was registered.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttachments
```
public List<Attachment> getAttachments()
```
    The resources attached to a container instance, such as elastic network interfaces.
    
    Returns:
    
    The resources attached to a container instance, such as elastic network interfaces.
  - setAttachments
```
public void setAttachments(Collection<Attachment> attachments)
```
    The resources attached to a container instance, such as elastic network interfaces.
    
    Parameters:
    
    attachments - The resources attached to a container instance, such as elastic network interfaces.
  - withAttachments
```
public ContainerInstance withAttachments(Attachment... attachments)
```
    The resources attached to a container instance, such as elastic network interfaces.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttachments(java.util.Collection) or withAttachments(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    attachments - The resources attached to a container instance, such as elastic network interfaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttachments
```
public ContainerInstance withAttachments(Collection<Attachment> attachments)
```
    The resources attached to a container instance, such as elastic network interfaces.
    
    Parameters:
    
    attachments - The resources attached to a container instance, such as elastic network interfaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    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.
    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.
  - setTags
```
public void setTags(Collection<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.
    Parameters:
    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.
  - withTags
```
public ContainerInstance withTags(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.
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public ContainerInstance withTags(Collection<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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ContainerInstance clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ContainerInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContainerInstance

Method Detail

setContainerInstanceArn

getContainerInstanceArn

withContainerInstanceArn

setEc2InstanceId

getEc2InstanceId

withEc2InstanceId

setCapacityProviderName

getCapacityProviderName

withCapacityProviderName

setVersion

getVersion

withVersion

setVersionInfo

getVersionInfo

withVersionInfo

getRemainingResources

setRemainingResources

withRemainingResources

withRemainingResources

getRegisteredResources

setRegisteredResources

withRegisteredResources

withRegisteredResources

setStatus

getStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setAgentConnected

getAgentConnected

withAgentConnected

isAgentConnected

setRunningTasksCount

getRunningTasksCount

withRunningTasksCount

setPendingTasksCount

getPendingTasksCount

withPendingTasksCount

setAgentUpdateStatus

getAgentUpdateStatus

withAgentUpdateStatus

setAgentUpdateStatus

withAgentUpdateStatus

getAttributes

setAttributes

withAttributes

withAttributes

setRegisteredAt

getRegisteredAt

withRegisteredAt

getAttachments

setAttachments

withAttachments

withAttachments

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall