Menu
Amazon EC2 Container Service
API Reference (API Version 2014-11-13)

Cluster

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.

Contents

activeServicesCount

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

Type: Integer

Required: No

clusterArn

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 ..

Type: String

Required: No

clusterName

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

Type: String

Required: No

pendingTasksCount

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

Type: Integer

Required: No

registeredContainerInstancesCount

The number of container instances registered into the cluster.

Type: Integer

Required: No

runningTasksCount

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

Type: Integer

Required: No

status

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.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: