Skip to content
v2.275.0

CfnEventInvokeConfigProps Struct ​

Properties for defining a CfnEventInvokeConfig.

Example ​

ts
// 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 ​

destinationConfigoptionalIResolvable | CfnEventInvokeConfig.DestinationConfigPropertydestination_configoptionaltyping.Union[IResolvable, DestinationConfigProperty]destinationConfigoptionalIResolvableDestinationConfigoptionalIResolvableDestinationConfigoptionalinterface{}#
A destination for events after they have been sent to a function for processing.
notes

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

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

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

functionNamestring | IFunctionReffunction_nametyping.Union[str, IFunctionRef]functionNameStringFunctionNamestringFunctionNameinterface{}required#
The name of the Lambda function.

Minimum : 1

Maximum : 64

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

maximumEventAgeInSecondsoptionalnumbermaximum_event_age_in_secondsoptionalint | floatmaximumEventAgeInSecondsoptionalNumberMaximumEventAgeInSecondsoptionaldoubleMaximumEventAgeInSecondsoptional*float64#
The maximum age of a request that Lambda sends to a function for processing.
maximumRetryAttemptsoptionalnumbermaximum_retry_attemptsoptionalint | floatmaximumRetryAttemptsoptionalNumberMaximumRetryAttemptsoptionaldoubleMaximumRetryAttemptsoptional*float64#
The maximum number of times to retry when the function returns an error.
qualifierstringqualifierstrqualifierStringQualifierstringQualifier*stringrequired#
The identifier of a version or alias.
  • Version - A version number.
  • Alias - An alias name.
  • Latest - To specify the unpublished version, use $LATEST .