Amazon EventBridge Scheduler · JSON Structure

Amazon Eventbridge Scheduler Capacity Provider Strategy Item Structure

The details of a capacity provider strategy.

Type: object Properties: 3 Required: 1
Amazon Web ServicesCronEvent-DrivenSchedulingServerless

CapacityProviderStrategyItem is a JSON Structure definition published by Amazon EventBridge Scheduler, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

base capacityProvider weight

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-scheduler/refs/heads/main/json-structure/amazon-eventbridge-scheduler-capacity-provider-strategy-item-structure.json",
  "name": "CapacityProviderStrategyItem",
  "description": "The details of a capacity provider strategy.",
  "type": "object",
  "properties": {
    "base": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CapacityProviderStrategyItemBase"
        },
        {
          "description": "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 <code>0</code> is used."
        }
      ]
    },
    "capacityProvider": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CapacityProvider"
        },
        {
          "description": "The short name of the capacity provider."
        }
      ]
    },
    "weight": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CapacityProviderStrategyItemWeight"
        },
        {
          "description": "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": [
    "capacityProvider"
  ]
}