RunEcsFargateTaskProps¶

class aws_cdk.aws_stepfunctions_tasks.RunEcsFargateTaskProps(*, cluster, task_definition, container_overrides=None, integration_pattern=None, assign_public_ip=None, platform_version=None, security_group=None, subnets=None)¶

Bases: aws_cdk.aws_stepfunctions_tasks.CommonEcsRunTaskProps

Properties to define an ECS service.

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[List[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
assign_public_ip (Optional[bool]) – Assign public IP addresses to each task. Default: false
platform_version (Optional[FargatePlatformVersion]) – Fargate platform version to run this service on. Unless you have specific compatibility requirements, you don’t need to specify this. Default: Latest
security_group (Optional[ISecurityGroup]) – Existing security group to use for the tasks. Default: A new security group is created
subnets (Optional[SubnetSelection]) – In what subnets to place the task’s ENIs. Default: Private subnet if assignPublicIp, public subnets otherwise

Attributes

assign_public_ip¶

Assign public IP addresses to each task.

Default: false
Return type: Optional[bool]

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]

platform_version¶

Fargate platform version to run this service on.

Unless you have specific compatibility requirements, you don’t need to specify this.

Default: Latest
Return type: Optional[FargatePlatformVersion]

security_group¶

Existing security group to use for the tasks.

Default: A new security group is created
Return type: Optional[ISecurityGroup]

subnets¶

In what subnets to place the task’s ENIs.

Default: Private subnet if assignPublicIp, public subnets otherwise
Return type: Optional[SubnetSelection]

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