CreateCluster
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 CreateCluster
action.
When you call the CreateCluster 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 AWS services on your behalf. However, if the IAM 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.
Request Syntax
{
"capacityProviders": [ "string
" ],
"clusterName": "string
",
"configuration": {
"executeCommandConfiguration": {
"kmsKeyId": "string
",
"logConfiguration": {
"cloudWatchEncryptionEnabled": boolean
,
"cloudWatchLogGroupName": "string
",
"s3BucketName": "string
",
"s3EncryptionEnabled": boolean
,
"s3KeyPrefix": "string
"
},
"logging": "string
"
}
},
"defaultCapacityProviderStrategy": [
{
"base": number
,
"capacityProvider": "string
",
"weight": number
}
],
"settings": [
{
"name": "string
",
"value": "string
"
}
],
"tags": [
{
"key": "string
",
"value": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- 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 CreateService or RunTask 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 CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the
FARGATE
orFARGATE_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 PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Type: Array of strings
Required: No
- 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.Type: String
Required: No
- configuration
-
The
execute
command configuration for the cluster.Type: ClusterConfiguration object
Required: No
- 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 RunTask or CreateService 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 PutClusterCapacityProviders API operation.
Type: Array of CapacityProviderStrategyItem objects
Required: No
- 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 PutAccountSetting or PutAccountSettingDefault.Type: Array of ClusterSetting objects
Required: No
- 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 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.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
-
Response Syntax
{
"cluster": {
"activeServicesCount": number,
"attachments": [
{
"details": [
{
"name": "string",
"value": "string"
}
],
"id": "string",
"status": "string",
"type": "string"
}
],
"attachmentsStatus": "string",
"capacityProviders": [ "string" ],
"clusterArn": "string",
"clusterName": "string",
"configuration": {
"executeCommandConfiguration": {
"kmsKeyId": "string",
"logConfiguration": {
"cloudWatchEncryptionEnabled": boolean,
"cloudWatchLogGroupName": "string",
"s3BucketName": "string",
"s3EncryptionEnabled": boolean,
"s3KeyPrefix": "string"
},
"logging": "string"
}
},
"defaultCapacityProviderStrategy": [
{
"base": number,
"capacityProvider": "string",
"weight": number
}
],
"pendingTasksCount": number,
"registeredContainerInstancesCount": number,
"runningTasksCount": number,
"settings": [
{
"name": "string",
"value": "string"
}
],
"statistics": [
{
"name": "string",
"value": "string"
}
],
"status": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource,. Or, it might be specifying an identifier that isn't valid.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter isn't valid. Review the available parameters for the API request.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an AWS Signature Version 4
signature. For more information, see Signature
Version 4 Signing Process in the
AWS General
Reference.
You only need to learn how to sign HTTP requests if you intend to
create them manually. When you use the AWS Command Line Interface
Example
This example request creates a cluster called My-cluster
.
Sample Request
POST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 29
X-Amz-Target: AmazonEC2ContainerServiceV20141113.CreateCluster
X-Amz-Date: 20150429T163840Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS
{
"clusterName": "My-cluster"
}
Sample Response
HTTP/1.1 200 OK
Server: Server
Date: Wed, 29 Apr 2015 16:38:41 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 209
Connection: keep-alive
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
{
"cluster": {
"activeServicesCount": 0,
"clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/My-cluster",
"clusterName": "My-cluster",
"pendingTasksCount": 0,
"registeredContainerInstancesCount": 0,
"runningTasksCount": 0,
"status": "ACTIVE"
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: