class LambdaInvoke (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.LambdaInvoke |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.LambdaInvoke |
![]() | aws_cdk.aws_stepfunctions_tasks.LambdaInvoke |
![]() | @aws-cdk/aws-stepfunctions-tasks » LambdaInvoke |
Implements
IConstruct
, IConstruct
, IDependable
, IChainable
, INextable
Invoke a Lambda function as a Task.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-lambda.html
Example
import * as lambda from '@aws-cdk/aws-lambda';
declare const orderFn: lambda.Function;
const submitJob = new tasks.LambdaInvoke(this, 'InvokeOrderProcessor', {
lambdaFunction: orderFn,
payload: sfn.TaskInput.fromObject({
OrderId: sfn.JsonPath.stringAt('$.OrderId'),
}),
});
Initializer
new LambdaInvoke(scope: Construct, id: string, props: LambdaInvokeProps)
Parameters
- scope
Construct
- id
string
- props
Lambda
Invoke Props
Construct Props
Name | Type | Description |
---|---|---|
lambda | IFunction | Lambda function to invoke. |
client | string | Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function. |
comment? | string | An optional description for this state. |
heartbeat? | Duration | 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. |
invocation | Lambda | Invocation type of the Lambda function. |
output | string | JSONPath expression to select select a portion of the state output to pass to the next state. |
payload? | Task | The JSON that will be supplied as input to the Lambda function. |
payload | boolean | Invoke the Lambda in a way that only returns the payload response without additional metadata. |
qualifier? | string | Version or alias to invoke a published version of the function. |
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. |
retry | boolean | Whether to retry on Lambda service exceptions. |
timeout? | Duration | Timeout for the state machine. |
lambdaFunction
Type:
IFunction
Lambda function to invoke.
clientContext?
Type:
string
(optional, default: No context)
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.
comment?
Type:
string
(optional, default: No comment)
An optional description for this state.
heartbeat?
Type:
Duration
(optional, default: None)
Timeout for the heartbeat.
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
See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
invocationType?
Type:
Lambda
(optional, default: InvocationType.REQUEST_RESPONSE)
Invocation type of the Lambda function.
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 {}.
payload?
Type:
Task
(optional, default: The state input (JSON path '$'))
The JSON that will be supplied as input to the Lambda function.
payloadResponseOnly?
Type:
boolean
(optional, default: false)
Invoke the Lambda in a way that only returns the payload response without additional metadata.
The payloadResponseOnly
property cannot be used if integrationPattern
, invocationType
,
clientContext
, or qualifier
are specified.
It always uses the REQUEST_RESPONSE behavior.
qualifier?
⚠️ Deprecated: pass a Version or Alias object as lambdaFunction instead
Type:
string
(optional, default: Version or alias inherent to the lambdaFunction
object.)
Version or alias to invoke a published version of the function.
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.
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.
retryOnServiceExceptions?
Type:
boolean
(optional, default: true)
Whether to retry on Lambda service exceptions.
This handles Lambda.ServiceException
, Lambda.AWSLambdaException
and
Lambda.SdkClientException
with an interval of 2 seconds, a back-off rate
of 2 and 6 maximum attempts.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/bp-lambda-serviceexception.html
timeout?
Type:
Duration
(optional, default: None)
Timeout for the state machine.
Properties
Name | Type | Description |
---|---|---|
end | INextable [] | Continuable states of this Chainable. |
id | string | Descriptive identifier for this chainable. |
node | Construct | The construct tree node associated with this construct. |
start | State | First state of this Chainable. |
state | string | Tokenized string that evaluates to the state's ID. |
task | Task | |
task | Policy [] |
endStates
Type:
INextable
[]
Continuable states of this Chainable.
id
Type:
string
Descriptive identifier for this chainable.
node
Type:
Construct
The construct tree node associated with this construct.
startState
Type:
State
First state of this Chainable.
stateId
Type:
string
Tokenized string that evaluates to the state's ID.
taskMetrics?
Type:
Task
(optional)
taskPolicies?
Type:
Policy
[]
(optional)
Methods
Name | Description |
---|---|
add | Add a recovery handler for this state. |
add | Add a prefix to the stateId of this state. |
add | Add retry configuration for this state. |
bind | Register this state as part of the given graph. |
metric(metricName, props?) | Return the given named metric for this Task. |
metric | Metric for the number of times this activity fails. |
metric | Metric for the number of times the heartbeat times out for this activity. |
metric | The interval, in milliseconds, between the time the Task starts and the time it closes. |
metric | The interval, in milliseconds, for which the activity stays in the schedule state. |
metric | Metric for the number of times this activity is scheduled. |
metric | Metric for the number of times this activity is started. |
metric | Metric for the number of times this activity succeeds. |
metric | The interval, in milliseconds, between the time the activity is scheduled and the time it closes. |
metric | Metric for the number of times this activity times out. |
next(next) | Continue normal execution with the given state. |
to | Return the Amazon States Language object for this state. |
to | Returns a string representation of this construct. |
Catch(handler, props?)
addpublic addCatch(handler: IChainable, props?: CatchProps): TaskStateBase
Parameters
- handler
IChainable
- props
Catch
Props
Returns
Add a recovery handler for this state.
When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.
Prefix(x)
addpublic addPrefix(x: string): void
Parameters
- x
string
Add a prefix to the stateId of this state.
Retry(props?)
addpublic addRetry(props?: RetryProps): TaskStateBase
Parameters
- props
Retry
Props
Returns
Add retry configuration for this state.
This controls if and how the execution will be retried if a particular error occurs.
ToGraph(graph)
bindpublic bindToGraph(graph: StateGraph): void
Parameters
- graph
State
Graph
Register this state as part of the given graph.
Don't call this. It will be called automatically when you work with states normally.
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
Return the given named metric for this Task.
Failed(props?)
metricpublic metricFailed(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity fails.
HeartbeatTimedOut(props?)
metricpublic metricHeartbeatTimedOut(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times the heartbeat times out for this activity.
RunTime(props?)
metricpublic metricRunTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, between the time the Task starts and the time it closes.
ScheduleTime(props?)
metricpublic metricScheduleTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, for which the activity stays in the schedule state.
Scheduled(props?)
metricpublic metricScheduled(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity is scheduled.
Started(props?)
metricpublic metricStarted(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity is started.
Succeeded(props?)
metricpublic metricSucceeded(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity succeeds.
Time(props?)
metricpublic metricTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
TimedOut(props?)
metricpublic metricTimedOut(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity times out.
next(next)
public next(next: IChainable): Chain
Parameters
- next
IChainable
Returns
Continue normal execution with the given state.
StateJson()
topublic toStateJson(): json
Returns
json
Return the Amazon States Language object for this state.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.