Skip navigation links

Package software.amazon.awscdk.services.stepfunctions.tasks

Tasks for AWS Step Functions

See: Description

Package software.amazon.awscdk.services.stepfunctions.tasks Description

Tasks for AWS Step Functions

---

cdk-constructs: Stable

AWS Step Functions is a web service that enables you to coordinate the components of distributed applications and microservices using visual workflows. You build applications from individual components that each perform a discrete function, or task, allowing you to scale and change applications quickly.

A Task state represents a single unit of work performed by a state machine. All work in your state machine is performed by tasks.

This module is part of the AWS Cloud Development Kit project.

Table Of Contents

Task

A Task state represents a single unit of work performed by a state machine. In the CDK, the exact work to be done is determined by a class that implements IStepFunctionsTask.

AWS Step Functions integrates with some AWS services so that you can call API actions, and coordinate executions directly from the Amazon States Language in Step Functions. You can directly call and pass parameters to the APIs of those services.

Paths

In the Amazon States Language, a path is a string beginning with $ that you can use to identify components within JSON text.

Learn more about input and output processing in Step Functions here

InputPath

Both InputPath and Parameters fields provide a way to manipulate JSON as it moves through your workflow. AWS Step Functions applies the InputPath field first, and then the Parameters field. You can first filter your raw input to a selection you want using InputPath, and then apply Parameters to manipulate that input further, or add new values. If you don't specify an InputPath, a default value of $ will be used.

The following example provides the field named input as the input to the Task state that runs a Lambda function. 

 Function fn;
 
 LambdaInvoke submitJob = LambdaInvoke.Builder.create(this, "Invoke Handler")
         .lambdaFunction(fn)
         .inputPath("$.input")
         .build();

OutputPath

Tasks also allow you to select a portion of the state output to pass to the next state. This enables you to filter out unwanted information, and pass only the portion of the JSON that you care about. If you don't specify an OutputPath, a default value of $ will be used. This passes the entire JSON node to the next state.

The response from a Lambda function includes the response from the function as well as other metadata.

The following example assigns the output from the Task to a field named result 

 Function fn;
 
 LambdaInvoke submitJob = LambdaInvoke.Builder.create(this, "Invoke Handler")
         .lambdaFunction(fn)
         .outputPath("$.Payload.result")
         .build();

ResultSelector

You can use ResultSelector to manipulate the raw result of a Task, Map or Parallel state before it is passed to ResultPath. For service integrations, the raw result contains metadata in addition to the response payload. You can use ResultSelector to construct a JSON payload that becomes the effective result using static values or references to the raw result or context object.

The following example extracts the output payload of a Lambda function Task and combines it with some static values and the state name from the context object. 

 Function fn;
 
 LambdaInvoke.Builder.create(this, "Invoke Handler")
         .lambdaFunction(fn)
         .resultSelector(Map.of(
                 "lambdaOutput", JsonPath.stringAt("$.Payload"),
                 "invokeRequestId", JsonPath.stringAt("$.SdkResponseMetadata.RequestId"),
                 "staticValue", Map.of(
                         "foo", "bar"),
                 "stateName", JsonPath.stringAt("$.State.Name")))
         .build();

ResultPath

The output of a state can be a copy of its input, the result it produces (for example, output from a Task state’s Lambda function), or a combination of its input and result. Use ResultPath to control which combination of these is passed to the state output. If you don't specify an ResultPath, a default value of $ will be used.

The following example adds the item from calling DynamoDB's getItem API to the state input and passes it to the next state. 

 Table myTable;
 
 DynamoPutItem.Builder.create(this, "PutItem")
         .item(Map.of(
                 "MessageId", DynamoAttributeValue.fromString("message-id")))
         .table(myTable)
         .resultPath("$.Item")
         .build();

⚠️ The OutputPath is computed after applying ResultPath. All service integrations return metadata as part of their response. When using ResultPath, it's not possible to merge a subset of the task output to the input.

Task parameters from the state JSON

Most tasks take parameters. Parameter values can either be static, supplied directly in the workflow definition (by specifying their values), or a value available at runtime in the state machine's execution (either as its input or an output of a prior state). Parameter values available at runtime can be specified via the JsonPath class, using methods such as JsonPath.stringAt().

The following example provides the field named input as the input to the Lambda function and invokes it asynchronously. 

 Function fn;
 
 
 LambdaInvoke submitJob = LambdaInvoke.Builder.create(this, "Invoke Handler")
         .lambdaFunction(fn)
         .payload(TaskInput.fromJsonPathAt("$.input"))
         .invocationType(LambdaInvocationType.EVENT)
         .build();

You can also use intrinsic functions available on JsonPath, for example JsonPath.format(). Here is an example of starting an Athena query that is dynamically created using the task input: 

 AthenaStartQueryExecution startQueryExecutionJob = AthenaStartQueryExecution.Builder.create(this, "Athena Start Query")
         .queryString(JsonPath.format("select contacts where year={};", JsonPath.stringAt("$.year")))
         .queryExecutionContext(QueryExecutionContext.builder()
                 .databaseName("interactions")
                 .build())
         .resultConfiguration(ResultConfiguration.builder()
                 .encryptionConfiguration(EncryptionConfiguration.builder()
                         .encryptionOption(EncryptionOption.S3_MANAGED)
                         .build())
                 .outputLocation(Location.builder()
                         .bucketName("mybucket")
                         .objectKey("myprefix")
                         .build())
                 .build())
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .build();

Each service integration has its own set of parameters that can be supplied.

