# StepFunctionsInvokeActivityJsonPathProps

Properties for invoking an Activity worker using JSONPath.

Extends: [TaskStateJsonPathBaseProps](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.TaskStateJsonPathBaseProps.html)

- Source: [`aws-stepfunctions-tasks/lib/stepfunctions/invoke-activity.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/stepfunctions/invoke-activity.ts#L29)
- Type last changed: v2.178.0 · 6 Feb 2025

## Example

TypeScript:

```ts
// 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_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const activity: stepfunctions.Activity;
declare const assign: any;
declare const parameters: any;
declare const resultSelector: any;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const stepFunctionsInvokeActivityJsonPathProps: stepfunctions_tasks.StepFunctionsInvokeActivityJsonPathProps = {
  activity: activity,

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputPath: 'outputPath',
  parameters: {
    parametersKey: parameters,
  },
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks

# activity: stepfunctions.Activity
# assign: Any
# parameters: Any
# result_selector: Any
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

step_functions_invoke_activity_json_path_props = stepfunctions_tasks.StepFunctionsInvokeActivityJsonPathProps(
    activity=activity,

    # the properties below are optional
    assign={
        "assign_key": assign
    },
    comment="comment",
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    input_path="inputPath",
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    output_path="outputPath",
    parameters={
        "parameters_key": parameters
    },
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    result_path="resultPath",
    result_selector={
        "result_selector_key": result_selector
    },
    state_name="stateName",
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30)
)
```

Java:

```java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;

Activity activity;
Object assign;
Object parameters;
Object resultSelector;
TaskRole taskRole;
Timeout timeout;

StepFunctionsInvokeActivityJsonPathProps stepFunctionsInvokeActivityJsonPathProps = StepFunctionsInvokeActivityJsonPathProps.builder()
        .activity(activity)

        // the properties below are optional
        .assign(Map.of(
                "assignKey", assign))
        .comment("comment")
        .credentials(Credentials.builder()
                .role(taskRole)
                .build())
        .heartbeat(Duration.minutes(30))
        .heartbeatTimeout(timeout)
        .inputPath("inputPath")
        .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
        .outputPath("outputPath")
        .parameters(Map.of(
                "parametersKey", parameters))
        .queryLanguage(QueryLanguage.JSON_PATH)
        .resultPath("resultPath")
        .resultSelector(Map.of(
                "resultSelectorKey", resultSelector))
        .stateName("stateName")
        .taskTimeout(timeout)
        .timeout(Duration.minutes(30))
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;

Activity activity;
var assign;
var parameters;
var resultSelector;
TaskRole taskRole;
Timeout timeout;

var stepFunctionsInvokeActivityJsonPathProps = new StepFunctionsInvokeActivityJsonPathProps {
    Activity = activity,

    // the properties below are optional
    Assign = new Dictionary<string, object> {
        { "assignKey", assign }
    },
    Comment = "comment",
    Credentials = new Credentials {
        Role = taskRole
    },
    Heartbeat = Duration.Minutes(30),
    HeartbeatTimeout = timeout,
    InputPath = "inputPath",
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    OutputPath = "outputPath",
    Parameters = new Dictionary<string, object> {
        { "parametersKey", parameters }
    },
    QueryLanguage = QueryLanguage.JSON_PATH,
    ResultPath = "resultPath",
    ResultSelector = new Dictionary<string, object> {
        { "resultSelectorKey", resultSelector }
    },
    StateName = "stateName",
    TaskTimeout = timeout,
    Timeout = Duration.Minutes(30)
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var activity Activity
var assign interface{}
var parameters interface{}
var resultSelector interface{}
var taskRole TaskRole
var timeout Timeout

stepFunctionsInvokeActivityJsonPathProps := &StepFunctionsInvokeActivityJsonPathProps{
	Activity: activity,

	// the properties below are optional
	Assign: map[string]interface{}{
		"assignKey": assign,
	},
	Comment: jsii.String("comment"),
	Credentials: &Credentials{
		Role: taskRole,
	},
	Heartbeat: cdk.Duration_Minutes(jsii.Number(30)),
	HeartbeatTimeout: timeout,
	InputPath: jsii.String("inputPath"),
	IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
	OutputPath: jsii.String("outputPath"),
	Parameters: map[string]interface{}{
		"parametersKey": parameters,
	},
	QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
	ResultPath: jsii.String("resultPath"),
	ResultSelector: map[string]interface{}{
		"resultSelectorKey": resultSelector,
	},
	StateName: jsii.String("stateName"),
	TaskTimeout: timeout,
	Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
}
```

## Properties

- `activity`: [IActivity](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.IActivity.html) (required) — Step Functions Activity to invoke.

- `assign`: { [key: string]: any } — Workflow variables to store in this step.

  **Default:** Not assign variables

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

- `comment`: string — A comment describing this state.

  **Default:** No comment

- `credentials`: [Credentials](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Credentials.html) — Credentials for an IAM Role that the State Machine assumes for executing the task.

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

  This enables cross-account resource invocations.

- `heartbeat`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `heartbeatTimeout`

- `heartbeatTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the heartbeat.

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

- `inputPath`: 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 {}.

- `integrationPattern`: [IntegrationPattern](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.IntegrationPattern.html) — AWS Step Functions integrates with services directly in the Amazon States Language.

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

  You can control these AWS services using service integration patterns.

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

- `outputPath`: 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 {}.

- `parameters`: { [key: string]: any } — Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

  **Default:** No parameters

- `queryLanguage`: [QueryLanguage](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.QueryLanguage.html) = 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`: 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 } = 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.

- `stateName`: string — Optional name for this state.

  **Default:** The construct ID will be used as state name

- `taskTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the task.

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

- `timeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `taskTimeout`
