PutClusterCapacityProviders
Modifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity provider or
launch type is specified, then the cluster's default capacity provider strategy is used.
We recommend that you define a default capacity provider strategy for your cluster.
However, you must specify an empty array ([]
) to bypass defining a default
strategy.
Request Syntax
{
"capacityProviders": [ "string
" ],
"cluster": "string
",
"defaultCapacityProviderStrategy": [
{
"base": number
,
"capacityProvider": "string
",
"weight": number
}
]
}
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 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. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a Amazon Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The Amazon Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.Type: Array of strings
Required: Yes
- cluster
-
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.
Type: String
Required: Yes
- defaultCapacityProviderStrategy
-
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
andweight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with anACTIVE
orUPDATING
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 CreateCapacityProvider API operation.
To use a Amazon Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The Amazon Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.Type: Array of CapacityProviderStrategyItem objects
Required: Yes
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"
},
"managedStorageConfiguration": {
"fargateEphemeralStorageKmsKeyId": "string",
"kmsKeyId": "string"
}
},
"defaultCapacityProviderStrategy": [
{
"base": number,
"capacityProvider": "string",
"weight": number
}
],
"pendingTasksCount": number,
"registeredContainerInstancesCount": number,
"runningTasksCount": number,
"serviceConnectDefaults": {
"namespace": "string"
},
"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.
The following list includes additional causes for the error:
-
The
RunTask
could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in thePROVISIONING
per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
HTTP Status Code: 400
-
- ClusterNotFoundException
-
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter isn't valid. Review the available parameters for the API request.
HTTP Status Code: 400
- ResourceInUseException
-
The specified resource is in-use and can't be removed.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
- UpdateInProgressException
-
There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as
PENDING
orSTAGING
, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: