software.amazon.awssdk.services.ecs.model

Class DeregisterContainerInstanceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ecs.model.EcsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeregisterContainerInstanceRequest.Builder,DeregisterContainerInstanceRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeregisterContainerInstanceRequest.Builder

Method Summary

Modifier and Type	Method and 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 ARN of the container instance to deregister.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	force() Forces the container instance to be deregistered.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DeregisterContainerInstanceRequest.Builder>	serializableBuilderClass()
DeregisterContainerInstanceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

cluster

public final 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 final String containerInstance()

The container instance ID or full ARN of the container instance to deregister. 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 container instance ID or full ARN of the container instance to deregister. 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.

force

public final Boolean force()

Forces the container instance to be deregistered. 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're 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. They begin connection draining according to the settings on the load balancer or target group.

Returns:

Forces the container instance to be deregistered. 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're 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. They begin connection draining according to the settings on the load balancer or target group.

toBuilder

public DeregisterContainerInstanceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeregisterContainerInstanceRequest.Builder,DeregisterContainerInstanceRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static DeregisterContainerInstanceRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo