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)


283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 283

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings)
  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)


283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 283

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

#cluster_nameString

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

Returns:

  • (String)


283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 283

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

#pending_tasks_countInteger

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

Returns:

  • (Integer)


283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 283

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

#registered_container_instances_countInteger

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

Returns:

  • (Integer)


283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 283

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

#running_tasks_countInteger

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

Returns:

  • (Integer)


283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 283

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

#settingsArray<Types::ClusterSetting>

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Returns:



283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 283

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings)
  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:



283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 283

class Cluster < Struct.new(
  :cluster_arn,
  :cluster_name,
  :status,
  :registered_container_instances_count,
  :running_tasks_count,
  :pending_tasks_count,
  :active_services_count,
  :statistics,
  :tags,
  :settings)
  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)


283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 283

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

#tagsArray<Types::Tag>

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:



283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 283

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