LambdaDestinationOptions

class aws_cdk.aws_lambda_destinations.LambdaDestinationOptions(*, response_only=None)

Bases: object

Options for a Lambda destination.

Parameters

response_only (Optional[bool]) – 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.

Example:

# Auto-extract response payload with a lambda destination
# destination_fn is of type Function


source_fn = lambda_.Function(self, "Source",
    runtime=lambda_.Runtime.NODEJS_12_X,
    handler="index.handler",
    code=lambda_.Code.from_asset(path.join(__dirname, "lambda-handler")),
    # auto-extract on success
    on_success=destinations.LambdaDestination(destination_fn,
        response_only=True
    )
)

Attributes

response_only

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.

Return type

Optional[bool]