You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/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,
}

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)


1425
1426
1427
1428
1429
1430
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1425

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

#container_instanceString

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:

  • (String)


1425
1426
1427
1428
1429
1430
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1425

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

#forceBoolean

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:

  • (Boolean)


1425
1426
1427
1428
1429
1430
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1425

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