Skip to content

Update Cluster

ecs_update_cluster R Documentation

Updates the cluster

Description

Updates the cluster.

Usage

ecs_update_cluster(cluster, settings, configuration,
  serviceConnectDefaults)

Arguments

cluster

[required] The name of the cluster to modify the settings for.

settings

The cluster settings for your cluster.

configuration

The execute command configuration for the cluster.

serviceConnectDefaults

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.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Value

A list with the following syntax:

list(
  cluster = 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"
    )
  )
)

Request syntax

svc$update_cluster(
  cluster = "string",
  settings = list(
    list(
      name = "containerInsights",
      value = "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"
    )
  ),
  serviceConnectDefaults = list(
    namespace = "string"
  )
)