Evaluate Expression

Use the EvaluateExpression to perform simple operations referencing state paths. The expression referenced in the task will be evaluated in a Lambda function (eval()). This allows you to not have to write Lambda code for simple operations.

Example: convert a wait time from milliseconds to seconds, concat this in a message and wait: 

 EvaluateExpression convertToSeconds = EvaluateExpression.Builder.create(this, "Convert to seconds")
         .expression("$.waitMilliseconds / 1000")
         .resultPath("$.waitSeconds")
         .build();
 
 EvaluateExpression createMessage = EvaluateExpression.Builder.create(this, "Create message")
         // Note: this is a string inside a string.
         .expression("`Now waiting ${$.waitSeconds} seconds...`")
         .runtime(Runtime.NODEJS_14_X)
         .resultPath("$.message")
         .build();
 
 SnsPublish publishMessage = SnsPublish.Builder.create(this, "Publish message")
         .topic(new Topic(this, "cool-topic"))
         .message(TaskInput.fromJsonPathAt("$.message"))
         .resultPath("$.sns")
         .build();
 
 Wait wait = Wait.Builder.create(this, "Wait")
         .time(WaitTime.secondsPath("$.waitSeconds"))
         .build();
 
 StateMachine.Builder.create(this, "StateMachine")
         .definition(convertToSeconds.next(createMessage).next(publishMessage).next(wait))
         .build();

The EvaluateExpression supports a runtime prop to specify the Lambda runtime to use to evaluate the expression. Currently, only runtimes of the Node.js family are supported.

API Gateway

Step Functions supports API Gateway through the service integration pattern.

HTTP APIs are designed for low-latency, cost-effective integrations with AWS services, including AWS Lambda, and HTTP endpoints. HTTP APIs support OIDC and OAuth 2.0 authorization, and come with built-in support for CORS and automatic deployments. Previous-generation REST APIs currently offer more features. More details can be found here.

Call REST API Endpoint

The CallApiGatewayRestApiEndpoint calls the REST API endpoint. 

 import software.amazon.awscdk.services.apigateway.*;
 
 RestApi restApi = new RestApi(this, "MyRestApi");
 
 CallApiGatewayRestApiEndpoint invokeTask = CallApiGatewayRestApiEndpoint.Builder.create(this, "Call REST API")
         .api(restApi)
         .stageName("prod")
         .method(HttpMethod.GET)
         .build();

Be aware that the header values must be arrays. When passing the Task Token in the headers field WAIT_FOR_TASK_TOKEN integration, use JsonPath.array() to wrap the token in an array: 

 import software.amazon.awscdk.services.apigateway.*;
 RestApi api;
 
 
 CallApiGatewayRestApiEndpoint.Builder.create(this, "Endpoint")
         .api(api)
         .stageName("Stage")
         .method(HttpMethod.PUT)
         .integrationPattern(IntegrationPattern.WAIT_FOR_TASK_TOKEN)
         .headers(TaskInput.fromObject(Map.of(
                 "TaskToken", JsonPath.array(JsonPath.getTaskToken()))))
         .build();

Call HTTP API Endpoint

The CallApiGatewayHttpApiEndpoint calls the HTTP API endpoint. 

 import software.amazon.awscdk.services.apigatewayv2.*;
 
 HttpApi httpApi = new HttpApi(this, "MyHttpApi");
 
 CallApiGatewayHttpApiEndpoint invokeTask = CallApiGatewayHttpApiEndpoint.Builder.create(this, "Call HTTP API")
         .apiId(httpApi.getApiId())
         .apiStack(Stack.of(httpApi))
         .method(HttpMethod.GET)
         .build();

AWS SDK

Step Functions supports calling AWS service's API actions through the service integration pattern.

You can use Step Functions' AWS SDK integrations to call any of the over two hundred AWS services directly from your state machine, giving you access to over nine thousand API actions. 

 Bucket myBucket;
 
 CallAwsService getObject = CallAwsService.Builder.create(this, "GetObject")
         .service("s3")
         .action("getObject")
         .parameters(Map.of(
                 "Bucket", myBucket.getBucketName(),
                 "Key", JsonPath.stringAt("$.key")))
         .iamResources(List.of(myBucket.arnForObjects("*")))
         .build();

Use camelCase for actions and PascalCase for parameter names.

The task automatically adds an IAM statement to the state machine role's policy based on the service and action called. The resources for this statement must be specified in iamResources.

Use the iamAction prop to manually specify the IAM action name in the case where the IAM action name does not match with the API service/action name: 

 CallAwsService listBuckets = CallAwsService.Builder.create(this, "ListBuckets")
         .service("s3")
         .action("listBuckets")
         .iamResources(List.of("*"))
         .iamAction("s3:ListAllMyBuckets")
         .build();

Athena

Step Functions supports Athena through the service integration pattern.

StartQueryExecution

The StartQueryExecution API runs the SQL query statement. 

 AthenaStartQueryExecution startQueryExecutionJob = AthenaStartQueryExecution.Builder.create(this, "Start Athena Query")
         .queryString(JsonPath.stringAt("$.queryString"))
         .queryExecutionContext(QueryExecutionContext.builder()
                 .databaseName("mydatabase")
                 .build())
         .resultConfiguration(ResultConfiguration.builder()
                 .encryptionConfiguration(EncryptionConfiguration.builder()
                         .encryptionOption(EncryptionOption.S3_MANAGED)
                         .build())
                 .outputLocation(Location.builder()
                         .bucketName("query-results-bucket")
                         .objectKey("folder")
                         .build())
                 .build())
         .build();

