class EcsRunTask (construct)

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.EcsRunTask
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#EcsRunTask
Java	software.amazon.awscdk.services.stepfunctions.tasks.EcsRunTask
Python	aws_cdk.aws_stepfunctions_tasks.EcsRunTask
TypeScript (source)	aws-cdk-lib » aws_stepfunctions_tasks » EcsRunTask

Implements IConstruct, IDependable, IChainable, INextable, IConnectable

Run a Task on ECS or Fargate.

Example

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

const cluster = new ecs.Cluster(this, 'FargateCluster', { vpc });

const taskDefinition = new ecs.TaskDefinition(this, 'TD', {
  memoryMiB: '512',
  cpu: '256',
  compatibility: ecs.Compatibility.FARGATE,
});

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

const runTask = new tasks.EcsRunTask(this, 'RunFargate', {
  integrationPattern: sfn.IntegrationPattern.RUN_JOB,
  cluster,
  taskDefinition,
  assignPublicIp: true,
  containerOverrides: [{
    containerDefinition,
    environment: [{ name: 'SOME_KEY', value: sfn.JsonPath.stringAt('$.SomeKey') }],
  }],
  launchTarget: new tasks.EcsFargateLaunchTarget(),
  propagatedTagSource: ecs.PropagatedTagSource.TASK_DEFINITION,
});

Initializer

new EcsRunTask(scope: Construct, id: string, props: EcsRunTaskProps)

Parameters

• scope Construct
• id string — Descriptive identifier for this chainable.
• props EcsRunTaskProps

Construct Props

Name	Type	Description
cluster	ICluster	The ECS cluster to run the task on.
launchTarget	IEcsLaunchTarget	An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.
taskDefinition	TaskDefinition	[disable-awslint:ref-via-interface] Task Definition used for running tasks in the service.
assign?	{ [string]: any }	Workflow variables to store in this step.
assignPublicIp?	boolean	Assign public IP addresses to each task.
comment?	string	A comment describing this state.
containerOverrides?	ContainerOverride[]	Container setting overrides.
cpu?	string	Cpu setting override.
credentials?	Credentials	Credentials for an IAM Role that the State Machine assumes for executing the task.
enableExecuteCommand?	boolean	Whether ECS Exec should be enabled.
heartbeat?⚠️	Duration	Timeout for the heartbeat.
heartbeatTimeout?	Timeout	Timeout for the heartbeat.
inputPath?	string	JSONPath expression to select part of the state to be the input to this state.
integrationPattern?	IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
memoryMiB?	string	Memory setting override.
outputPath?	string	JSONPath expression to select part of the state to be the output to this state.
outputs?	any	Used to specify and transform output from the state.
propagatedTagSource?	PropagatedTagSource	Specifies whether to propagate the tags from the task definition to the task.
queryLanguage?	QueryLanguage	The name of the query language used by the state.
resultPath?	string	JSONPath 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?	number	The revision number of ECS task definition family.
securityGroups?	ISecurityGroup[]	Existing security groups to use for the tasks.
stateName?	string	Optional name for this state.
subnets?	SubnetSelection	Subnets to place the task's ENIs.
taskTimeout?	Timeout	Timeout for the task.
timeout?⚠️	Duration	Timeout 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

---

assign?

Type: { [string]: any } (optional, default: Not assign variables)

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

---

assignPublicIp?

Type: boolean (optional, default: false)

Assign public IP addresses to each task.

---

comment?

Type: string (optional, default: No comment)

A comment describing this state.

---

containerOverrides?

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

Container setting overrides.

Specify the container to use and the overrides to apply.

---

cpu?

Type: string (optional, default: No override)

Cpu setting override.

See also: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html

---

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

---

enableExecuteCommand?

Type: boolean (optional, default: false)

Whether ECS Exec should be enabled.

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

---

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: $)

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.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

---

memoryMiB?

Type: string (optional, default: No override)

Memory setting override.

See also: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html

---

outputPath?

Type: string (optional, default: $)

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

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

---

outputs?

Type: any (optional, default: $states.result or $states.errorOutput)

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

---

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

---

queryLanguage?

Type: QueryLanguage (optional, default: JSONPath)

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

---

resultPath?

Type: string (optional, default: $)

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 definition family.

---

securityGroups?

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

Existing security groups to use for the tasks.

---

stateName?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.

---

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.

Properties

Name	Type	Description
connections	Connections	Manage allowed network traffic for this service.
endStates	INextable[]	Continuable states of this Chainable.
id	string	Descriptive identifier for this chainable.
node	Node	The tree node.
startState	State	First state of this Chainable.
stateId	string	Tokenized string that evaluates to the state's ID.
taskMetrics?	TaskMetricsConfig
taskPolicies?	PolicyStatement[]

