Package software.amazon.awscdk.services.lambda.destinations

Interface LambdaDestinationOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LambdaDestinationOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-06T01:36:31.214Z")
@Stability(Stable)
public interface LambdaDestinationOptions
extends software.amazon.jsii.JsiiSerializable

Options for a Lambda destination.

Example:

 // Auto-extract response payload with a lambda destination
 Function destinationFn;
 Function sourceFn = Function.Builder.create(this, "Source")
         .runtime(Runtime.NODEJS_LATEST)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "lambda-handler")))
         // auto-extract on success
         .onSuccess(LambdaDestination.Builder.create(destinationFn)
                 .responseOnly(true)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LambdaDestinationOptions.Builder	A builder for LambdaDestinationOptions
static final class	LambdaDestinationOptions.Jsii$Proxy	An implementation for LambdaDestinationOptions

Method Summary

Modifier and Type	Method	Description
static LambdaDestinationOptions.Builder	builder()
default Boolean	getResponseOnly()	Whether the destination function receives only the responsePayload of the source function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResponseOnly

@Stability(Stable)
@Nullable
default Boolean getResponseOnly()

Whether the destination function receives only the responsePayload of the source function.

When set to true and used as onSuccess destination, the destination function will be invoked with the payload returned by the source function.

When set to true and used as onFailure destination, the destination function will be invoked with the error object returned by source function.

See the README of this module to see a full explanation of this option.

Default: false The destination function receives the full invocation record.

builder

@Stability(Stable)
static LambdaDestinationOptions.Builder builder()

Returns:

a LambdaDestinationOptions.Builder of LambdaDestinationOptions