Class LambdaInvoke.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<LambdaInvoke>
- Enclosing class:
LambdaInvoke
LambdaInvoke
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
clientContext
(String clientContext) Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.An optional description for this state.static LambdaInvoke.Builder
credentials
(Credentials credentials) Credentials for an IAM Role that the State Machine assumes for executing the task.Deprecated.heartbeatTimeout
(Timeout heartbeatTimeout) Timeout for the heartbeat.JSONPath expression to select part of the state to be the input to this state.integrationPattern
(IntegrationPattern integrationPattern) AWS Step Functions integrates with services directly in the Amazon States Language.invocationType
(LambdaInvocationType invocationType) Invocation type of the Lambda function.lambdaFunction
(IFunction lambdaFunction) Lambda function to invoke.outputPath
(String outputPath) JSONPath expression to select select a portion of the state output to pass to the next state.The JSON that will be supplied as input to the Lambda function.payloadResponseOnly
(Boolean payloadResponseOnly) Invoke the Lambda in a way that only returns the payload response without additional metadata.Deprecated.pass a Version or Alias object as lambdaFunction insteadresultPath
(String resultPath) JSONPath expression to indicate where to inject the state's output.resultSelector
(Map<String, ? extends Object> resultSelector) The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.retryOnServiceExceptions
(Boolean retryOnServiceExceptions) Whether to retry on Lambda service exceptions.Optional name for this state.taskTimeout
(Timeout taskTimeout) Timeout for the task.Deprecated.usetaskTimeout
-
Method Details
-
create
@Stability(Stable) public static LambdaInvoke.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- Descriptive identifier for this chainable. This parameter is required.- Returns:
- a new instance of
LambdaInvoke.Builder
.
-
comment
An optional description for this state.Default: - No comment
- Parameters:
comment
- An optional description for this state. This parameter is required.- Returns:
this
-
credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.This enables cross-account resource invocations.
Default: - None (Task is executed using the State Machine's execution role)
- Parameters:
credentials
- Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.- Returns:
this
- See Also:
-
heartbeat
Deprecated.useheartbeatTimeout
(deprecated) Timeout for the heartbeat.Default: - None
- Parameters:
heartbeat
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
heartbeatTimeout
Timeout for the heartbeat.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Parameters:
heartbeatTimeout
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
inputPath
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 {}.
Default: - The entire task input (JSON path '$')
- Parameters:
inputPath
- JSONPath expression to select part of the state to be the input to this state. This parameter is required.- Returns:
this
-
integrationPattern
@Stability(Stable) public LambdaInvoke.Builder integrationPattern(IntegrationPattern integrationPattern) AWS Step Functions integrates with services directly in the Amazon States Language.You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
- Parameters:
integrationPattern
- AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.- Returns:
this
- See Also:
-
outputPath
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 {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
- Parameters:
outputPath
- JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.- Returns:
this
-
resultPath
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.
Default: - Replaces the entire input with the result (JSON path '$')
- Parameters:
resultPath
- JSONPath expression to indicate where to inject the state's output. This parameter is required.- Returns:
this
-
resultSelector
@Stability(Stable) public LambdaInvoke.Builder resultSelector(Map<String, ? extends Object> resultSelector) 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.
Default: - None
- Parameters:
resultSelector
- The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.- Returns:
this
- See Also:
-
stateName
Optional name for this state.Default: - The construct ID will be used as state name
- Parameters:
stateName
- Optional name for this state. This parameter is required.- Returns:
this
-
taskTimeout
Timeout for the task.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Parameters:
taskTimeout
- Timeout for the task. This parameter is required.- Returns:
this
-
timeout
Deprecated.usetaskTimeout
(deprecated) Timeout for the task.Default: - None
- Parameters:
timeout
- Timeout for the task. This parameter is required.- Returns:
this
-
lambdaFunction
Lambda function to invoke.- Parameters:
lambdaFunction
- Lambda function to invoke. This parameter is required.- Returns:
this
-
clientContext
Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.Default: - No context
- Parameters:
clientContext
- Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function. This parameter is required.- Returns:
this
-
invocationType
Invocation type of the Lambda function.Default: InvocationType.REQUEST_RESPONSE
- Parameters:
invocationType
- Invocation type of the Lambda function. This parameter is required.- Returns:
this
-
payload
The JSON that will be supplied as input to the Lambda function.Default: - The state input (JSON path '$')
- Parameters:
payload
- The JSON that will be supplied as input to the Lambda function. This parameter is required.- Returns:
this
-
payloadResponseOnly
Invoke the Lambda in a way that only returns the payload response without additional metadata.The
payloadResponseOnly
property cannot be used ifintegrationPattern
,invocationType
,clientContext
, orqualifier
are specified. It always uses the REQUEST_RESPONSE behavior.Default: false
- Parameters:
payloadResponseOnly
- Invoke the Lambda in a way that only returns the payload response without additional metadata. This parameter is required.- Returns:
this
-
qualifier
Deprecated.pass a Version or Alias object as lambdaFunction instead(deprecated) 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.Default: - Version or alias inherent to the `lambdaFunction` object.
- Parameters:
qualifier
- Version or alias to invoke a published version of the function. This parameter is required.- Returns:
this
-
retryOnServiceExceptions
@Stability(Stable) public LambdaInvoke.Builder retryOnServiceExceptions(Boolean retryOnServiceExceptions) Whether to retry on Lambda service exceptions.This handles
Lambda.ServiceException
,Lambda.AWSLambdaException
,Lambda.SdkClientException
, andLambda.ClientExecutionTimeoutException
with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.Default: true
- Parameters:
retryOnServiceExceptions
- Whether to retry on Lambda service exceptions. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<LambdaInvoke>
- Returns:
- a newly built instance of
LambdaInvoke
.
-
heartbeatTimeout