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
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DeregisterContainerInstanceRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 to deregister.String
getContainerInstance()
The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister.Boolean
getForce()
Forces the deregistration of the container instance.int
hashCode()
Boolean
isForce()
Forces 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 to deregister.void
setContainerInstance(String containerInstance)
The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister.void
setForce(Boolean force)
Forces 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 to deregister.DeregisterContainerInstanceRequest
withContainerInstance(String containerInstance)
The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister.DeregisterContainerInstanceRequest
withForce(Boolean force)
Forces the deregistration of the container instance.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setCluster
public void setCluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance 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 to deregister. If you do not specify a cluster, the default cluster is assumed.
-
getCluster
public String getCluster()
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance 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 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 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 to deregister. If you do not specify a cluster, the default cluster is assumed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setContainerInstance
public void setContainerInstance(String containerInstance)
The container instance ID or full Amazon Resource Name (ARN) of the container instance 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, thecontainer-instance
namespace, and then the container instance ID. For example,arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.- Parameters:
containerInstance
- The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister. The ARN contains thearn:aws:ecs
namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, thecontainer-instance
namespace, and then the container instance ID. For example,arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
-
getContainerInstance
public String getContainerInstance()
The container instance ID or full Amazon Resource Name (ARN) of the container instance 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, thecontainer-instance
namespace, and then the container instance ID. For example,arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.- Returns:
- The container instance ID or full Amazon Resource Name (ARN) of
the container instance 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, thecontainer-instance
namespace, and then the container instance ID. For example,arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
-
withContainerInstance
public DeregisterContainerInstanceRequest withContainerInstance(String containerInstance)
The container instance ID or full Amazon Resource Name (ARN) of the container instance 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, thecontainer-instance
namespace, and then the container instance ID. For example,arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.- Parameters:
containerInstance
- The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister. The ARN contains thearn:aws:ecs
namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, thecontainer-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.
-
setForce
public void setForce(Boolean force)
Forces 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 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 starts another copy of that task, on a different container instance if possible.- Parameters:
force
- Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with theforce
option, these tasks remain running and they 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 starts another copy of that task, on a different container instance if possible.
-
getForce
public Boolean getForce()
Forces 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 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 starts another copy of that task, on a different container instance if possible.- Returns:
- Forces 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 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 starts another copy of that task, on a different container instance if possible.
-
withForce
public DeregisterContainerInstanceRequest withForce(Boolean force)
Forces 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 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 starts another copy of that task, on a different container instance if possible.- Parameters:
force
- Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with theforce
option, these tasks remain running and they 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 starts another copy of that task, on a different container instance if possible.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isForce
public Boolean isForce()
Forces 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 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 starts another copy of that task, on a different container instance if possible.- Returns:
- Forces 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 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 starts 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-