Describe Clusters

ecs_describe_clusters

R Documentation

Describes one or more of your clusters¶

Description¶

Describes one or more of your clusters.

For CLI examples, see describe-clusters.rst on GitHub.

Usage¶

ecs_describe_clusters(clusters, include)

Arguments¶

clusters

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

include

Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

If SETTINGS is specified, the settings for the cluster are included.

If CONFIGURATIONS is specified, the configuration for the cluster is included.

If STATISTICS is specified, the task and service count is included, separated by launch type.

If TAGS is specified, the metadata tags associated with the cluster are included.

Value¶

A list with the following syntax:

list(
  clusters = list(
    list(
      clusterArn = "string",
      clusterName = "string",
      configuration = list(
        executeCommandConfiguration = list(
          kmsKeyId = "string",
          logging = "NONE"|"DEFAULT"|"OVERRIDE",
          logConfiguration = list(
            cloudWatchLogGroupName = "string",
            cloudWatchEncryptionEnabled = TRUE|FALSE,
            s3BucketName = "string",
            s3EncryptionEnabled = TRUE|FALSE,
            s3KeyPrefix = "string"
          )
        ),
        managedStorageConfiguration = list(
          kmsKeyId = "string",
          fargateEphemeralStorageKmsKeyId = "string"
        )
      ),
      status = "string",
      registeredContainerInstancesCount = 123,
      runningTasksCount = 123,
      pendingTasksCount = 123,
      activeServicesCount = 123,
      statistics = list(
        list(
          name = "string",
          value = "string"
        )
      ),
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      settings = list(
        list(
          name = "containerInsights",
          value = "string"
        )
      ),
      capacityProviders = list(
        "string"
      ),
      defaultCapacityProviderStrategy = list(
        list(
          capacityProvider = "string",
          weight = 123,
          base = 123
        )
      ),
      attachments = list(
        list(
          id = "string",
          type = "string",
          status = "string",
          details = list(
            list(
              name = "string",
              value = "string"
            )
          )
        )
      ),
      attachmentsStatus = "string",
      serviceConnectDefaults = list(
        namespace = "string"
      )
    )
  ),
  failures = list(
    list(
      arn = "string",
      reason = "string",
      detail = "string"
    )
  )
)

Request syntax¶

svc$describe_clusters(
  clusters = list(
    "string"
  ),
  include = list(
    "ATTACHMENTS"|"CONFIGURATIONS"|"SETTINGS"|"STATISTICS"|"TAGS"
  )
)

Examples¶

## Not run: 
# This example provides a description of the specified cluster in your
# default region.
svc$describe_clusters(
  clusters = list(
    "default"
  )
)

## End(Not run)