Interface CfnService.CapacityProviderStrategyItemProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnService.CapacityProviderStrategyItemProperty.Jsii$Proxy
- Enclosing class:
CfnService
A capacity provider strategy can be set when using the RunTask or CreateService 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 an 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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ecs.*;
CapacityProviderStrategyItemProperty capacityProviderStrategyItemProperty = CapacityProviderStrategyItemProperty.builder()
.base(123)
.capacityProvider("capacityProvider")
.weight(123)
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnService.CapacityProviderStrategyItemPropertystatic final classAn implementation forCfnService.CapacityProviderStrategyItemProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default NumbergetBase()The base value designates how many tasks, at a minimum, to run on the specified capacity provider.default StringThe short name of the capacity provider.default NumberThe weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBase
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.- See Also:
-
getCapacityProvider
The short name of the capacity provider.- See Also:
-
getWeight
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 .- See Also:
-
builder
-