GetQueryExecution

The GetQueryExecution API gets information about a single execution of a query. 

 AthenaGetQueryExecution getQueryExecutionJob = AthenaGetQueryExecution.Builder.create(this, "Get Query Execution")
         .queryExecutionId(JsonPath.stringAt("$.QueryExecutionId"))
         .build();

GetQueryResults

The GetQueryResults API that streams the results of a single query execution specified by QueryExecutionId from S3. 

 AthenaGetQueryResults getQueryResultsJob = AthenaGetQueryResults.Builder.create(this, "Get Query Results")
         .queryExecutionId(JsonPath.stringAt("$.QueryExecutionId"))
         .build();

StopQueryExecution

The StopQueryExecution API that stops a query execution. 

 AthenaStopQueryExecution stopQueryExecutionJob = AthenaStopQueryExecution.Builder.create(this, "Stop Query Execution")
         .queryExecutionId(JsonPath.stringAt("$.QueryExecutionId"))
         .build();

Batch

Step Functions supports Batch through the service integration pattern.

SubmitJob

The SubmitJob API submits an AWS Batch job from a job definition. 

 import software.amazon.awscdk.services.batch.*;
 JobDefinition batchJobDefinition;
 JobQueue batchQueue;
 
 
 BatchSubmitJob task = BatchSubmitJob.Builder.create(this, "Submit Job")
         .jobDefinitionArn(batchJobDefinition.getJobDefinitionArn())
         .jobName("MyJob")
         .jobQueueArn(batchQueue.getJobQueueArn())
         .build();

CodeBuild

Step Functions supports CodeBuild through the service integration pattern.

StartBuild

StartBuild starts a CodeBuild Project by Project Name. 

 import software.amazon.awscdk.services.codebuild.*;
 
 
 Project codebuildProject = Project.Builder.create(this, "Project")
         .projectName("MyTestProject")
         .buildSpec(BuildSpec.fromObject(Map.of(
                 "version", "0.2",
                 "phases", Map.of(
                         "build", Map.of(
                                 "commands", List.of("echo \"Hello, CodeBuild!\""))))))
         .build();
 
 CodeBuildStartBuild task = CodeBuildStartBuild.Builder.create(this, "Task")
         .project(codebuildProject)
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .environmentVariablesOverride(Map.of(
                 "ZONE", BuildEnvironmentVariable.builder()
                         .type(BuildEnvironmentVariableType.PLAINTEXT)
                         .value(JsonPath.stringAt("$.envVariables.zone"))
                         .build()))
         .build();

DynamoDB

You can call DynamoDB APIs from a Task state. Read more about calling DynamoDB APIs here

GetItem

The GetItem operation returns a set of attributes for the item with the given primary key. 

 Table myTable;
 
 DynamoGetItem.Builder.create(this, "Get Item")
         .key(Map.of("messageId", DynamoAttributeValue.fromString("message-007")))
         .table(myTable)
         .build();

PutItem

The PutItem operation creates a new item, or replaces an old item with a new item. 

 Table myTable;
 
 DynamoPutItem.Builder.create(this, "PutItem")
         .item(Map.of(
                 "MessageId", DynamoAttributeValue.fromString("message-007"),
                 "Text", DynamoAttributeValue.fromString(JsonPath.stringAt("$.bar")),
                 "TotalCount", DynamoAttributeValue.fromNumber(10)))
         .table(myTable)
         .build();

DeleteItem

The DeleteItem operation deletes a single item in a table by primary key. 

 Table myTable;
 
 DynamoDeleteItem.Builder.create(this, "DeleteItem")
         .key(Map.of("MessageId", DynamoAttributeValue.fromString("message-007")))
         .table(myTable)
         .resultPath(JsonPath.DISCARD)
         .build();

UpdateItem

The UpdateItem operation edits an existing item's attributes, or adds a new item to the table if it does not already exist. 

 Table myTable;
 
 DynamoUpdateItem.Builder.create(this, "UpdateItem")
         .key(Map.of(
                 "MessageId", DynamoAttributeValue.fromString("message-007")))
         .table(myTable)
         .expressionAttributeValues(Map.of(
                 ":val", DynamoAttributeValue.numberFromString(JsonPath.stringAt("$.Item.TotalCount.N")),
                 ":rand", DynamoAttributeValue.fromNumber(20)))
         .updateExpression("SET TotalCount = :val + :rand")
         .build();

ECS

Step Functions supports ECS/Fargate through the service integration pattern.

RunTask

RunTask starts a new task using the specified task definition.

EC2

The EC2 launch type allows you to run your containerized applications on a cluster of Amazon EC2 instances that you manage.

When a task that uses the EC2 launch type is launched, Amazon ECS must determine where to place the task based on the requirements specified in the task definition, such as CPU and memory. Similarly, when you scale down the task count, Amazon ECS must determine which tasks to terminate. You can apply task placement strategies and constraints to customize how Amazon ECS places and terminates tasks. Learn more about task placement

The latest ACTIVE revision of the passed task definition is used for running the task.

