AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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.
See also: AWS API Documentation
create-cluster
[--cluster-name <value>]
[--tags <value>]
[--settings <value>]
[--configuration <value>]
[--capacity-providers <value>]
[--default-capacity-provider-strategy <value>]
[--service-connect-defaults <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--cluster-name
(string)
The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's nameddefault
. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
--tags
(list)
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.(structure)
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.
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.key -> (string)
One part of a key-value pair that make up a tag. Akey
is a general label that acts like a category for more specific tag values.value -> (string)
The optional part of a key-value pair that make up a tag. Avalue
acts as a descriptor within a tag category (key).
Shorthand Syntax:
key=string,value=string ...
JSON Syntax:
[
{
"key": "string",
"value": "string"
}
...
]
--settings
(list)
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 .(structure)
The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.
name -> (string)
The name of the cluster setting. The value iscontainerInsights
.value -> (string)
The value to set for the cluster setting. The supported values are
enabled
anddisabled
.If you set
name
tocontainerInsights
andvalue
toenabled
, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless thecontainerInsights
account setting is turned on. If a cluster value is specified, it will override thecontainerInsights
value set with PutAccountSetting or PutAccountSettingDefault .
Shorthand Syntax:
name=string,value=string ...
JSON Syntax:
[
{
"name": "containerInsights",
"value": "string"
}
...
]
--configuration
(structure)
The
execute
command configuration for the cluster.executeCommandConfiguration -> (structure)
The details of the execute command configuration.
kmsKeyId -> (string)
Specify an Key Management Service key ID to encrypt the data between the local client and the container.logging -> (string)
The log setting to use for redirecting logs for your execute command results. The following log settings are available.
NONE
: The execute command session is not logged.DEFAULT
: Theawslogs
configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogs
log driver is configured in the task definition, the output won't be logged.OVERRIDE
: Specify the logging details as a part oflogConfiguration
. If theOVERRIDE
logging option is specified, thelogConfiguration
is required.logConfiguration -> (structure)
The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE
is specified, alogConfiguration
must be provided.cloudWatchLogGroupName -> (string)
The name of the CloudWatch log group to send logs to.
Note
The CloudWatch log group must already be created.cloudWatchEncryptionEnabled -> (boolean)
Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.s3BucketName -> (string)
The name of the S3 bucket to send logs to.
Note
The S3 bucket must already be created.s3EncryptionEnabled -> (boolean)
Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.s3KeyPrefix -> (string)
An optional folder in the S3 bucket to place logs in.managedStorageConfiguration -> (structure)
The details of the managed storage configuration.
kmsKeyId -> (string)
Specify a Key Management Service key ID to encrypt the managed storage.fargateEphemeralStorageKmsKeyId -> (string)
Specify the Key Management Service key ID for the Fargate ephemeral storage.
Shorthand Syntax:
executeCommandConfiguration={kmsKeyId=string,logging=string,logConfiguration={cloudWatchLogGroupName=string,cloudWatchEncryptionEnabled=boolean,s3BucketName=string,s3EncryptionEnabled=boolean,s3KeyPrefix=string}},managedStorageConfiguration={kmsKeyId=string,fargateEphemeralStorageKmsKeyId=string}
JSON Syntax:
{
"executeCommandConfiguration": {
"kmsKeyId": "string",
"logging": "NONE"|"DEFAULT"|"OVERRIDE",
"logConfiguration": {
"cloudWatchLogGroupName": "string",
"cloudWatchEncryptionEnabled": true|false,
"s3BucketName": "string",
"s3EncryptionEnabled": true|false,
"s3KeyPrefix": "string"
}
},
"managedStorageConfiguration": {
"kmsKeyId": "string",
"fargateEphemeralStorageKmsKeyId": "string"
}
}
--capacity-providers
(list)
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 Fargate capacity provider, specify either the
FARGATE
orFARGATE_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.
(string)
Syntax:
"string" "string" ...
--default-capacity-provider-strategy
(list)
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 CreateService or RunTask 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.
(structure)
The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask or CreateCluster APIs or as the default capacity provider strategy for a cluster with the
CreateCluster
API.Only capacity providers that are already associated with a cluster and have an
ACTIVE
orUPDATING
status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateClusterCapacityProvider API operation.
To use a Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.With
FARGATE_SPOT
, you can run interruption tolerant tasks at a rate that's discounted compared to theFARGATE
price.FARGATE_SPOT
runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning.FARGATE_SPOT
only supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later.A capacity provider strategy may contain a maximum of 6 capacity providers.
capacityProvider -> (string)
The short name of the capacity provider.weight -> (integer)
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The
weight
value is taken into consideration after thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB , then for every one task that's run using capacityProviderA , four tasks would use capacityProviderB .base -> (integer)
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of0
is used.
Shorthand Syntax:
capacityProvider=string,weight=integer,base=integer ...
JSON Syntax:
[
{
"capacityProvider": "string",
"weight": integer,
"base": integer
}
...
]
--service-connect-defaults
(structure)
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 totrue
in theServiceConnectConfiguration
. You can set the namespace of each service individually in theServiceConnectConfiguration
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 .
namespace -> (string)
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).
If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this Amazon Web Services Region.
If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance discovery aren't used by Service Connect.
If you update the cluster with an empty string
""
for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must be deleted separately.For more information about Cloud Map, see Working with Services in the Cloud Map Developer Guide .
Shorthand Syntax:
namespace=string
JSON Syntax:
{
"namespace": "string"
}
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example 1: To create a new cluster
The following create-cluster
example creates a cluster.
aws ecs create-cluster \
--cluster-name MyCluster
Output:
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"clusterName": "MyCluster",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"pendingTasksCount": 0,
"runningTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"tags": []
}
}
For more information, see Creating a Cluster in the Amazon ECS Developer Guide.
Example 2: To create a new cluster using capacity providers
The following create-cluster
example creates a cluster and associates two existing capacity providers with it. The create-capacity-provider
command is used to create a capacity provider. Specifying a default capacity provider strategy is optional, but recommended. In this example, we create a cluster named MyCluster
and associate the MyCapacityProvider1
and MyCapacityProvider2
capacity providers with it. A default capacity provider strategy is specified that spreads the tasks evenly across both capacity providers.
- aws ecs create-cluster
- --cluster-name MyCluster --capacity-providers MyCapacityProvider1 MyCapacityProvider2 --default-capacity-provider-strategy capacityProvider=MyCapacityProvider1,weight=1 capacityProvider=MyCapacityProvider2,weight=1
Output:
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"clusterName": "MyCluster",
"status": "PROVISIONING",
"registeredContainerInstancesCount": 0,
"pendingTasksCount": 0,
"runningTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"settings": [
{
"name": "containerInsights",
"value": "enabled"
}
],
"capacityProviders": [
"MyCapacityProvider1",
"MyCapacityProvider2"
],
"defaultCapacityProviderStrategy": [
{
"capacityProvider": "MyCapacityProvider1",
"weight": 1,
"base": 0
},
{
"capacityProvider": "MyCapacityProvider2",
"weight": 1,
"base": 0
}
],
"attachments": [
{
"id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
"type": "asp",
"status": "PRECREATED",
"details": [
{
"name": "capacityProviderName",
"value": "MyCapacityProvider1"
},
{
"name": "scalingPlanName",
"value": "ECSManagedAutoScalingPlan-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
]
},
{
"id": "ae592060-2382-4663-9476-b015c685593c",
"type": "asp",
"status": "PRECREATED",
"details": [
{
"name": "capacityProviderName",
"value": "MyCapacityProvider2"
},
{
"name": "scalingPlanName",
"value": "ECSManagedAutoScalingPlan-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}
]
}
],
"attachmentsStatus": "UPDATE_IN_PROGRESS"
}
}
For more information, see Cluster capacity providers in the Amazon ECS Developer Guide.
Example 3: To create a new cluster with multiple tags
The following create-cluster
example creates a cluster with multiple tags. For more information about adding tags using shorthand syntax, see Using Shorthand Syntax with the AWS Command Line Interface in the AWS CLI User Guide.
aws ecs create-cluster \
--cluster-name MyCluster \
--tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3
Output:
{
"cluster": {
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
"clusterName": "MyCluster",
"status": "ACTIVE",
"registeredContainerInstancesCount": 0,
"pendingTasksCount": 0,
"runningTasksCount": 0,
"activeServicesCount": 0,
"statistics": [],
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
},
{
"key": "key3",
"value": "value3"
}
]
}
}
For more information, see Creating a Cluster in the Amazon ECS Developer Guide.
cluster -> (structure)
The full description of your new cluster.
clusterArn -> (string)
The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide .clusterName -> (string)
A user-generated string that you use to identify your cluster.configuration -> (structure)
The execute command configuration for the cluster.
executeCommandConfiguration -> (structure)
The details of the execute command configuration.
kmsKeyId -> (string)
Specify an Key Management Service key ID to encrypt the data between the local client and the container.logging -> (string)
The log setting to use for redirecting logs for your execute command results. The following log settings are available.
NONE
: The execute command session is not logged.DEFAULT
: Theawslogs
configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogs
log driver is configured in the task definition, the output won't be logged.OVERRIDE
: Specify the logging details as a part oflogConfiguration
. If theOVERRIDE
logging option is specified, thelogConfiguration
is required.logConfiguration -> (structure)
The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE
is specified, alogConfiguration
must be provided.cloudWatchLogGroupName -> (string)
The name of the CloudWatch log group to send logs to.
Note
The CloudWatch log group must already be created.cloudWatchEncryptionEnabled -> (boolean)
Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.s3BucketName -> (string)
The name of the S3 bucket to send logs to.
Note
The S3 bucket must already be created.s3EncryptionEnabled -> (boolean)
Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.s3KeyPrefix -> (string)
An optional folder in the S3 bucket to place logs in.managedStorageConfiguration -> (structure)
The details of the managed storage configuration.
kmsKeyId -> (string)
Specify a Key Management Service key ID to encrypt the managed storage.fargateEphemeralStorageKmsKeyId -> (string)
Specify the Key Management Service key ID for the Fargate ephemeral storage.status -> (string)
The status of the cluster. The following are the possible states that are returned.
ACTIVEThe cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
PROVISIONINGThe cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created.
DEPROVISIONINGThe cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted.
FAILEDThe cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create.
INACTIVEThe cluster has been deleted. Clusters with an
INACTIVE
status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely onINACTIVE
clusters persisting.registeredContainerInstancesCount -> (integer)
The number of container instances registered into the cluster. This includes container instances in bothACTIVE
andDRAINING
status.runningTasksCount -> (integer)
The number of tasks in the cluster that are in theRUNNING
state.pendingTasksCount -> (integer)
The number of tasks in the cluster that are in thePENDING
state.activeServicesCount -> (integer)
The number of services that are running on the cluster in anACTIVE
state. You can view these services with PListServices .statistics -> (list)
Additional information about your clusters that are separated by launch type. They include the following:
- runningEC2TasksCount
- RunningFargateTasksCount
- pendingEC2TasksCount
- pendingFargateTasksCount
- activeEC2ServiceCount
- activeFargateServiceCount
- drainingEC2ServiceCount
- drainingFargateServiceCount
(structure)
A key-value pair object.
name -> (string)
The name of the key-value pair. For environment variables, this is the name of the environment variable.value -> (string)
The value of the key-value pair. For environment variables, this is the value of the environment variable.tags -> (list)
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.(structure)
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.
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.key -> (string)
One part of a key-value pair that make up a tag. Akey
is a general label that acts like a category for more specific tag values.value -> (string)
The optional part of a key-value pair that make up a tag. Avalue
acts as a descriptor within a tag category (key).settings -> (list)
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off for a cluster.
(structure)
The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.
name -> (string)
The name of the cluster setting. The value iscontainerInsights
.value -> (string)
The value to set for the cluster setting. The supported values are
enabled
anddisabled
.If you set
name
tocontainerInsights
andvalue
toenabled
, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless thecontainerInsights
account setting is turned on. If a cluster value is specified, it will override thecontainerInsights
value set with PutAccountSetting or PutAccountSettingDefault .capacityProviders -> (list)
The capacity providers associated with the cluster.
(string)
defaultCapacityProviderStrategy -> (list)
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
(structure)
The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask or CreateCluster APIs or as the default capacity provider strategy for a cluster with the
CreateCluster
API.Only capacity providers that are already associated with a cluster and have an
ACTIVE
orUPDATING
status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateClusterCapacityProvider API operation.
To use a Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.With
FARGATE_SPOT
, you can run interruption tolerant tasks at a rate that's discounted compared to theFARGATE
price.FARGATE_SPOT
runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning.FARGATE_SPOT
only supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later.A capacity provider strategy may contain a maximum of 6 capacity providers.
capacityProvider -> (string)
The short name of the capacity provider.weight -> (integer)
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The
weight
value is taken into consideration after thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB , then for every one task that's run using capacityProviderA , four tasks would use capacityProviderB .base -> (integer)
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of0
is used.attachments -> (list)
The resources attached to a cluster. When using a capacity provider with a cluster, the capacity provider and associated resources are returned as cluster attachments.
(structure)
An object representing a container instance or task attachment.
id -> (string)
The unique identifier for the attachment.type -> (string)
The type of the attachment, such asElasticNetworkInterface
,Service Connect
, andAmazonElasticBlockStorage
.status -> (string)
The status of the attachment. Valid values arePRECREATED
,CREATED
,ATTACHING
,ATTACHED
,DETACHING
,DETACHED
,DELETED
, andFAILED
.details -> (list)
Details of the attachment.
For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
For Service Connect services, this includes
portName
,clientAliases
,discoveryName
, andingressPortOverride
.For Elastic Block Storage, this includes
roleArn
,deleteOnTermination
,volumeName
,volumeId
, andstatusReason
(only when the attachment fails to create or attach).(structure)
A key-value pair object.
name -> (string)
The name of the key-value pair. For environment variables, this is the name of the environment variable.value -> (string)
The value of the key-value pair. For environment variables, this is the value of the environment variable.attachmentsStatus -> (string)
The status of the capacity providers associated with the cluster. The following are the states that are returned.
UPDATE_IN_PROGRESSThe available capacity providers for the cluster are updating.
UPDATE_COMPLETEThe capacity providers have successfully updated.
UPDATE_FAILEDThe capacity provider updates failed.
serviceConnectDefaults -> (structure)
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 totrue
in theServiceConnectConfiguration
. You can set the namespace of each service individually in theServiceConnectConfiguration
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 .
namespace -> (string)
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect configuration, this namespace is used.