Class CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty>
- Enclosing interface:
CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.capacityProvider
(String capacityProvider)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
capacityProvider
@Stability(Stable) public CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder capacityProvider(String capacityProvider) Sets the value ofCfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.getCapacityProvider()
- Parameters:
capacityProvider
- The short name of the capacity provider. This parameter is required.- Returns:
this
-
base
@Stability(Stable) public CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder base(Number base) - Parameters:
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 of0
is used.- Returns:
this
-
weight
@Stability(Stable) public CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder weight(Number weight) Sets the value ofCfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.getWeight()
- Parameters:
weight
- The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. Theweight
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 .- Returns:
this
-
build
@Stability(Stable) public CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty build()Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty>
- Returns:
- a new instance of
CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-