Class: Aws::ECS::Types::Cluster
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::Cluster
- Includes:
- Structure
- Defined in:
- 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
-
#active_services_count ⇒ Integer
The number of services that are running on the cluster in an ‘ACTIVE` state.
-
#cluster_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the cluster.
-
#cluster_name ⇒ String
A user-generated string that you use to identify your cluster.
-
#pending_tasks_count ⇒ Integer
The number of tasks in the cluster that are in the ‘PENDING` state.
-
#registered_container_instances_count ⇒ Integer
The number of container instances registered into the cluster.
-
#running_tasks_count ⇒ Integer
The number of tasks in the cluster that are in the ‘RUNNING` state.
-
#statistics ⇒ Array<Types::KeyValuePair>
Additional information about your clusters that are separated by launch type, including:.
-
#status ⇒ String
The status of the cluster.
-
#tags ⇒ Array<Types::Tag>
The metadata that you apply to the cluster to help you categorize and organize them.
Instance Attribute Details
#active_services_count ⇒ Integer
The number of services that are running on the cluster in an ‘ACTIVE` state. You can view these services with ListServices.
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/aws-sdk-ecs/types.rb', line 240 class Cluster < Struct.new( :cluster_arn, :cluster_name, :status, :registered_container_instances_count, :running_tasks_count, :pending_tasks_count, :active_services_count, :statistics, :tags) include Aws::Structure end |
#cluster_arn ⇒ String
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 `..
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/aws-sdk-ecs/types.rb', line 240 class Cluster < Struct.new( :cluster_arn, :cluster_name, :status, :registered_container_instances_count, :running_tasks_count, :pending_tasks_count, :active_services_count, :statistics, :tags) include Aws::Structure end |
#cluster_name ⇒ String
A user-generated string that you use to identify your cluster.
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/aws-sdk-ecs/types.rb', line 240 class Cluster < Struct.new( :cluster_arn, :cluster_name, :status, :registered_container_instances_count, :running_tasks_count, :pending_tasks_count, :active_services_count, :statistics, :tags) include Aws::Structure end |
#pending_tasks_count ⇒ Integer
The number of tasks in the cluster that are in the ‘PENDING` state.
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/aws-sdk-ecs/types.rb', line 240 class Cluster < Struct.new( :cluster_arn, :cluster_name, :status, :registered_container_instances_count, :running_tasks_count, :pending_tasks_count, :active_services_count, :statistics, :tags) include Aws::Structure end |
#registered_container_instances_count ⇒ Integer
The number of container instances registered into the cluster. This includes container instances in both ‘ACTIVE` and `DRAINING` status.
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/aws-sdk-ecs/types.rb', line 240 class Cluster < Struct.new( :cluster_arn, :cluster_name, :status, :registered_container_instances_count, :running_tasks_count, :pending_tasks_count, :active_services_count, :statistics, :tags) include Aws::Structure end |
#running_tasks_count ⇒ Integer
The number of tasks in the cluster that are in the ‘RUNNING` state.
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/aws-sdk-ecs/types.rb', line 240 class Cluster < Struct.new( :cluster_arn, :cluster_name, :status, :registered_container_instances_count, :running_tasks_count, :pending_tasks_count, :active_services_count, :statistics, :tags) include Aws::Structure end |
#statistics ⇒ Array<Types::KeyValuePair>
Additional information about your clusters that are separated by launch type, including:
-
runningEC2TasksCount
-
RunningFargateTasksCount
-
pendingEC2TasksCount
-
pendingFargateTasksCount
-
activeEC2ServiceCount
-
activeFargateServiceCount
-
drainingEC2ServiceCount
-
drainingFargateServiceCount
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/aws-sdk-ecs/types.rb', line 240 class Cluster < Struct.new( :cluster_arn, :cluster_name, :status, :registered_container_instances_count, :running_tasks_count, :pending_tasks_count, :active_services_count, :statistics, :tags) include Aws::Structure end |
#status ⇒ String
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.
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/aws-sdk-ecs/types.rb', line 240 class Cluster < Struct.new( :cluster_arn, :cluster_name, :status, :registered_container_instances_count, :running_tasks_count, :pending_tasks_count, :active_services_count, :statistics, :tags) include Aws::Structure end |
#tags ⇒ Array<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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/aws-sdk-ecs/types.rb', line 240 class Cluster < Struct.new( :cluster_arn, :cluster_name, :status, :registered_container_instances_count, :running_tasks_count, :pending_tasks_count, :active_services_count, :statistics, :tags) include Aws::Structure end |