aws-cdk-lib.aws_stepfunctions_tasks.EcsRunTaskJsonPathProps

EcsRunTaskJsonPathProps Struct

Properties for ECS Tasks using JSONPath.

EcsRunTaskJsonPathProps

extends

• TaskStateJsonPathBaseProps

Source

aws-stepfunctions-tasks/lib/ecs/run-task.ts

Type last changed

v2.178.0 · 6 Feb 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const cluster: ecs.Cluster;
declare const containerDefinition: ecs.ContainerDefinition;
declare const ecsLaunchTarget: stepfunctions_tasks.IEcsLaunchTarget;
declare const resultSelector: any;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const taskDefinition: ecs.TaskDefinition;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const ecsRunTaskJsonPathProps: stepfunctions_tasks.EcsRunTaskJsonPathProps = {
  cluster: cluster,
  launchTarget: ecsLaunchTarget,
  taskDefinition: taskDefinition,

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  assignPublicIp: false,
  comment: 'comment',
  containerOverrides: [{
    containerDefinition: containerDefinition,

    // the properties below are optional
    command: ['command'],
    cpu: 123,
    environment: [{
      name: 'name',
      value: 'value',
    }],
    memoryLimit: 123,
    memoryReservation: 123,
  }],
  cpu: 'cpu',
  credentials: {
    role: taskRole,
  },
  enableExecuteCommand: false,
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  memoryMiB: 'memoryMiB',
  outputPath: 'outputPath',
  propagatedTagSource: ecs.PropagatedTagSource.SERVICE,
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  revisionNumber: 123,
  securityGroups: [securityGroup],
  stateName: 'stateName',
  subnets: {
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
  },
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};

Properties

assign{ [key: string]: any }assigntyping.Mapping[str, Any]assignMap<String, Object>AssignIDictionary<string, object>Assign*map[string]interface{}= 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.

assignPublicIpbooleanassign_public_ipboolassignPublicIpBooleanAssignPublicIpboolAssignPublicIp*bool= false#

Assign public IP addresses to each task.

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#

The ECS cluster to run the task on.

commentstringcommentstrcommentStringCommentstringComment*string= No comment#

A comment describing this state.

containerOverridesContainerOverride[]container_overridestyping.List[ContainerOverride]containerOverridesList<ContainerOverride>ContainerOverridesContainerOverride[]ContainerOverrides*[]ContainerOverride= No overrides#

Container setting overrides.

Specify the container to use and the overrides to apply.

cpustringcpustrcpuStringCpustringCpu*string= No override#

Cpu setting override.

credentialsCredentialscredentialsCredentialscredentialsCredentialsCredentialsCredentialsCredentialsCredentials= None (Task is executed using the…#

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

This enables cross-account resource invocations.

default

Default: None (Task is executed using the State Machine's execution role)

enableExecuteCommandbooleanenable_execute_commandboolenableExecuteCommandBooleanEnableExecuteCommandboolEnableExecuteCommand*bool= false#

Whether ECS Exec should be enabled.

heartbeatDurationheartbeatDurationheartbeatDurationHeartbeatDurationHeartbeatDuration= Nonedeprecated#

use `heartbeatTimeout`

heartbeatTimeoutTimeoutheartbeat_timeoutTimeoutheartbeatTimeoutTimeoutHeartbeatTimeoutTimeoutHeartbeatTimeoutTimeout= None#

Timeout for the heartbeat.

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

inputPathstringinput_pathstrinputPathStringInputPathstringInputPath*string= $#

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 {}.

integrationPatternIntegrationPatternintegration_patternIntegrationPatternintegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPattern= `IntegrationPattern.REQUEST_RESP…#

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.

default

Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

launchTargetIEcsLaunchTargetlaunch_targetIEcsLaunchTargetlaunchTargetIEcsLaunchTargetLaunchTargetIEcsLaunchTargetLaunchTargetIEcsLaunchTargetrequired#

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

memoryMiBstringmemory_mi_bstrmemoryMiBStringMemoryMiBstringMemoryMiB*string= No override#

Memory setting override.

outputPathstringoutput_pathstroutputPathStringOutputPathstringOutputPath*string= $#

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 {}.

propagatedTagSourcePropagatedTagSourcepropagated_tag_sourcePropagatedTagSourcepropagatedTagSourcePropagatedTagSourcePropagatedTagSourcePropagatedTagSourcePropagatedTagSourcePropagatedTagSource= 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.

queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= 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.

resultPathstringresult_pathstrresultPathStringResultPathstringResultPath*string= $#

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{ [key: string]: any }result_selectortyping.Mapping[str, Any]resultSelectorMap<String, Object>ResultSelectorIDictionary<string, object>ResultSelector*map[string]interface{}= 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.

revisionNumbernumberrevision_numberint | floatrevisionNumberNumberRevisionNumberdoubleRevisionNumber*float64= '$latest'#

The revision number of ECS task definition family.

securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup= A new security group is created#

Existing security groups to use for the tasks.

stateNamestringstate_namestrstateNameStringStateNamestringStateName*string= The construct ID will be used as…#

Optional name for this state.

default

Default: The construct ID will be used as state name

subnetsSubnetSelectionsubnetsSubnetSelectionsubnetsSubnetSelectionSubnetsSubnetSelectionSubnetsSubnetSelection= Public subnets if assignPublicIp…#

Subnets to place the task's ENIs.

default

Default: Public subnets if assignPublicIp is set. Private subnets otherwise.

taskDefinitionTaskDefinitiontask_definitionTaskDefinitiontaskDefinitionTaskDefinitionTaskDefinitionTaskDefinitionTaskDefinitionTaskDefinitionrequired#

[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

taskTimeoutTimeouttask_timeoutTimeouttaskTimeoutTimeoutTaskTimeoutTimeoutTaskTimeoutTimeout= None#

Timeout for the task.

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

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Nonedeprecated#

use `taskTimeout`