aws-cdk-lib.aws_lambda.CfnEventInvokeConfigProps

interface CfnEventInvokeConfigProps

LanguageType name
.NETAmazon.CDK.AWS.Lambda.CfnEventInvokeConfigProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnEventInvokeConfigProps
Javasoftware.amazon.awscdk.services.lambda.CfnEventInvokeConfigProps
Pythonaws_cdk.aws_lambda.CfnEventInvokeConfigProps
TypeScript aws-cdk-lib » aws_lambda » CfnEventInvokeConfigProps

Properties for defining a CfnEventInvokeConfig.

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 cfnEventInvokeConfigProps: lambda.CfnEventInvokeConfigProps = {
  functionName: 'functionName',
  qualifier: 'qualifier',

  // the properties below are optional
  destinationConfig: {
    onFailure: {
      destination: 'destination',
    },
    onSuccess: {
      destination: 'destination',
    },
  },
  maximumEventAgeInSeconds: 123,
  maximumRetryAttempts: 123,
};

Properties

NameTypeDescription
functionNamestringThe name of the Lambda function.
qualifierstringThe identifier of a version or alias.
destinationConfig?IResolvable | DestinationConfigPropertyA destination for events after they have been sent to a function for processing.
maximumEventAgeInSeconds?numberThe maximum age of a request that Lambda sends to a function for processing.
maximumRetryAttempts?numberThe maximum number of times to retry when the function returns an error.

functionName

Type: string

The name of the Lambda function.

Minimum : 1

Maximum : 64

Pattern : ([a-zA-Z0-9-_]+)


qualifier

Type: string

The identifier of a version or alias.

  • Version - A version number.
  • Alias - An alias name.
  • Latest - To specify the unpublished version, use $LATEST .

destinationConfig?

Type: IResolvable | DestinationConfigProperty (optional)

A destination for events after they have been sent to a function for processing.

Destinations - Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.
  • Topic - The ARN of a standard SNS topic.
  • Event Bus - The ARN of an Amazon EventBridge event bus.

maximumEventAgeInSeconds?

Type: number (optional)

The maximum age of a request that Lambda sends to a function for processing.


maximumRetryAttempts?

Type: number (optional)

The maximum number of times to retry when the function returns an error.