com.amazonaws.services.ecs.model

Class DeregisterContainerInstanceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.DeregisterContainerInstanceRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DeregisterContainerInstanceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DeregisterContainerInstance operation.

Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

NOTE: When you terminate a container instance, it is automatically deregistered from your cluster.

See Also:

AmazonECS.deregisterContainerInstance(DeregisterContainerInstanceRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeregisterContainerInstanceRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DeregisterContainerInstanceRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister.
String	getContainerInstance() The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister.
Boolean	getForce() Force the deregistration of the container instance.
int	hashCode()
Boolean	isForce() Force the deregistration of the container instance.
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister.
void	setContainerInstance(String containerInstance) The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister.
void	setForce(Boolean force) Force the deregistration of the container instance.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeregisterContainerInstanceRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister.
DeregisterContainerInstanceRequest	withContainerInstance(String containerInstance) The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister.
DeregisterContainerInstanceRequest	withForce(Boolean force) Force the deregistration of the container instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeregisterContainerInstanceRequest

public DeregisterContainerInstanceRequest()

Method Detail

getCluster

public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.

setCluster

public void setCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.

withCluster

public DeregisterContainerInstanceRequest withCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.

Returns:

A reference to this updated object so that method calls can be chained together.

getContainerInstance

public String getContainerInstance()

The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

Returns:

The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

setContainerInstance

public void setContainerInstance(String containerInstance)

The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

Parameters:

containerInstance - The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

withContainerInstance

public DeregisterContainerInstanceRequest withContainerInstance(String containerInstance)

The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

Returns a reference to this object so that method calls can be chained together.

Parameters:

containerInstance - The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

Returns:

A reference to this updated object so that method calls can be chained together.

isForce

public Boolean isForce()

Force the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they will continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler will start another copy of that task on a different container instance if possible.

Returns:

Force the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they will continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler will start another copy of that task on a different container instance if possible.

setForce

public void setForce(Boolean force)

Force the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they will continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler will start another copy of that task on a different container instance if possible.

Parameters:

force - Force the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they will continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler will start another copy of that task on a different container instance if possible.

withForce

public DeregisterContainerInstanceRequest withForce(Boolean force)

Force the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they will continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler will start another copy of that task on a different container instance if possible.

Returns a reference to this object so that method calls can be chained together.

Parameters:

force - Force the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they will continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler will start another copy of that task on a different container instance if possible.

Returns:

A reference to this updated object so that method calls can be chained together.

getForce

public Boolean getForce()

Force the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they will continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler will start another copy of that task on a different container instance if possible.

Returns:

Force the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they will continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler will start another copy of that task on a different container instance if possible.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DeregisterContainerInstanceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()