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

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::DeregisterContainerInstanceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster ⇒ String

  The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister.

• #container_instance ⇒ String

  The container instance ID or full ARN of the container instance to deregister.

• #force ⇒ Boolean

  Forces the container instance to be deregistered.

Instance Attribute Details

#cluster ⇒ String

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)

# File 'lib/aws-sdk-ecs/types.rb', line 4091

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

#container_instance ⇒ String

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*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 4091

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

#force ⇒ Boolean

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)

# File 'lib/aws-sdk-ecs/types.rb', line 4091

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