Package software.amazon.awssdk.services.ecs.model

Class DeregisterContainerInstanceRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ecs.model.DeregisterContainerInstanceRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DeregisterContainerInstanceRequest.Builder,DeregisterContainerInstanceRequest>

@Generated("software.amazon.awssdk:codegen")
public class DeregisterContainerInstanceRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DeregisterContainerInstanceRequest.Builder,DeregisterContainerInstanceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeregisterContainerInstanceRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DeregisterContainerInstanceRequest.Builder	builder()
String	cluster()	The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister.
String	containerInstance()	The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister.
boolean	equals(Object obj)
Boolean	force()	Forces the deregistration of the container instance.
int	hashCode()
static Class<? extends DeregisterContainerInstanceRequest.Builder>	serializableBuilderClass()
DeregisterContainerInstanceRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

cluster

public 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.

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.

containerInstance

public 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, 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 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, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

force

public 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 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.

Any containers in orphaned service tasks that are registered with a Classic load balancer or an Application load balancer target group are deregistered, and they will begin connection draining according to the settings on the load balancer or target group.

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 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.

Any containers in orphaned service tasks that are registered with a Classic load balancer or an Application load balancer target group are deregistered, and they will begin connection draining according to the settings on the load balancer or target group.

toBuilder

public DeregisterContainerInstanceRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeregisterContainerInstanceRequest.Builder,DeregisterContainerInstanceRequest>

Returns:

a builder for type T

builder

public static DeregisterContainerInstanceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeregisterContainerInstanceRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object