The following example runs a job from a task definition on EC2 

 IVpc vpc = Vpc.fromLookup(this, "Vpc", VpcLookupOptions.builder()
         .isDefault(true)
         .build());
 
 Cluster cluster = Cluster.Builder.create(this, "Ec2Cluster").vpc(vpc).build();
 cluster.addCapacity("DefaultAutoScalingGroup", AddCapacityOptions.builder()
         .instanceType(new InstanceType("t2.micro"))
         .vpcSubnets(SubnetSelection.builder().subnetType(SubnetType.PUBLIC).build())
         .build());
 
 TaskDefinition taskDefinition = TaskDefinition.Builder.create(this, "TD")
         .compatibility(Compatibility.EC2)
         .build();
 
 taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("foo/bar"))
         .memoryLimitMiB(256)
         .build());
 
 EcsRunTask runTask = EcsRunTask.Builder.create(this, "Run")
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .launchTarget(EcsEc2LaunchTarget.Builder.create()
                 .placementStrategies(List.of(PlacementStrategy.spreadAcrossInstances(), PlacementStrategy.packedByCpu(), PlacementStrategy.randomly()))
                 .placementConstraints(List.of(PlacementConstraint.memberOf("blieptuut")))
                 .build())
         .build();

Fargate

AWS Fargate is a serverless compute engine for containers that works with Amazon Elastic Container Service (ECS). Fargate makes it easy for you to focus on building your applications. Fargate removes the need to provision and manage servers, lets you specify and pay for resources per application, and improves security through application isolation by design. Learn more about Fargate

The Fargate launch type allows you to run your containerized applications without the need to provision and manage the backend infrastructure. Just register your task definition and Fargate launches the container for you. The latest ACTIVE revision of the passed task definition is used for running the task. Learn more about Fargate Versioning

The following example runs a job from a task definition on Fargate 

 IVpc vpc = Vpc.fromLookup(this, "Vpc", VpcLookupOptions.builder()
         .isDefault(true)
         .build());
 
 Cluster cluster = Cluster.Builder.create(this, "FargateCluster").vpc(vpc).build();
 
 TaskDefinition taskDefinition = TaskDefinition.Builder.create(this, "TD")
         .memoryMiB("512")
         .cpu("256")
         .compatibility(Compatibility.FARGATE)
         .build();
 
 ContainerDefinition containerDefinition = taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("foo/bar"))
         .memoryLimitMiB(256)
         .build());
 
 EcsRunTask runTask = EcsRunTask.Builder.create(this, "RunFargate")
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .assignPublicIp(true)
         .containerOverrides(List.of(ContainerOverride.builder()
                 .containerDefinition(containerDefinition)
                 .environment(List.of(TaskEnvironmentVariable.builder().name("SOME_KEY").value(JsonPath.stringAt("$.SomeKey")).build()))
                 .build()))
         .launchTarget(new EcsFargateLaunchTarget())
         .build();

EMR

Step Functions supports Amazon EMR through the service integration pattern. The service integration APIs correspond to Amazon EMR APIs but differ in the parameters that are used.

Read more about the differences when using these service integrations.

Create Cluster

Creates and starts running a cluster (job flow). Corresponds to the runJobFlow API in EMR. 

 Role clusterRole = Role.Builder.create(this, "ClusterRole")
         .assumedBy(new ServicePrincipal("ec2.amazonaws.com"))
         .build();
 
 Role serviceRole = Role.Builder.create(this, "ServiceRole")
         .assumedBy(new ServicePrincipal("elasticmapreduce.amazonaws.com"))
         .build();
 
 Role autoScalingRole = Role.Builder.create(this, "AutoScalingRole")
         .assumedBy(new ServicePrincipal("elasticmapreduce.amazonaws.com"))
         .build();
 
 autoScalingRole.assumeRolePolicy.addStatements(
 PolicyStatement.Builder.create()
         .effect(Effect.ALLOW)
         .principals(List.of(
             new ServicePrincipal("application-autoscaling.amazonaws.com")))
         .actions(List.of("sts:AssumeRole"))
         .build());
 
 EmrCreateCluster.Builder.create(this, "Create Cluster")
         .instances(InstancesConfigProperty.builder().build())
         .clusterRole(clusterRole)
         .name(TaskInput.fromJsonPathAt("$.ClusterName").getValue())
         .serviceRole(serviceRole)
         .autoScalingRole(autoScalingRole)
         .build();

If you want to run multiple steps in parallel, you can specify the stepConcurrencyLevel property. The concurrency range is between 1 and 256 inclusive, where the default concurrency of 1 means no step concurrency is allowed. stepConcurrencyLevel requires the EMR release label to be 5.28.0 or above. 

 EmrCreateCluster.Builder.create(this, "Create Cluster")
         .instances(InstancesConfigProperty.builder().build())
         .name(TaskInput.fromJsonPathAt("$.ClusterName").getValue())
         .stepConcurrencyLevel(10)
         .build();

Termination Protection

Locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or a job-flow error.

Corresponds to the setTerminationProtection API in EMR. 

 EmrSetClusterTerminationProtection.Builder.create(this, "Task")
         .clusterId("ClusterId")
         .terminationProtected(false)
         .build();

Terminate Cluster

Shuts down a cluster (job flow). Corresponds to the terminateJobFlows API in EMR. 

 EmrTerminateCluster.Builder.create(this, "Task")
         .clusterId("ClusterId")
         .build();

Add Step

Adds a new step to a running cluster. Corresponds to the addJobFlowSteps API in EMR. 

 EmrAddStep.Builder.create(this, "Task")
         .clusterId("ClusterId")
         .name("StepName")
         .jar("Jar")
         .actionOnFailure(ActionOnFailure.CONTINUE)
         .build();

Cancel Step

Cancels a pending step in a running cluster. Corresponds to the cancelSteps API in EMR. 

 EmrCancelStep.Builder.create(this, "Task")
         .clusterId("ClusterId")
         .stepId("StepId")
         .build();

