Skip to content

EcsParameters

Source code in docs_src/capo_scheduler/types/ecs_parameters.py
class EcsParameters(TypedDict, closed=True):
    task_definition_arn: "capo_scheduler.types.task_definition_arn.TaskDefinitionArn"
    """<p>The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.</p>"""
    task_count: NotRequired["capo_scheduler.types.task_count.TaskCount"]
    """<p>The number of tasks to create based on <code>TaskDefinition</code>. The default is <code>1</code>.</p>"""
    launch_type: NotRequired["capo_scheduler.types.launch_type.LaunchType"]
    """<p>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>.</p>"""
    network_configuration: NotRequired[
        "capo_scheduler.types.network_configuration.NetworkConfiguration"
    ]
    """<p>This structure specifies the network configuration for an ECS task.</p>"""
    platform_version: NotRequired[
        "capo_scheduler.types.platform_version.PlatformVersion"
    ]
    """<p>Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as <code>1.1.0</code>.</p>"""
    group: NotRequired["capo_scheduler.types.group.Group"]
    """<p>Specifies an ECS task group for the task. The maximum length is 255 characters.</p>"""
    capacity_provider_strategy: NotRequired[
        "capo_scheduler.types.capacity_provider_strategy.CapacityProviderStrategy"
    ]
    """<p>The capacity provider strategy to use for the task.</p>"""
    enable_ecs_managed_tags: NotRequired[
        "capo_scheduler.types.enable_ecs_managed_tags.EnableECSManagedTags"
    ]
    """<p>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>.</p>"""
    enable_execute_command: NotRequired[
        "capo_scheduler.types.enable_execute_command.EnableExecuteCommand"
    ]
    """<p>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.</p>"""
    placement_constraints: NotRequired[
        "capo_scheduler.types.placement_constraints.PlacementConstraints"
    ]
    """<p>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).</p>"""
    placement_strategy: NotRequired[
        "capo_scheduler.types.placement_strategies.PlacementStrategies"
    ]
    """<p>The task placement strategy for a task or service.</p>"""
    propagate_tags: NotRequired["capo_scheduler.types.propagate_tags.PropagateTags"]
    """<p>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. </p>"""
    reference_id: NotRequired["capo_scheduler.types.reference_id.ReferenceId"]
    """<p>The reference ID to use for the task.</p>"""
    tags: NotRequired["capo_scheduler.types.tags.Tags"]
    """<p>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>.</p>"""

capacity_provider_strategy instance-attribute

capacity_provider_strategy: NotRequired[CapacityProviderStrategy]

The capacity provider strategy to use for the task.

enable_ecs_managed_tags instance-attribute

enable_ecs_managed_tags: NotRequired[EnableECSManagedTags]

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide.

enable_execute_command instance-attribute

enable_execute_command: NotRequired[EnableExecuteCommand]

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 instance-attribute

group: NotRequired[Group]

Specifies an ECS task group for the task. The maximum length is 255 characters.

launch_type instance-attribute

launch_type: NotRequired[LaunchType]

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 FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide.

network_configuration instance-attribute

network_configuration: NotRequired[NetworkConfiguration]

This structure specifies the network configuration for an ECS task.

placement_constraints instance-attribute

placement_constraints: NotRequired[PlacementConstraints]

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).

placement_strategy instance-attribute

placement_strategy: NotRequired[PlacementStrategies]

The task placement strategy for a task or service.

platform_version instance-attribute

platform_version: NotRequired[PlatformVersion]

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

propagate_tags instance-attribute

propagate_tags: NotRequired[PropagateTags]

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 TagResource API action.

reference_id instance-attribute

reference_id: NotRequired[ReferenceId]

The reference ID to use for the task.

tags instance-attribute

tags: NotRequired[Tags]

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 RunTask in the Amazon ECS API Reference.

task_count instance-attribute

task_count: NotRequired[TaskCount]

The number of tasks to create based on TaskDefinition. The default is 1.

task_definition_arn instance-attribute

task_definition_arn: TaskDefinitionArn

The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.