public static interface DeregisterContainerInstanceRequest.Builder extends ECSRequest.Builder, CopyableBuilder<DeregisterContainerInstanceRequest.Builder,DeregisterContainerInstanceRequest>
Modifier and Type | Method and Description |
---|---|
DeregisterContainerInstanceRequest.Builder |
cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to
deregister.
|
DeregisterContainerInstanceRequest.Builder |
containerInstance(String containerInstance)
The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister.
|
DeregisterContainerInstanceRequest.Builder |
force(Boolean force)
Forces the deregistration of the container instance.
|
DeregisterContainerInstanceRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
DeregisterContainerInstanceRequest.Builder cluster(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.
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.DeregisterContainerInstanceRequest.Builder containerInstance(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
.
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
.DeregisterContainerInstanceRequest.Builder force(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.
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.
DeregisterContainerInstanceRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.