Modify Instance Fleet

Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetName.

Corresponds to the modifyInstanceFleet API in EMR. 

 EmrModifyInstanceFleetByName.Builder.create(this, "Task")
         .clusterId("ClusterId")
         .instanceFleetName("InstanceFleetName")
         .targetOnDemandCapacity(2)
         .targetSpotCapacity(0)
         .build();

Modify Instance Group

Modifies the number of nodes and configuration settings of an instance group.

Corresponds to the modifyInstanceGroups API in EMR. 

 EmrModifyInstanceGroupByName.Builder.create(this, "Task")
         .clusterId("ClusterId")
         .instanceGroupName(JsonPath.stringAt("$.InstanceGroupName"))
         .instanceGroup(InstanceGroupModifyConfigProperty.builder()
                 .instanceCount(1)
                 .build())
         .build();

EMR on EKS

Step Functions supports Amazon EMR on EKS through the service integration pattern. The service integration APIs correspond to Amazon EMR on EKS APIs, but differ in the parameters that are used.

Read more about the differences when using these service integrations.

Setting up the EKS cluster is required.

Create Virtual Cluster

The CreateVirtualCluster API creates a single virtual cluster that's mapped to a single Kubernetes namespace.

The EKS cluster containing the Kubernetes namespace where the virtual cluster will be mapped can be passed in from the task input. 

 EmrContainersCreateVirtualCluster.Builder.create(this, "Create a Virtual Cluster")
         .eksCluster(EksClusterInput.fromTaskInput(TaskInput.fromText("clusterId")))
         .build();

The EKS cluster can also be passed in directly. 

 import software.amazon.awscdk.services.eks.*;
 
 Cluster eksCluster;
 
 
 EmrContainersCreateVirtualCluster.Builder.create(this, "Create a Virtual Cluster")
         .eksCluster(EksClusterInput.fromCluster(eksCluster))
         .build();

By default, the Kubernetes namespace that a virtual cluster maps to is "default", but a specific namespace within an EKS cluster can be selected. 

 EmrContainersCreateVirtualCluster.Builder.create(this, "Create a Virtual Cluster")
         .eksCluster(EksClusterInput.fromTaskInput(TaskInput.fromText("clusterId")))
         .eksNamespace("specified-namespace")
         .build();

Delete Virtual Cluster

The DeleteVirtualCluster API deletes a virtual cluster. 

 EmrContainersDeleteVirtualCluster.Builder.create(this, "Delete a Virtual Cluster")
         .virtualClusterId(TaskInput.fromJsonPathAt("$.virtualCluster"))
         .build();

Start Job Run

The StartJobRun API starts a job run. A job is a unit of work that you submit to Amazon EMR on EKS for execution. The work performed by the job can be defined by a Spark jar, PySpark script, or SparkSQL query. A job run is an execution of the job on the virtual cluster.

Required setup:

The following actions must be performed if the virtual cluster ID is supplied from the task input. Otherwise, if it is supplied statically in the state machine definition, these actions will be done automatically.

The job can be configured with spark submit parameters: 

 EmrContainersStartJobRun.Builder.create(this, "EMR Containers Start Job Run")
         .virtualCluster(VirtualClusterInput.fromVirtualClusterId("de92jdei2910fwedz"))
         .releaseLabel(ReleaseLabel.EMR_6_2_0)
         .jobDriver(JobDriver.builder()
                 .sparkSubmitJobDriver(SparkSubmitJobDriver.builder()
                         .entryPoint(TaskInput.fromText("local:///usr/lib/spark/examples/src/main/python/pi.py"))
                         .sparkSubmitParameters("--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1")
                         .build())
                 .build())
         .build();

Configuring the job can also be done via application configuration: 

 EmrContainersStartJobRun.Builder.create(this, "EMR Containers Start Job Run")
         .virtualCluster(VirtualClusterInput.fromVirtualClusterId("de92jdei2910fwedz"))
         .releaseLabel(ReleaseLabel.EMR_6_2_0)
         .jobName("EMR-Containers-Job")
         .jobDriver(JobDriver.builder()
                 .sparkSubmitJobDriver(SparkSubmitJobDriver.builder()
                         .entryPoint(TaskInput.fromText("local:///usr/lib/spark/examples/src/main/python/pi.py"))
                         .build())
                 .build())
         .applicationConfig(List.of(ApplicationConfiguration.builder()
                 .classification(Classification.SPARK_DEFAULTS)
                 .properties(Map.of(
                         "spark.executor.instances", "1",
                         "spark.executor.memory", "512M"))
                 .build()))
         .build();

Job monitoring can be enabled if monitoring.logging is set true. This automatically generates an S3 bucket and CloudWatch logs. 

 EmrContainersStartJobRun.Builder.create(this, "EMR Containers Start Job Run")
         .virtualCluster(VirtualClusterInput.fromVirtualClusterId("de92jdei2910fwedz"))
         .releaseLabel(ReleaseLabel.EMR_6_2_0)
         .jobDriver(JobDriver.builder()
                 .sparkSubmitJobDriver(SparkSubmitJobDriver.builder()
                         .entryPoint(TaskInput.fromText("local:///usr/lib/spark/examples/src/main/python/pi.py"))
                         .sparkSubmitParameters("--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1")
                         .build())
                 .build())
         .monitoring(Monitoring.builder()
                 .logging(true)
                 .build())
         .build();

