interface EcsRunTaskProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.Tasks.EcsRunTaskProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#EcsRunTaskProps |
Java | software.amazon.awscdk.services.stepfunctions.tasks.EcsRunTaskProps |
Python | aws_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, '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,
});
Properties
Name | Type | Description |
---|---|---|
cluster | ICluster | The ECS cluster to run the task on. |
launch | IEcs | An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted. |
task | Task | [disable-awslint:ref-via-interface] Task Definition used for running tasks in the service. |
assign | boolean | Assign public IP addresses to each task. |
comment? | string | An optional description for this state. |
container | Container [] | Container setting overrides. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
enable | boolean | Whether ECS Exec should be enabled. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
output | string | JSONPath expression to select select a portion of the state output to pass to the next state. |
propagated | Propagated | Specifies whether to propagate the tags from the task definition to the task. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
revision | number | The revision number of ECS task definition family. |
security | ISecurity [] | Existing security groups to use for the tasks. |
state | string | Optional name for this state. |
subnets? | Subnet | Subnets to place the task's ENIs. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
cluster
Type:
ICluster
The ECS cluster to run the task on.
launchTarget
Type:
IEcs
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:
Task
[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:
Container
[]
(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
enableExecuteCommand?
Type:
boolean
(optional, default: false)
Whether ECS Exec should be enabled.
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:
Integration
(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
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:
Propagated
(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.
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.
revisionNumber?
Type:
number
(optional, default: '$latest')
The revision number of ECS task definition family.
securityGroups?
Type:
ISecurity
[]
(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:
Subnet
(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.