LambdaInvokeJsonPathProps Struct
Properties for invoking a Lambda function with LambdaInvoke using JsonPath.
| Source | aws-stepfunctions-tasks/lib/lambda/invoke.ts |
|---|---|
| Type last changed |
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_lambda as lambda } 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 function_: lambda.Function;
declare const resultSelector: any;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const lambdaInvokeJsonPathProps: stepfunctions_tasks.LambdaInvokeJsonPathProps = {
lambdaFunction: function_,
// the properties below are optional
assign: {
assignKey: assign,
},
clientContext: 'clientContext',
comment: 'comment',
credentials: {
role: taskRole,
},
heartbeat: cdk.Duration.minutes(30),
heartbeatTimeout: timeout,
inputPath: 'inputPath',
integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
invocationType: stepfunctions_tasks.LambdaInvocationType.REQUEST_RESPONSE,
outputPath: 'outputPath',
payload: taskInput,
payloadResponseOnly: false,
qualifier: 'qualifier',
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
resultPath: 'resultPath',
resultSelector: {
resultSelectorKey: resultSelector,
},
retryOnServiceExceptions: false,
stateName: 'stateName',
taskTimeout: timeout,
timeout: cdk.Duration.minutes(30),
};
# 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_lambda as lambda_
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks
# assign: Any
# function_: lambda.Function
# result_selector: Any
# task_input: stepfunctions.TaskInput
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout
lambda_invoke_json_path_props = stepfunctions_tasks.LambdaInvokeJsonPathProps(
lambda_function=function_,
# the properties below are optional
assign={
"assign_key": assign
},
client_context="clientContext",
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,
invocation_type=stepfunctions_tasks.LambdaInvocationType.REQUEST_RESPONSE,
output_path="outputPath",
payload=task_input,
payload_response_only=False,
qualifier="qualifier",
query_language=stepfunctions.QueryLanguage.JSON_PATH,
result_path="resultPath",
result_selector={
"result_selector_key": result_selector
},
retry_on_service_exceptions=False,
state_name="stateName",
task_timeout=timeout,
timeout=cdk.Duration.minutes(30)
)
// 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.lambda.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;
Object assign;
Function function_;
Object resultSelector;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;
LambdaInvokeJsonPathProps lambdaInvokeJsonPathProps = LambdaInvokeJsonPathProps.builder()
.lambdaFunction(function_)
// the properties below are optional
.assign(Map.of(
"assignKey", assign))
.clientContext("clientContext")
.comment("comment")
.credentials(Credentials.builder()
.role(taskRole)
.build())
.heartbeat(Duration.minutes(30))
.heartbeatTimeout(timeout)
.inputPath("inputPath")
.integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
.invocationType(LambdaInvocationType.REQUEST_RESPONSE)
.outputPath("outputPath")
.payload(taskInput)
.payloadResponseOnly(false)
.qualifier("qualifier")
.queryLanguage(QueryLanguage.JSON_PATH)
.resultPath("resultPath")
.resultSelector(Map.of(
"resultSelectorKey", resultSelector))
.retryOnServiceExceptions(false)
.stateName("stateName")
.taskTimeout(timeout)
.timeout(Duration.minutes(30))
.build();
// 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.Lambda;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
var assign;
Function function_;
var resultSelector;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;
var lambdaInvokeJsonPathProps = new LambdaInvokeJsonPathProps {
LambdaFunction = function_,
// the properties below are optional
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
ClientContext = "clientContext",
Comment = "comment",
Credentials = new Credentials {
Role = taskRole
},
Heartbeat = Duration.Minutes(30),
HeartbeatTimeout = timeout,
InputPath = "inputPath",
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
InvocationType = LambdaInvocationType.REQUEST_RESPONSE,
OutputPath = "outputPath",
Payload = taskInput,
PayloadResponseOnly = false,
Qualifier = "qualifier",
QueryLanguage = QueryLanguage.JSON_PATH,
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
RetryOnServiceExceptions = false,
StateName = "stateName",
TaskTimeout = timeout,
Timeout = Duration.Minutes(30)
};
// 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"
import "github.com/aws/aws-cdk-go/awscdk"
var assign interface{}
var function_ Function
var resultSelector interface{}
var taskInput TaskInput
var taskRole TaskRole
var timeout Timeout
lambdaInvokeJsonPathProps := &LambdaInvokeJsonPathProps{
LambdaFunction: function_,
// the properties below are optional
Assign: map[string]interface{}{
"assignKey": assign,
},
ClientContext: jsii.String("clientContext"),
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,
InvocationType: awscdk.Aws_stepfunctions_tasks.LambdaInvocationType_REQUEST_RESPONSE,
OutputPath: jsii.String("outputPath"),
Payload: taskInput,
PayloadResponseOnly: jsii.Boolean(false),
Qualifier: jsii.String("qualifier"),
QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
ResultPath: jsii.String("resultPath"),
ResultSelector: map[string]interface{}{
"resultSelectorKey": resultSelector,
},
RetryOnServiceExceptions: jsii.Boolean(false),
StateName: jsii.String("stateName"),
TaskTimeout: timeout,
Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
}
Properties
assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{} #Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
clientContextoptionalstringclient_contextoptionalstrclientContextoptionalStringClientContextoptionalstringClientContextoptional*string #Default: No context
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string #Default: No comment
credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials #Default: None (Task is executed using the State Machine's execution role)
This enables cross-account resource invocations.
heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration = None deprecated #heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout = None #[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern #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.
invocationTypeoptionalLambdaInvocationTypeinvocation_typeoptionalLambdaInvocationTypeinvocationTypeoptionalLambdaInvocationTypeInvocationTypeoptionalLambdaInvocationTypeInvocationTypeoptionalLambdaInvocationType = InvocationType.REQUEST_RESPONSE #lambdaFunctionIFunctionlambda_functionIFunctionlambdaFunctionIFunctionLambdaFunctionIFunctionLambdaFunctionIFunction required #outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
payloadoptionalTaskInputpayloadoptionalTaskInputpayloadoptionalTaskInputPayloadoptionalTaskInputPayloadoptionalTaskInput #Default: The state input (JSONata: '{%
payloadResponseOnlyoptionalbooleanpayload_response_onlyoptionalboolpayloadResponseOnlyoptionalBooleanPayloadResponseOnlyoptionalboolPayloadResponseOnlyoptional*bool = false #The payloadResponseOnly property cannot be used if integrationPattern, invocationType, clientContext, or qualifier are specified. It always uses the REQUEST_RESPONSE behavior.
qualifieroptionalstringqualifieroptionalstrqualifieroptionalStringQualifieroptionalstringQualifieroptional*string deprecated #Default: Version or alias inherent to the lambdaFunction object.
You only need to supply this if you want the version of the Lambda Function to depend on data in the state machine state. If not, you can pass the appropriate Alias or Version object directly as the lambdaFunction argument.
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage = JSONPath #If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*map[string]interface{} = None #You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
retryOnServiceExceptionsoptionalbooleanretry_on_service_exceptionsoptionalboolretryOnServiceExceptionsoptionalBooleanRetryOnServiceExceptionsoptionalboolRetryOnServiceExceptionsoptional*bool = true #This handles Lambda.ServiceException, Lambda.AWSLambdaException, Lambda.SdkClientException, and Lambda.ClientExecutionTimeoutException with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string #Default: The construct ID will be used as state name