aws-cdk-lib.aws_stepfunctions_tasks.EcsRunTaskProps

interface EcsRunTaskProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.EcsRunTaskProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#EcsRunTaskProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.EcsRunTaskProps
Pythonaws_cdk.aws_stepfunctions_tasks.EcsRunTaskProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions_tasks » EcsRunTaskProps

Properties for ECS Tasks.

Example

const vpc = ec2.Vpc.fromLookup(this, 'Vpc', {
  isDefault: true,
});

const cluster = new ecs.Cluster(this, 'Ec2Cluster', { vpc });
cluster.addCapacity('DefaultAutoScalingGroup', {
  instanceType: new ec2.InstanceType('t2.micro'),
  vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC },
});

const taskDefinition = new ecs.TaskDefinition(this, 'TD', {
  compatibility: ecs.Compatibility.EC2,
});

taskDefinition.addContainer('TheContainer', {
  image: ecs.ContainerImage.fromRegistry('foo/bar'),
  memoryLimitMiB: 256,
});

const runTask = new tasks.EcsRunTask(this, 'Run', {
  integrationPattern: sfn.IntegrationPattern.RUN_JOB,
  cluster,
  taskDefinition,
  launchTarget: new tasks.EcsEc2LaunchTarget({
    placementStrategies: [
      ecs.PlacementStrategy.spreadAcrossInstances(),
      ecs.PlacementStrategy.packedByCpu(),
      ecs.PlacementStrategy.randomly(),
    ],
    placementConstraints: [
      ecs.PlacementConstraint.memberOf('blieptuut'),
    ],
  }),
  propagatedTagSource: ecs.PropagatedTagSource.TASK_DEFINITION,
});

Properties

NameTypeDescription
clusterIClusterThe ECS cluster to run the task on.
launchTargetIEcsLaunchTargetAn Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.
taskDefinitionTaskDefinition[disable-awslint:ref-via-interface] Task Definition used for running tasks in the service.
assignPublicIp?booleanAssign public IP addresses to each task.
comment?stringAn optional description for this state.
containerOverrides?ContainerOverride[]Container setting overrides.
credentials?CredentialsCredentials for an IAM Role that the State Machine assumes for executing the task.
heartbeat?⚠️DurationTimeout for the heartbeat.
heartbeatTimeout?TimeoutTimeout for the heartbeat.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
integrationPattern?IntegrationPatternAWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?stringJSONPath expression to select select a portion of the state output to pass to the next state.
propagatedTagSource?PropagatedTagSourceSpecifies whether to propagate the tags from the task definition to the task.
resultPath?stringJSONPath expression to indicate where to inject the state's output.
resultSelector?{ [string]: any }The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
revisionNumber?numberThe revision number of ECS task definiton family.
securityGroups?ISecurityGroup[]Existing security groups to use for the tasks.
subnets?SubnetSelectionSubnets to place the task's ENIs.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout for the task.

cluster

Type: ICluster

The ECS cluster to run the task on.


launchTarget

Type: IEcsLaunchTarget

An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.

See also: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html


taskDefinition

Type: TaskDefinition

[disable-awslint:ref-via-interface] 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 If you want to run a RunTask with an imported task definition, consider using CustomState


assignPublicIp?

Type: boolean (optional, default: false)

Assign public IP addresses to each task.


comment?

Type: string (optional, default: No comment)

An optional description for this state.


containerOverrides?

Type: ContainerOverride[] (optional, default: No overrides)

Container setting overrides.

Specify the container to use and the overrides to apply.


credentials?

Type: Credentials (optional, default: None (Task is executed using the State Machine's execution role))

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html


heartbeat?⚠️

⚠️ Deprecated: use heartbeatTimeout

Type: Duration (optional, default: None)

Timeout for the heartbeat.


heartbeatTimeout?

Type: Timeout (optional, default: None)

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface


inputPath?

Type: string (optional, default: The entire task input (JSON path '$'))

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.


integrationPattern?

Type: IntegrationPattern (optional, default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.)

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token


outputPath?

Type: string (optional, default: The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$'))

JSONPath expression to select select a portion of the state output to pass to the next state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.


propagatedTagSource?

Type: PropagatedTagSource (optional, default: No tags are propagated.)

Specifies whether to propagate the tags from the task definition to the task.

An error will be received if you specify the SERVICE option when running a task.

See also: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-propagateTags


resultPath?

Type: string (optional, default: Replaces the entire input with the result (JSON path '$'))

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.


resultSelector?

Type: { [string]: any } (optional, default: None)

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector


revisionNumber?

Type: number (optional, default: '$latest')

The revision number of ECS task definiton family.


securityGroups?

Type: ISecurityGroup[] (optional, default: A new security group is created)

Existing security groups to use for the tasks.


subnets?

Type: SubnetSelection (optional, default: Public subnets if assignPublicIp is set. Private subnets otherwise.)

Subnets to place the task's ENIs.


taskTimeout?

Type: Timeout (optional, default: None)

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface


timeout?⚠️

⚠️ Deprecated: use taskTimeout

Type: Duration (optional, default: None)

Timeout for the task.