aws-cdk-lib.aws_lambda_destinations.LambdaDestinationOptions

LambdaDestinationOptions Struct

Options for a Lambda destination.

LambdaDestinationOptions

used as props by

• LambdaDestination

Source

aws-lambda-destinations/lib/lambda.ts

Example

// Auto-extract response payload with a lambda destination
declare const destinationFn: lambda.Function;

const sourceFn = new lambda.Function(this, 'Source', {
  runtime: lambda.Runtime.NODEJS_LATEST,
  handler: 'index.handler',
  code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
  // auto-extract on success
  onSuccess: new destinations.LambdaDestination(destinationFn, {
    responseOnly: true,
  }),
})

Properties

responseOnly?optionalbooleanresponse_only?optionalboolresponseOnly?optionalBooleanResponseOnly?optionalboolResponseOnly?optional*bool#

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

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

notes

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.