AWS::Events::Rule CapacityProviderStrategyItem

The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

Syntax

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

JSON

{
  "Base" : Integer,
  "CapacityProvider" : String,
  "Weight" : Integer
}

YAML

  Base: Integer
  CapacityProvider: String
  Weight: Integer

Properties

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

Required: No

Type: Integer

Minimum: 0

Maximum: 100000

Update requires: No interruption

CapacityProvider

The short name of the capacity provider.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

Weight

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.

Required: No

Type: Integer

Minimum: 0

Maximum: 1000

Update requires: No interruption

Examples

Set the CapacityProviderStrategyItem property

The following example sets the CapacityProviderStrategyItem property to run a minimum of 10 tasks on CapacityProvider1.

JSON

"CapacityProviderStrategy": {
  "Base": 10,
  "CapacityProvider": "CapacityProvider1",
  "Weight": 0
}

YAML

CapacityProviderStrategy
  Base: 10
  CapacityProvider: CapacityProvider1
  Weight: 0