Class: Aws::ECS::Types::DeregisterContainerInstanceRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass DeregisterContainerInstanceRequest data as a hash:

{
  cluster: "String",
  container_instance: "String", # required
  force: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#clusterString

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:

  • (String)

4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ecs/types.rb', line 4033

class DeregisterContainerInstanceRequest < Struct.new(
  :cluster,
  :container_instance,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#container_instanceString

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:

  • (String)

4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ecs/types.rb', line 4033

class DeregisterContainerInstanceRequest < Struct.new(
  :cluster,
  :container_instance,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#forceBoolean

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:

  • (Boolean)

4033
4034
4035
4036
4037
4038
4039
# File 'lib/aws-sdk-ecs/types.rb', line 4033

class DeregisterContainerInstanceRequest < Struct.new(
  :cluster,
  :container_instance,
  :force)
  SENSITIVE = []
  include Aws::Structure
end