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

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
}

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)


4159
4160
4161
4162
4163
4164
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4159

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

#container_instancesArray<String>

A list of container instance IDs or full Amazon Resource Name (ARN) entries.

Returns:

  • (Array<String>)


4159
4160
4161
4162
4163
4164
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4159

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

#statusString

The container instance state with which to update the container instance.

Returns:

  • (String)


4159
4160
4161
4162
4163
4164
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4159

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