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

Builder

Properties

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

attachments

var 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

var attachmentsStatus: String?

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

capacityProviders

var capacityProviders: List<String>?

The capacity providers associated with the cluster.

clusterArn

var 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

var clusterName: String?

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

configuration

var configuration: ClusterConfiguration?

The execute command configuration for the cluster.

defaultCapacityProviderStrategy

var 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

var pendingTasksCount: Int

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

registeredContainerInstancesCount

var registeredContainerInstancesCount: Int

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

runningTasksCount

var runningTasksCount: Int

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

serviceConnectDefaults

var 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

var settings: List<ClusterSetting>?

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

statistics

var statistics: List<KeyValuePair>?

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

status

var status: String?

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

Functions

configuration

fun configuration(block: ClusterConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ecs.model.ClusterConfiguration inside the given block

serviceConnectDefaults

fun serviceConnectDefaults(block: ClusterServiceConnectDefaults.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ecs.model.ClusterServiceConnectDefaults inside the given block