Otherwise, providing monitoring for jobs with existing log groups and log buckets is also available. 

 import software.amazon.awscdk.services.logs.*;
 
 
 LogGroup logGroup = new LogGroup(this, "Log Group");
 Bucket logBucket = new Bucket(this, "S3 Bucket");
 
 EmrContainersStartJobRun.Builder.create(this, "EMR Containers Start Job Run")
         .virtualCluster(VirtualClusterInput.fromVirtualClusterId("de92jdei2910fwedz"))
         .releaseLabel(ReleaseLabel.EMR_6_2_0)
         .jobDriver(JobDriver.builder()
                 .sparkSubmitJobDriver(SparkSubmitJobDriver.builder()
                         .entryPoint(TaskInput.fromText("local:///usr/lib/spark/examples/src/main/python/pi.py"))
                         .sparkSubmitParameters("--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1")
                         .build())
                 .build())
         .monitoring(Monitoring.builder()
                 .logGroup(logGroup)
                 .logBucket(logBucket)
                 .build())
         .build();

Users can provide their own existing Job Execution Role. 

 EmrContainersStartJobRun.Builder.create(this, "EMR Containers Start Job Run")
         .virtualCluster(VirtualClusterInput.fromTaskInput(TaskInput.fromJsonPathAt("$.VirtualClusterId")))
         .releaseLabel(ReleaseLabel.EMR_6_2_0)
         .jobName("EMR-Containers-Job")
         .executionRole(Role.fromRoleArn(this, "Job-Execution-Role", "arn:aws:iam::xxxxxxxxxxxx:role/JobExecutionRole"))
         .jobDriver(JobDriver.builder()
                 .sparkSubmitJobDriver(SparkSubmitJobDriver.builder()
                         .entryPoint(TaskInput.fromText("local:///usr/lib/spark/examples/src/main/python/pi.py"))
                         .sparkSubmitParameters("--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1")
                         .build())
                 .build())
         .build();

EKS

Step Functions supports Amazon EKS through the service integration pattern. The service integration APIs correspond to Amazon EKS APIs.

Read more about the differences when using these service integrations.

Call

Read and write Kubernetes resource objects via a Kubernetes API endpoint. Corresponds to the call API in Step Functions Connector.

The following code snippet includes a Task state that uses eks:call to list the pods. 

 import software.amazon.awscdk.services.eks.*;
 
 
 Cluster myEksCluster = Cluster.Builder.create(this, "my sample cluster")
         .version(KubernetesVersion.V1_18)
         .clusterName("myEksCluster")
         .build();
 
 EksCall.Builder.create(this, "Call a EKS Endpoint")
         .cluster(myEksCluster)
         .httpMethod(HttpMethods.GET)
         .httpPath("/api/v1/namespaces/default/pods")
         .build();

EventBridge

Step Functions supports Amazon EventBridge through the service integration pattern. The service integration APIs correspond to Amazon EventBridge APIs.

Read more about the differences when using these service integrations.

Put Events

Send events to an EventBridge bus. Corresponds to the put-events API in Step Functions Connector.

The following code snippet includes a Task state that uses events:putevents to send an event to the default bus. 

 import software.amazon.awscdk.services.events.*;
 
 
 EventBus myEventBus = EventBus.Builder.create(this, "EventBus")
         .eventBusName("MyEventBus1")
         .build();
 
 EventBridgePutEvents.Builder.create(this, "Send an event to EventBridge")
         .entries(List.of(EventBridgePutEventsEntry.builder()
                 .detail(TaskInput.fromObject(Map.of(
                         "Message", "Hello from Step Functions!")))
                 .eventBus(myEventBus)
                 .detailType("MessageFromStepFunctions")
                 .source("step.functions")
                 .build()))
         .build();

Glue

Step Functions supports AWS Glue through the service integration pattern.

You can call the StartJobRun API from a Task state. 

 GlueStartJobRun.Builder.create(this, "Task")
         .glueJobName("my-glue-job")
         .arguments(TaskInput.fromObject(Map.of(
                 "key", "value")))
         .timeout(Duration.minutes(30))
         .notifyDelayAfter(Duration.minutes(5))
         .build();

Glue DataBrew

Step Functions supports AWS Glue DataBrew through the service integration pattern.

You can call the StartJobRun API from a Task state. 

 GlueDataBrewStartJobRun.Builder.create(this, "Task")
         .name("databrew-job")
         .build();

Lambda

Invoke a Lambda function.

You can specify the input to your Lambda function through the payload attribute. By default, Step Functions invokes Lambda function with the state input (JSON path '$') as the input.

The following snippet invokes a Lambda Function with the state input as the payload by referencing the $ path. 

 Function fn;
 
 LambdaInvoke.Builder.create(this, "Invoke with state input")
         .lambdaFunction(fn)
         .build();

When a function is invoked, the Lambda service sends these response elements back.

⚠️ The response from the Lambda function is in an attribute called Payload

The following snippet invokes a Lambda Function by referencing the $.Payload path to reference the output of a Lambda executed before it. 

 Function fn;
 
 LambdaInvoke.Builder.create(this, "Invoke with empty object as payload")
         .lambdaFunction(fn)
         .payload(TaskInput.fromObject(Map.of()))
         .build();
 
 // use the output of fn as input
 // use the output of fn as input
 LambdaInvoke.Builder.create(this, "Invoke with payload field in the state input")
         .lambdaFunction(fn)
         .payload(TaskInput.fromJsonPathAt("$.Payload"))
         .build();

