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

Class: Aws::ECS::Types::Cluster

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

Overview

A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

Instance Attribute Summary collapse

Instance Attribute Details

#active_services_countInteger

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

Returns:

  • (Integer)


221
222
223
224
225
226
227
228
229
230
231
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 221

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics)
  include Aws::Structure
end

#cluster_arnString

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test..

Returns:

  • (String)


221
222
223
224
225
226
227
228
229
230
231
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 221

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics)
  include Aws::Structure
end

#cluster_nameString

A user-generated string that you use to identify your cluster.

Returns:

  • (String)


221
222
223
224
225
226
227
228
229
230
231
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 221

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics)
  include Aws::Structure
end

#pending_tasks_countInteger

The number of tasks in the cluster that are in the PENDING state.

Returns:

  • (Integer)


221
222
223
224
225
226
227
228
229
230
231
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 221

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics)
  include Aws::Structure
end

#registered_container_instances_countInteger

The number of container instances registered into the cluster.

Returns:

  • (Integer)


221
222
223
224
225
226
227
228
229
230
231
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 221

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics)
  include Aws::Structure
end

#running_tasks_countInteger

The number of tasks in the cluster that are in the RUNNING state.

Returns:

  • (Integer)


221
222
223
224
225
226
227
228
229
230
231
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 221

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics)
  include Aws::Structure
end

#statisticsArray<Types::KeyValuePair>

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Returns:



221
222
223
224
225
226
227
228
229
230
231
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 221

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics)
  include Aws::Structure
end

#statusString

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

Returns:

  • (String)


221
222
223
224
225
226
227
228
229
230
231
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 221

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics)
  include Aws::Structure
end