interface OnSuccessProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Lambda.CfnEventInvokeConfig.OnSuccessProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnEventInvokeConfig_OnSuccessProperty`
Java	`software.amazon.awscdk.services.lambda.CfnEventInvokeConfig.OnSuccessProperty`
Python	`aws_cdk.aws_lambda.CfnEventInvokeConfig.OnSuccessProperty`
TypeScript	`aws-cdk-lib` » `aws_lambda` » `CfnEventInvokeConfig` » `OnSuccessProperty`

A destination for events that were processed successfully.

To retain records of successful asynchronous invocations , you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.

OnSuccess is not supported in CreateEventSourceMapping or UpdateEventSourceMapping requests.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const onSuccessProperty: lambda.CfnEventInvokeConfig.OnSuccessProperty = {
  destination: 'destination',
};

Properties

Name	Type	Description
destination	`string`	The Amazon Resource Name (ARN) of the destination resource.

destination

Type: string

The Amazon Resource Name (ARN) of the destination resource.

Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations .