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

Interface DeregisterContainerInstanceRequest.Builder

    • Method Detail

      • cluster

        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.

        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.

      • containerInstance

        DeregisterContainerInstanceRequest.Builder containerInstance​(String containerInstance)

        The container instance ID or full ARN of the container instance to deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

        Parameters:
        containerInstance - The container instance ID or full ARN of the container instance to deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • force

        DeregisterContainerInstanceRequest.Builder force​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.