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 with the
create_cluster
action.
When you call the create_cluster
API operation,
Amazon ECS attempts to create the Amazon ECS service-linked role for
your account so that required resources in other AWS services can be
managed on your behalf. However, if the IAM user that makes the call
does not have permissions to create the service-linked role, it is not
created. For more information, see Using Service-Linked Roles for Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
ecs_create_cluster(clusterName, tags, settings, capacityProviders,
defaultCapacityProviderStrategy)
A list with the following syntax:
list(
cluster = list(
clusterArn = "string",
clusterName = "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"
)
)
The name of your cluster. If you do not specify a name for your cluster,
you create a cluster named default
. Up to 255 letters (uppercase and
lowercase), numbers, and hyphens are allowed.
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, both of which you define.
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 AWS
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.
The setting to use when creating a cluster. This parameter is used to
enable CloudWatch Container Insights for a cluster. If this value is
specified, it will override the containerInsights
value set with
put_account_setting
or
put_account_setting_default
.
The short name of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the
capacity provider must already be created and not already associated
with another cluster. New capacity providers can be created with the
create_capacity_provider
API
operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or
FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers
are available to all accounts and only need to be associated with a
cluster to be used.
The
put_cluster_capacity_providers
API operation is used to update the list of available capacity providers
for a cluster after the cluster is created.
The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers
along with the base
and weight
to assign to them. A capacity
provider must be associated with the cluster to be used in a capacity
provider strategy. The
put_cluster_capacity_providers
API is used to associate a capacity provider with a cluster. Only
capacity providers with an ACTIVE
or UPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the
capacity provider must already be created. New capacity providers can be
created with the
create_capacity_provider
API
operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or
FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers
are available to all accounts and only need to be associated with a
cluster to be used.
If a default capacity provider strategy is not defined for a cluster
during creation, it can be defined later with the
put_cluster_capacity_providers
API operation.
svc$create_cluster(
clusterName = "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
)
)
)
if (FALSE) {
# This example creates a cluster in your default region.
svc$create_cluster(
clusterName = "my_cluster"
)
}
Run the code above in your browser using DataLab