Skip to content

Create Cluster

ecs_create_cluster R Documentation

Creates a new Amazon ECS cluster

Description

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name.

When you call the create_cluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Usage

ecs_create_cluster(clusterName, tags, settings, configuration,
  capacityProviders, defaultCapacityProviderStrategy,
  serviceConnectDefaults)

Arguments

clusterName

The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

tags

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use ⁠aws:⁠, ⁠AWS:⁠, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

settings

The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with put_account_setting or put_account_setting_default.

configuration

The execute command configuration for the cluster.

capacityProviders

The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the create_service or run_task actions.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the create_capacity_provider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

defaultCapacityProviderStrategy

The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the create_service or run_task APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.

If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the put_cluster_capacity_providers API operation.

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$create_cluster(
  clusterName = "string",
  tags = list(
    list(
      key = "string",
      value = "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"
    )
  ),
  capacityProviders = list(
    "string"
  ),
  defaultCapacityProviderStrategy = list(
    list(
      capacityProvider = "string",
      weight = 123,
      base = 123
    )
  ),
  serviceConnectDefaults = list(
    namespace = "string"
  )
)

Examples

## Not run: 
# This example creates a cluster in your default region.
svc$create_cluster(
  clusterName = "my_cluster"
)

## End(Not run)