The following snippet invokes a Lambda and sets the task output to only include the Lambda function response. 

 Function fn;
 
 LambdaInvoke.Builder.create(this, "Invoke and set function response as task output")
         .lambdaFunction(fn)
         .outputPath("$.Payload")
         .build();

If you want to combine the input and the Lambda function response you can use the payloadResponseOnly property and specify the resultPath. This will put the Lambda function ARN directly in the "Resource" string, but it conflicts with the integrationPattern, invocationType, clientContext, and qualifier properties. 

 Function fn;
 
 LambdaInvoke.Builder.create(this, "Invoke and combine function response with task input")
         .lambdaFunction(fn)
         .payloadResponseOnly(true)
         .resultPath("$.fn")
         .build();

You can have Step Functions pause a task, and wait for an external process to return a task token. Read more about the callback pattern

To use the callback pattern, set the token property on the task. Call the Step Functions SendTaskSuccess or SendTaskFailure APIs with the token to indicate that the task has completed and the state machine should resume execution.

The following snippet invokes a Lambda with the task token as part of the input to the Lambda. 

 Function fn;
 
 LambdaInvoke.Builder.create(this, "Invoke with callback")
         .lambdaFunction(fn)
         .integrationPattern(IntegrationPattern.WAIT_FOR_TASK_TOKEN)
         .payload(TaskInput.fromObject(Map.of(
                 "token", JsonPath.getTaskToken(),
                 "input", JsonPath.stringAt("$.someField"))))
         .build();

⚠️ The task will pause until it receives that task token back with a SendTaskSuccess or SendTaskFailure call. Learn more about Callback with the Task Token.

AWS Lambda can occasionally experience transient service errors. In this case, invoking Lambda results in a 500 error, such as ServiceException, AWSLambdaException, or SdkClientException. As a best practice, the LambdaInvoke task will retry on those errors with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts. Set the retryOnServiceExceptions prop to false to disable this behavior.

SageMaker

Step Functions supports AWS SageMaker through the service integration pattern.

If your training job or model uses resources from AWS Marketplace, network isolation is required. To do so, set the enableNetworkIsolation property to true for SageMakerCreateModel or SageMakerCreateTrainingJob.

To set environment variables for the Docker container use the environment property.

Create Training Job

You can call the CreateTrainingJob API from a Task state. 

 SageMakerCreateTrainingJob.Builder.create(this, "TrainSagemaker")
         .trainingJobName(JsonPath.stringAt("$.JobName"))
         .algorithmSpecification(AlgorithmSpecification.builder()
                 .algorithmName("BlazingText")
                 .trainingInputMode(InputMode.FILE)
                 .build())
         .inputDataConfig(List.of(Channel.builder()
                 .channelName("train")
                 .dataSource(DataSource.builder()
                         .s3DataSource(S3DataSource.builder()
                                 .s3DataType(S3DataType.S3_PREFIX)
                                 .s3Location(S3Location.fromJsonExpression("$.S3Bucket"))
                                 .build())
                         .build())
                 .build()))
         .outputDataConfig(OutputDataConfig.builder()
                 .s3OutputLocation(S3Location.fromBucket(Bucket.fromBucketName(this, "Bucket", "mybucket"), "myoutputpath"))
                 .build())
         .resourceConfig(ResourceConfig.builder()
                 .instanceCount(1)
                 .instanceType(new InstanceType(JsonPath.stringAt("$.InstanceType")))
                 .volumeSize(Size.gibibytes(50))
                 .build()) // optional: default is 1 instance of EC2 `M4.XLarge` with `10GB` volume
         .stoppingCondition(StoppingCondition.builder()
                 .maxRuntime(Duration.hours(2))
                 .build())
         .build();

Create Transform Job

You can call the CreateTransformJob API from a Task state. 

 SageMakerCreateTransformJob.Builder.create(this, "Batch Inference")
         .transformJobName("MyTransformJob")
         .modelName("MyModelName")
         .modelClientOptions(ModelClientOptions.builder()
                 .invocationsMaxRetries(3) // default is 0
                 .invocationsTimeout(Duration.minutes(5))
                 .build())
         .transformInput(TransformInput.builder()
                 .transformDataSource(TransformDataSource.builder()
                         .s3DataSource(TransformS3DataSource.builder()
                                 .s3Uri("s3://inputbucket/train")
                                 .s3DataType(S3DataType.S3_PREFIX)
                                 .build())
                         .build())
                 .build())
         .transformOutput(TransformOutput.builder()
                 .s3OutputPath("s3://outputbucket/TransformJobOutputPath")
                 .build())
         .transformResources(TransformResources.builder()
                 .instanceCount(1)
                 .instanceType(InstanceType.of(InstanceClass.M4, InstanceSize.XLARGE))
                 .build())
         .build();

Create Endpoint

You can call the CreateEndpoint API from a Task state. 

 SageMakerCreateEndpoint.Builder.create(this, "SagemakerEndpoint")
         .endpointName(JsonPath.stringAt("$.EndpointName"))
         .endpointConfigName(JsonPath.stringAt("$.EndpointConfigName"))
         .build();

Create Endpoint Config

You can call the CreateEndpointConfig API from a Task state. 

 SageMakerCreateEndpointConfig.Builder.create(this, "SagemakerEndpointConfig")
         .endpointConfigName("MyEndpointConfig")
         .productionVariants(List.of(ProductionVariant.builder()
                 .initialInstanceCount(2)
                 .instanceType(InstanceType.of(InstanceClass.M5, InstanceSize.XLARGE))
                 .modelName("MyModel")
                 .variantName("awesome-variant")
                 .build()))
         .build();