---

connections

Type: Connections

Manage allowed network traffic for this service.

---

endStates

Type: INextable[]

Continuable states of this Chainable.

---

id

Type: string

Descriptive identifier for this chainable.

---

node

Type: Node

The tree node.

---

startState

Type: State

First state of this Chainable.

---

stateId

Type: string

Tokenized string that evaluates to the state's ID.

---

taskMetrics?

Type: TaskMetricsConfig (optional)

---

taskPolicies?

Type: PolicyStatement[] (optional)

Methods

Name	Description
addCatch(handler, props?)	Add a recovery handler for this state.
addPrefix(x)	Add a prefix to the stateId of this state.
addRetry(props?)	Add retry configuration for this state.
bindToGraph(graph)	Register this state as part of the given graph.
metric(metricName, props?)	Return the given named metric for this Task.
metricFailed(props?)	Metric for the number of times this activity fails.
metricHeartbeatTimedOut(props?)	Metric for the number of times the heartbeat times out for this activity.
metricRunTime(props?)	The interval, in milliseconds, between the time the Task starts and the time it closes.
metricScheduleTime(props?)	The interval, in milliseconds, for which the activity stays in the schedule state.
metricScheduled(props?)	Metric for the number of times this activity is scheduled.
metricStarted(props?)	Metric for the number of times this activity is started.
metricSucceeded(props?)	Metric for the number of times this activity succeeds.
metricTime(props?)	The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
metricTimedOut(props?)	Metric for the number of times this activity times out.
next(next)	Continue normal execution with the given state.
toStateJson(topLevelQueryLanguage?)	Return the Amazon States Language object for this state.
toString()	Returns a string representation of this construct.
static jsonPath(scope, id, props)	Run a Task that using JSONPath on ECS or Fargate.
static jsonata(scope, id, props)	Run a Task that using JSONata on ECS or Fargate.

---

addCatch(handler, props?)

public addCatch(handler: IChainable, props?: CatchProps): TaskStateBase

Parameters

• handler IChainable
• props CatchProps

Returns

• TaskStateBase

Add a recovery handler for this state.

When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.

---

addPrefix(x)

public addPrefix(x: string): void

Parameters

• x string

Add a prefix to the stateId of this state.

---

addRetry(props?)

public addRetry(props?: RetryProps): TaskStateBase

Parameters

• props RetryProps

Returns

• TaskStateBase

Add retry configuration for this state.

This controls if and how the execution will be retried if a particular error occurs.

---

bindToGraph(graph)

public bindToGraph(graph: StateGraph): void

Parameters

• graph StateGraph

Register this state as part of the given graph.

Don't call this. It will be called automatically when you work with states normally.

---

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this Task.

---

metricFailed(props?)

public metricFailed(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity fails.

---

metricHeartbeatTimedOut(props?)

public metricHeartbeatTimedOut(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times the heartbeat times out for this activity.

---

metricRunTime(props?)

public metricRunTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The interval, in milliseconds, between the time the Task starts and the time it closes.

---

metricScheduleTime(props?)

public metricScheduleTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The interval, in milliseconds, for which the activity stays in the schedule state.

---

metricScheduled(props?)

public metricScheduled(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity is scheduled.

---

metricStarted(props?)

public metricStarted(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity is started.

---

metricSucceeded(props?)

public metricSucceeded(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity succeeds.

---

metricTime(props?)

public metricTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

---

metricTimedOut(props?)

public metricTimedOut(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times this activity times out.

---

next(next)

public next(next: IChainable): Chain

Parameters

• next IChainable

Returns

• Chain

Continue normal execution with the given state.

---

toStateJson(topLevelQueryLanguage?)

public toStateJson(topLevelQueryLanguage?: QueryLanguage): json

Parameters

• topLevelQueryLanguage QueryLanguage

Returns

• json

Return the Amazon States Language object for this state.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static jsonPath(scope, id, props)

public static jsonPath(scope: Construct, id: string, props: EcsRunTaskJsonPathProps): EcsRunTask

Parameters

• scope Construct
• id string
• props EcsRunTaskJsonPathProps

Returns

• EcsRunTask

Run a Task that using JSONPath on ECS or Fargate.

---

static jsonata(scope, id, props)

public static jsonata(scope: Construct, id: string, props: EcsRunTaskJsonataProps): EcsRunTask

Parameters

• scope Construct
• id string
• props EcsRunTaskJsonataProps

Returns

• EcsRunTask

Run a Task that using JSONata on ECS or Fargate.