AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ECS::Types::UpdateContainerInstancesStateRequest

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 UpdateContainerInstancesStateRequest data as a hash:

{
  cluster: "String",
  container_instances: ["String"], # required
  status: "ACTIVE", # required, accepts ACTIVE, DRAINING, REGISTERING, DEREGISTERING, REGISTRATION_FAILED
}

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 update. If you do not specify a cluster, the default cluster is assumed.

Returns:

  • (String)


10867
10868
10869
10870
10871
10872
10873
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10867

class UpdateContainerInstancesStateRequest < Struct.new(
  :cluster,
  :container_instances,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#container_instancesArray<String>

A list of container instance IDs or full ARN entries.

Returns:

  • (Array<String>)


10867
10868
10869
10870
10871
10872
10873
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10867

class UpdateContainerInstancesStateRequest < Struct.new(
  :cluster,
  :container_instances,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state.

Returns:

  • (String)


10867
10868
10869
10870
10871
10872
10873
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 10867

class UpdateContainerInstancesStateRequest < Struct.new(
  :cluster,
  :container_instances,
  :status)
  SENSITIVE = []
  include Aws::Structure
end