CapacityProviderStrategyItem
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 or UPDATING 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 CreateCapacityProvider 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 in a
capacity provider strategy.
A capacity provider strategy may contain a maximum of 6 capacity providers.
Contents
- capacityProvider
-
The short name of the capacity provider.
Type: String
Required: Yes
- base
-
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 of
0is used.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100000.
Required: No
- weight
-
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The
weightvalue is taken into consideration after thebasevalue, if defined, is satisfied.If no
weightvalue is specified, the default value of0is 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 of0can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0, anyRunTaskorCreateServiceactions 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 thebaseis satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1for capacityProviderA and a weight of4for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
