ecs/aws.sdk.kotlin.services.ecs.model/Cluster

Cluster

A regional grouping of one or more container instances where 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.

Types

Builder

class Builder

Companion

object Companion

Properties

activeServicesCount

val activeServicesCount: Int

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

attachments

val attachments: List<Attachment>?

The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.

attachmentsStatus

val attachmentsStatus: String?

The status of the capacity providers associated with the cluster. The following are the states that are returned.

capacityProviders

val capacityProviders: List<String>?

The capacity providers associated with the cluster.

clusterArn

val clusterArn: String?

The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

clusterName

val clusterName: String?

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

configuration

val configuration: ClusterConfiguration?

The execute command and managed storage configuration for the cluster.

defaultCapacityProviderStrategy

val defaultCapacityProviderStrategy: List<CapacityProviderStrategyItem>?

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

pendingTasksCount

val pendingTasksCount: Int

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

registeredContainerInstancesCount

val registeredContainerInstancesCount: Int

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

runningTasksCount

val runningTasksCount: Int

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

serviceConnectDefaults

val serviceConnectDefaults: ClusterServiceConnectDefaults?

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

settings

val settings: List<ClusterSetting>?

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

statistics

val statistics: List<KeyValuePair>?

Additional information about your clusters that are separated by launch type. They include the following:

status

val status: String?

The status of the cluster. The following are the possible states that are returned.