AWS::Lambda::EventInvokeConfig OnSuccess - Amazon CloudFormation
SyntaxPropertiesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Lambda::EventInvokeConfig OnSuccess

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.

Note

OnSuccess is not supported in CreateEventSourceMapping or UpdateEventSourceMapping requests.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Destination" : String
}

YAML

  Destination: String

Properties

Destination

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

Note

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.

Required: Yes

Type: String

Pattern: ^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]+(-[a-z]+)+-\d{1})?:(\d{12})?:(.*)

Minimum: 0

Maximum: 350

Update requires: No interruption

Examples

On-Success Destination Configuration

Configure a function to send a record of successful asynchronous invocations to an SQS queue.

YAML

          OnSuccess:
            Destination: arn:aws-cn:sqs:us-east-2:123456789012:destination