CapacityProviderStrategyItem
The details of a capacity provider strategy. A capacity provider strategy can be set
when using the RunTaskor 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 CreateClusterCapacityProvider API operation.
To use a Amazon Fargate capacity provider, specify either the FARGATE or
FARGATE_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 in a
capacity provider strategy.
With FARGATE_SPOT, you can run interruption tolerant tasks at a rate
that's discounted compared to the FARGATE price. FARGATE_SPOT
runs tasks on spare compute capacity. When Amazon needs the capacity back, your tasks are
interrupted with a two-minute warning. FARGATE_SPOT supports Linux tasks
with the X86_64 architecture on platform version 1.3.0 or later.
FARGATE_SPOT supports Linux tasks with the ARM64 architecture on
platform version 1.4.0 or later.
A capacity provider strategy can contain a maximum of 20 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 for each service. 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.Base value characteristics:
-
Only one capacity provider in a strategy can have a base defined
-
Default value is
0if not specified -
Valid range: 0 to 100,000
-
Base requirements are satisfied first before weight distribution
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.Weight value characteristics:
-
Weight is considered after the base value is satisfied
-
Default value is
0if not specified -
Valid range: 0 to 1,000
-
At least one capacity provider must have a weight greater than zero
-
Capacity providers with weight of
0cannot place tasks
Task distribution logic:
-
Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider
-
Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios
Examples:
Equal Distribution: Two capacity providers both with weight
1will split tasks evenly after base requirements are met.Weighted Distribution: If capacityProviderA has weight
1and capacityProviderB has weight4, then for every 1 task on A, 4 tasks will run on B.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 Amazon SDKs, see the following: