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

Class LambdaInvoke

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.LambdaInvoke

All Implemented Interfaces:

IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:16.957Z")
@Stability(Stable)
public class LambdaInvoke
extends TaskStateBase

Invoke a Lambda function as a Task.

Example:

 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();
 

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-lambda.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LambdaInvoke.Builder	A fluent builder for LambdaInvoke.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LambdaInvoke(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LambdaInvoke(software.amazon.jsii.JsiiObjectRef objRef)
	LambdaInvoke(software.constructs.Construct scope, String id, LambdaInvokeProps props)

Method Summary

Modifier and Type	Method	Description
protected TaskMetricsConfig	getTaskMetrics()
protected List<PolicyStatement>	getTaskPolicies()

Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase

addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, whenBoundToGraph

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addChoice, addItemProcessor, addItemProcessor, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getParameters, getProcessor, getProcessorConfig, getProcessorMode, getResultPath, getResultSelector, getStartState, getStateId, getStateName, makeDefault, makeNext, prefixStates, renderBranches, renderChoices, renderInputOutput, renderItemProcessor, renderIterator, renderNextEnd, renderResultSelector, renderRetryCatch, setDefaultChoice, setIteration, setProcessor, setProcessorConfig, setProcessorMode, validateState

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

LambdaInvoke

protected LambdaInvoke(software.amazon.jsii.JsiiObjectRef objRef)

LambdaInvoke

protected LambdaInvoke(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

LambdaInvoke

@Stability(Stable)
public LambdaInvoke(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 LambdaInvokeProps props)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

props - This parameter is required.

Method Details

getTaskMetrics

@Stability(Stable)
@Nullable
protected TaskMetricsConfig getTaskMetrics()

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

@Stability(Stable)
@Nullable
protected List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase