EcsParameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-scheduler/refs/heads/main/json-schema/amazon-eventbridge-scheduler-ecs-parameters-schema.json",
  "title": "EcsParameters",
  "description": "The templated target type for the Amazon ECS <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html\"> <code>RunTask</code> </a> API operation.",
  "type": "object",
  "properties": {
    "CapacityProviderStrategy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CapacityProviderStrategy"
        },
        {
          "description": "The capacity provider strategy to use for the task."
        }
      ]
    },
    "EnableECSManagedTags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnableECSManagedTags"
        },
        {
          "description": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon ECS Developer Guide</i>."
        }
      ]
    },
    "EnableExecuteCommand": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnableExecuteCommand"
        },
        {
          "description": "Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task."
        }
      ]
    },
    "Group": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Group"
        },
        {
          "description": "Specifies an ECS task group for the task. The maximum length is 255 characters."
        }
      ]
    },
    "LaunchType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LaunchType"
        },
        {
          "description": "Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The <code>FARGATE</code> value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html\">AWS Fargate on Amazon ECS</a> in the <i>Amazon ECS Developer Guide</i>."
        }
      ]
    },
    "NetworkConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NetworkConfiguration"
        },
        {
          "description": "This structure specifies the network configuration for an ECS task."
        }
      ]
    },
    "PlacementConstraints": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PlacementConstraints"
        },
        {
          "description": "An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime)."
        }
      ]
    },
    "PlacementStrategy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PlacementStrategies"
        },
        {
          "description": "The task placement strategy for a task or service."
        }
      ]
    },
    "PlatformVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PlatformVersion"
        },
        {
          "description": "Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as <code>1.1.0</code>."
        }
      ]
    },
    "PropagateTags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PropagateTags"
        },
        {
          "description": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html\"> <code>TagResource</code> </a> API action. "
        }
      ]
    },
    "ReferenceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ReferenceId"
        },
        {
          "description": "The reference ID to use for the task."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Tags"
        },
        {
          "description": "The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html\"> <code>RunTask</code> </a> in the <i>Amazon ECS API Reference</i>."
        }
      ]
    },
    "TaskCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskCount"
        },
        {
          "description": "The number of tasks to create based on <code>TaskDefinition</code>. The default is <code>1</code>."
        }
      ]
    },
    "TaskDefinitionArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskDefinitionArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task."
        }
      ]
    }
  },
  "required": [
    "TaskDefinitionArn"
  ]
}