LambdaInvoke.Builder (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

java.lang.Object
- software.amazon.awscdk.services.stepfunctions.tasks.LambdaInvoke.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<LambdaInvoke>

Enclosing class:: LambdaInvoke

@Stability(value=Experimental)
public static final class LambdaInvoke.Builder
extends Object
implements software.amazon.jsii.Builder<LambdaInvoke>

(experimental) A fluent builder for LambdaInvoke.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LambdaInvoke`	`build()`
`LambdaInvoke.Builder`	`clientContext(String clientContext)` (experimental) Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.
`LambdaInvoke.Builder`	`comment(String comment)` (experimental) An optional description for this state.
`static LambdaInvoke.Builder`	`create(software.constructs.Construct scope, String id)`
`LambdaInvoke.Builder`	`heartbeat(Duration heartbeat)` (experimental) Timeout for the heartbeat.
`LambdaInvoke.Builder`	`inputPath(String inputPath)` (experimental) JSONPath expression to select part of the state to be the input to this state.
`LambdaInvoke.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` (experimental) AWS Step Functions integrates with services directly in the Amazon States Language.
`LambdaInvoke.Builder`	`invocationType(LambdaInvocationType invocationType)` (experimental) Invocation type of the Lambda function.
`LambdaInvoke.Builder`	`lambdaFunction(IFunction lambdaFunction)` (experimental) Lambda function to invoke.
`LambdaInvoke.Builder`	`outputPath(String outputPath)` (experimental) JSONPath expression to select select a portion of the state output to pass to the next state.
`LambdaInvoke.Builder`	`payload(TaskInput payload)` (experimental) The JSON that will be supplied as input to the Lambda function.
`LambdaInvoke.Builder`	`payloadResponseOnly(Boolean payloadResponseOnly)` (experimental) Invoke the Lambda in a way that only returns the payload response without additional metadata.
`LambdaInvoke.Builder`	`qualifier(String qualifier)` (experimental) Version or alias to invoke a published version of the function.
`LambdaInvoke.Builder`	`resultPath(String resultPath)` (experimental) JSONPath expression to indicate where to inject the state's output.
`LambdaInvoke.Builder`	`resultSelector(Map<String,? extends Object> resultSelector)` (experimental) The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
`LambdaInvoke.Builder`	`retryOnServiceExceptions(Boolean retryOnServiceExceptions)` (experimental) Whether to retry on Lambda service exceptions.
`LambdaInvoke.Builder`	`timeout(Duration timeout)` (experimental) Timeout for the state machine.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(value=Experimental)
public static LambdaInvoke.Builder create(software.constructs.Construct scope,
                                                                         String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of LambdaInvoke.Builder.
  - comment
```
@Stability(value=Experimental)
public LambdaInvoke.Builder comment(String comment)
```
    (experimental) An optional description for this state.
    Default: - No comment
    
    Parameters:
    
    comment - An optional description for this state. This parameter is required.
    
    Returns:
    
    this
  - heartbeat
```
@Stability(value=Experimental)
public LambdaInvoke.Builder heartbeat(Duration heartbeat)
```
    (experimental) Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
@Stability(value=Experimental)
public LambdaInvoke.Builder inputPath(String inputPath)
```
    (experimental) 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(value=Experimental)
public LambdaInvoke.Builder integrationPattern(IntegrationPattern integrationPattern)
```
    (experimental) AWS Step Functions integrates with services directly in the Amazon States Language.
    You can control these AWS services using service integration patterns
    Default: IntegrationPattern.REQUEST_RESPONSE
    
    Parameters:
    
    integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
  - outputPath
```
@Stability(value=Experimental)
public LambdaInvoke.Builder outputPath(String outputPath)
```
    (experimental) 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
```
@Stability(value=Experimental)
public LambdaInvoke.Builder resultPath(String resultPath)
```
    (experimental) 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(value=Experimental)
public LambdaInvoke.Builder resultSelector(Map<String,? extends Object> resultSelector)
```
    (experimental) 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:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
  - timeout
```
@Stability(value=Experimental)
public LambdaInvoke.Builder timeout(Duration timeout)
```
    (experimental) Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - lambdaFunction
```
@Stability(value=Experimental)
public LambdaInvoke.Builder lambdaFunction(IFunction lambdaFunction)
```
    (experimental) Lambda function to invoke.
    
    Parameters:
    
    lambdaFunction - Lambda function to invoke. This parameter is required.
    
    Returns:
    
    this
  - clientContext
```
@Stability(value=Experimental)
public LambdaInvoke.Builder clientContext(String clientContext)
```
    (experimental) 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
```
@Stability(value=Experimental)
public LambdaInvoke.Builder invocationType(LambdaInvocationType invocationType)
```
    (experimental) 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
```
@Stability(value=Experimental)
public LambdaInvoke.Builder payload(TaskInput payload)
```
    (experimental) 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
```
@Stability(value=Experimental)
public LambdaInvoke.Builder payloadResponseOnly(Boolean payloadResponseOnly)
```
    (experimental) 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.
    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
```
@Stability(value=Experimental)
public LambdaInvoke.Builder qualifier(String qualifier)
```
    (experimental) 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(value=Experimental)
public LambdaInvoke.Builder retryOnServiceExceptions(Boolean retryOnServiceExceptions)
```
    (experimental) 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.
    Default: true
    
    Parameters:
    
    retryOnServiceExceptions - Whether to retry on Lambda service exceptions. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/bp-lambda-serviceexception.html
  - build
```
@Stability(value=Experimental)
public LambdaInvoke build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<LambdaInvoke>

Class LambdaInvoke.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

lambdaFunction

clientContext

invocationType

payload

payloadResponseOnly

qualifier

retryOnServiceExceptions

build