This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::ECS::ClusterCapacityProviderAssociations CapacityProviderStrategy
<a name="aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy"></a>

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.

## Syntax
<a name="aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy-syntax"></a>

To declare this entity in your Amazon CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy-syntax.json"></a>

```
{
  "[Base](#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-base)" : Integer,
  "[CapacityProvider](#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-capacityprovider)" : String,
  "[Weight](#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-weight)" : Integer
}
```

### YAML
<a name="aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy-syntax.yaml"></a>

```
  [Base](#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-base): Integer
  [CapacityProvider](#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-capacityprovider): String
  [Weight](#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-weight): Integer
```

## Properties
<a name="aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy-properties"></a>

`Base`  <a name="cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-base"></a>
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
+ The default value is `0` if not specified
+ The valid range is 0 to 100,000
+ Base requirements are satisfied first before weight distribution
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `100000`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CapacityProvider`  <a name="cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-capacityprovider"></a>
The short name of the capacity provider. This can be either an AWS managed capacity provider (`FARGATE` or `FARGATE_SPOT`) or the name of a custom capacity provider that you created.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `FARGATE | FARGATE_SPOT`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Weight`  <a name="cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-weight"></a>
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
+ The default value is `0` if not specified
+ The valid range is 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:  

1. Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider

1. 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.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy--seealso"></a>
+  [Creating a cluster capacity provider association using an Auto Scaling group capacity provider](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-clustercapacityproviderassociations.html#aws-resource-ecs-clustercapacityproviderassociations--examples--Creating_a_cluster_capacity_provider_association_using_an_Auto_Scaling_group_capacity_provider.)