@Stability(value=Stable) public static final class LambdaInvokeProps.Builder extends Object implements software.amazon.jsii.Builder<LambdaInvokeProps>
LambdaInvokeProps
Constructor and Description |
---|
Builder() |
@Stability(value=Stable) public LambdaInvokeProps.Builder lambdaFunction(IFunction lambdaFunction)
LambdaInvokeProps.getLambdaFunction()
lambdaFunction
- Lambda function to invoke. This parameter is required.this
@Stability(value=Stable) public LambdaInvokeProps.Builder clientContext(String clientContext)
LambdaInvokeProps.getClientContext()
clientContext
- Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.this
@Stability(value=Stable) public LambdaInvokeProps.Builder invocationType(LambdaInvocationType invocationType)
LambdaInvokeProps.getInvocationType()
invocationType
- Invocation type of the Lambda function.this
@Stability(value=Stable) public LambdaInvokeProps.Builder payload(TaskInput payload)
LambdaInvokeProps.getPayload()
payload
- The JSON that will be supplied as input to the Lambda function.this
@Stability(value=Stable) public LambdaInvokeProps.Builder payloadResponseOnly(Boolean payloadResponseOnly)
LambdaInvokeProps.getPayloadResponseOnly()
payloadResponseOnly
- 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.this
@Stability(value=Deprecated) @Deprecated public LambdaInvokeProps.Builder qualifier(String qualifier)
LambdaInvokeProps.getQualifier()
qualifier
- 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.this
@Stability(value=Stable) public LambdaInvokeProps.Builder retryOnServiceExceptions(Boolean retryOnServiceExceptions)
LambdaInvokeProps.getRetryOnServiceExceptions()
retryOnServiceExceptions
- 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.this
@Stability(value=Stable) public LambdaInvokeProps.Builder comment(String comment)
TaskStateBaseProps.getComment()
comment
- An optional description for this state.this
@Stability(value=Stable) public LambdaInvokeProps.Builder heartbeat(Duration heartbeat)
TaskStateBaseProps.getHeartbeat()
heartbeat
- Timeout for the heartbeat.this
@Stability(value=Stable) public LambdaInvokeProps.Builder inputPath(String inputPath)
TaskStateBaseProps.getInputPath()
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 {}.this
@Stability(value=Stable) public LambdaInvokeProps.Builder integrationPattern(IntegrationPattern integrationPattern)
TaskStateBaseProps.getIntegrationPattern()
integrationPattern
- AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patternsthis
@Stability(value=Stable) public LambdaInvokeProps.Builder outputPath(String outputPath)
TaskStateBaseProps.getOutputPath()
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 {}.this
@Stability(value=Stable) public LambdaInvokeProps.Builder resultPath(String resultPath)
TaskStateBaseProps.getResultPath()
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.this
@Stability(value=Stable) public LambdaInvokeProps.Builder resultSelector(Map<String,? extends Object> resultSelector)
TaskStateBaseProps.getResultSelector()
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.this
@Stability(value=Stable) public LambdaInvokeProps.Builder timeout(Duration timeout)
TaskStateBaseProps.getTimeout()
timeout
- Timeout for the state machine.this
@Stability(value=Stable) public LambdaInvokeProps build()
build
in interface software.amazon.jsii.Builder<LambdaInvokeProps>
LambdaInvokeProps
NullPointerException
- if any required attribute was not providedCopyright © 2022. All rights reserved.