CommonEcsRunTaskProps

class aws_cdk.aws_stepfunctions_tasks.CommonEcsRunTaskProps(*, cluster, task_definition, container_overrides=None, integration_pattern=None)

Bases: object

Basic properties for ECS Tasks.

Parameters
  • cluster (ICluster) – The topic to run the task on.

  • task_definition (TaskDefinition) – Task Definition used for running tasks in the service. Note: this must be TaskDefinition, and not ITaskDefinition, as it requires properties that are not known for imported task definitions

  • container_overrides (Optional[Sequence[ContainerOverride]]) – Container setting overrides. Key is the name of the container to override, value is the values you want to override. Default: - No overrides

  • integration_pattern (Optional[ServiceIntegrationPattern]) – The service integration pattern indicates different ways to call RunTask in ECS. The valid value for Lambda is FIRE_AND_FORGET, SYNC and WAIT_FOR_TASK_TOKEN. Default: FIRE_AND_FORGET

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ecs as ecs
import aws_cdk.aws_stepfunctions as stepfunctions
import aws_cdk.aws_stepfunctions_tasks as stepfunctions_tasks

# cluster: ecs.Cluster
# container_definition: ecs.ContainerDefinition
# task_definition: ecs.TaskDefinition

common_ecs_run_task_props = stepfunctions_tasks.CommonEcsRunTaskProps(
    cluster=cluster,
    task_definition=task_definition,

    # the properties below are optional
    container_overrides=[stepfunctions_tasks.ContainerOverride(
        container_definition=container_definition,

        # the properties below are optional
        command=["command"],
        cpu=123,
        environment=[stepfunctions_tasks.TaskEnvironmentVariable(
            name="name",
            value="value"
        )],
        memory_limit=123,
        memory_reservation=123
    )],
    integration_pattern=stepfunctions.ServiceIntegrationPattern.FIRE_AND_FORGET
)

Attributes

cluster

The topic to run the task on.

Return type

ICluster

container_overrides

Container setting overrides.

Key is the name of the container to override, value is the values you want to override.

Default
  • No overrides

Return type

Optional[List[ContainerOverride]]

integration_pattern

The service integration pattern indicates different ways to call RunTask in ECS.

The valid value for Lambda is FIRE_AND_FORGET, SYNC and WAIT_FOR_TASK_TOKEN.

Default

FIRE_AND_FORGET

Return type

Optional[ServiceIntegrationPattern]

task_definition

Task Definition used for running tasks in the service.

Note: this must be TaskDefinition, and not ITaskDefinition, as it requires properties that are not known for imported task definitions

Return type

TaskDefinition