Create Model

You can call the CreateModel API from a Task state. 

 SageMakerCreateModel.Builder.create(this, "Sagemaker")
         .modelName("MyModel")
         .primaryContainer(ContainerDefinition.Builder.create()
                 .image(DockerImage.fromJsonExpression(JsonPath.stringAt("$.Model.imageName")))
                 .mode(Mode.SINGLE_MODEL)
                 .modelS3Location(S3Location.fromJsonExpression("$.TrainingJob.ModelArtifacts.S3ModelArtifacts"))
                 .build())
         .build();

Update Endpoint

You can call the UpdateEndpoint API from a Task state. 

 SageMakerUpdateEndpoint.Builder.create(this, "SagemakerEndpoint")
         .endpointName(JsonPath.stringAt("$.Endpoint.Name"))
         .endpointConfigName(JsonPath.stringAt("$.Endpoint.EndpointConfig"))
         .build();

SNS

Step Functions supports Amazon SNS through the service integration pattern.

You can call the Publish API from a Task state to publish to an SNS topic. 

 Topic topic = new Topic(this, "Topic");
 
 // Use a field from the execution data as message.
 SnsPublish task1 = SnsPublish.Builder.create(this, "Publish1")
         .topic(topic)
         .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
         .message(TaskInput.fromDataAt("$.state.message"))
         .messageAttributes(Map.of(
                 "place", MessageAttribute.builder()
                         .value(JsonPath.stringAt("$.place"))
                         .build(),
                 "pic", MessageAttribute.builder()
                         // BINARY must be explicitly set
                         .dataType(MessageAttributeDataType.BINARY)
                         .value(JsonPath.stringAt("$.pic"))
                         .build(),
                 "people", MessageAttribute.builder()
                         .value(4)
                         .build(),
                 "handles", MessageAttribute.builder()
                         .value(List.of("@kslater", "@jjf", null, "@mfanning"))
                         .build()))
         .build();
 
 // Combine a field from the execution data with
 // a literal object.
 SnsPublish task2 = SnsPublish.Builder.create(this, "Publish2")
         .topic(topic)
         .message(TaskInput.fromObject(Map.of(
                 "field1", "somedata",
                 "field2", JsonPath.stringAt("$.field2"))))
         .build();

Step Functions

Start Execution

You can manage AWS Step Functions executions.

AWS Step Functions supports it's own StartExecution API as a service integration. 

 // Define a state machine with one Pass state
 StateMachine child = StateMachine.Builder.create(this, "ChildStateMachine")
         .definition(Chain.start(new Pass(this, "PassState")))
         .build();
 
 // Include the state machine in a Task state with callback pattern
 StepFunctionsStartExecution task = StepFunctionsStartExecution.Builder.create(this, "ChildTask")
         .stateMachine(child)
         .integrationPattern(IntegrationPattern.WAIT_FOR_TASK_TOKEN)
         .input(TaskInput.fromObject(Map.of(
                 "token", JsonPath.getTaskToken(),
                 "foo", "bar")))
         .name("MyExecutionName")
         .build();
 
 // Define a second state machine with the Task state above
 // Define a second state machine with the Task state above
 StateMachine.Builder.create(this, "ParentStateMachine")
         .definition(task)
         .build();

You can utilize Associate Workflow Executions via the associateWithParent property. This allows the Step Functions UI to link child executions from parent executions, making it easier to trace execution flow across state machines. 

 StateMachine child;
 
 StepFunctionsStartExecution task = StepFunctionsStartExecution.Builder.create(this, "ChildTask")
         .stateMachine(child)
         .associateWithParent(true)
         .build();

This will add the payload AWS_STEP_FUNCTIONS_STARTED_BY_EXECUTION_ID.$: $$.Execution.Id to the inputproperty for you, which will pass the execution ID from the context object to the execution input. It requires input to be an object or not be set at all.

Invoke Activity

You can invoke a Step Functions Activity which enables you to have a task in your state machine where the work is performed by a worker that can be hosted on Amazon EC2, Amazon ECS, AWS Lambda, basically anywhere. Activities are a way to associate code running somewhere (known as an activity worker) with a specific task in a state machine.

When Step Functions reaches an activity task state, the workflow waits for an activity worker to poll for a task. An activity worker polls Step Functions by using GetActivityTask, and sending the ARN for the related activity.

After the activity worker completes its work, it can provide a report of its success or failure by using SendTaskSuccess or SendTaskFailure. These two calls use the taskToken provided by GetActivityTask to associate the result with that task.

The following example creates an activity and creates a task that invokes the activity. 

 Activity submitJobActivity = new Activity(this, "SubmitJob");
 
 StepFunctionsInvokeActivity.Builder.create(this, "Submit Job")
         .activity(submitJobActivity)
         .build();

SQS

Step Functions supports Amazon SQS

You can call the SendMessage API from a Task state to send a message to an SQS queue. 

 Queue queue = new Queue(this, "Queue");
 
 // Use a field from the execution data as message.
 SqsSendMessage task1 = SqsSendMessage.Builder.create(this, "Send1")
         .queue(queue)
         .messageBody(TaskInput.fromJsonPathAt("$.message"))
         .build();
 
 // Combine a field from the execution data with
 // a literal object.
 SqsSendMessage task2 = SqsSendMessage.Builder.create(this, "Send2")
         .queue(queue)
         .messageBody(TaskInput.fromObject(Map.of(
                 "field1", "somedata",
                 "field2", JsonPath.stringAt("$.field2"))))
         .build();
Skip navigation links