Class CfnCluster.CapacityProviderStrategyItemProperty
The CapacityProviderStrategyItem property specifies the details of the default capacity provider strategy for the cluster.
Inheritance
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.AWS.ECS.dll
Syntax (csharp)
public class CapacityProviderStrategyItemProperty : Object, CfnCluster.ICapacityProviderStrategyItemPropertySyntax (vb)
Public Class CapacityProviderStrategyItemProperty
Inherits Object
Implements CfnCluster.ICapacityProviderStrategyItemPropertyRemarks
When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;
var capacityProviderStrategyItemProperty = new CapacityProviderStrategyItemProperty {
Base = 123,
CapacityProvider = "capacityProvider",
Weight = 123
};Synopsis
Constructors
| CapacityProviderStrategyItemProperty() |
Properties
| Base | The base value designates how many tasks, at a minimum, to run on the specified capacity provider. |
| CapacityProvider | The short name of the capacity provider. |
| Weight | The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. |
Constructors
CapacityProviderStrategyItemProperty()
public CapacityProviderStrategyItemProperty()Properties
Base
The base value designates how many tasks, at a minimum, to run on the specified capacity provider.
public Nullable<double> Base { get; set; }Property Value
System.Nullable<System.Double>
Remarks
Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
CapacityProvider
The short name of the capacity provider.
public string CapacityProvider { get; set; }Property Value
System.String
Remarks
Weight
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
public Nullable<double> Weight { get; set; }Property Value
System.Nullable<System.Double>
Remarks
The weight value is taken into consideration after the base value, if defined, is satisfied.
If no weight value is specified, the default value of 0 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 of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService 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 the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that's run using capacityProviderA , four tasks would use capacityProviderB .