interface CapacityProviderStrategyProperty

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsecs#CfnClusterCapacityProviderAssociations_CapacityProviderStrategyProperty`
Java	`software.amazon.awscdk.services.ecs.CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty`
Python	`aws_cdk.aws_ecs.CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty`
TypeScript	`aws-cdk-lib` » `aws_ecs` » `CfnClusterCapacityProviderAssociations` » `CapacityProviderStrategyProperty`

The CapacityProviderStrategy property specifies the details of the default capacity provider strategy for the cluster.

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const capacityProviderStrategyProperty: ecs.CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty = {
  capacityProvider: 'capacityProvider',

  // the properties below are optional
  base: 123,
  weight: 123,
};

Properties

Name	Type	Description
capacityProvider	`string`	The short name of the capacity provider.
base?	`number`	The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service.
weight?	`number`	The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

capacityProvider

Type: string

The short name of the capacity provider.

base?

Type: number (optional)

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 0 is used.

Base value characteristics:

Only one capacity provider in a strategy can have a base defined
Default value is 0 if not specified
Valid range: 0 to 100,000
Base requirements are satisfied first before weight distribution

weight?

Type: number (optional)

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

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.

Weight value characteristics:

Weight is considered after the base value is satisfied
Default value is 0 if 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 0 cannot 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 1 will split tasks evenly after base requirements are met.

Weighted Distribution: If capacityProviderA has weight 1 and capacityProviderB has weight 4 , then for every 1 task on A, 4 tasks will run on B.