aws-cdk-lib.aws_lambda.CfnEventInvokeConfigProps

CfnEventInvokeConfigProps Struct

Properties for defining a CfnEventInvokeConfig.

CfnEventInvokeConfigProps

used as props by

• CfnEventInvokeConfig

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

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,
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lambda as lambda_

cfn_event_invoke_config_props = lambda.CfnEventInvokeConfigProps(
    function_name="functionName",
    qualifier="qualifier",

    # the properties below are optional
    destination_config=lambda.CfnEventInvokeConfig.DestinationConfigProperty(
        on_failure=lambda.CfnEventInvokeConfig.OnFailureProperty(
            destination="destination"
        ),
        on_success=lambda.CfnEventInvokeConfig.OnSuccessProperty(
            destination="destination"
        )
    ),
    maximum_event_age_in_seconds=123,
    maximum_retry_attempts=123
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lambda.*;

CfnEventInvokeConfigProps cfnEventInvokeConfigProps = CfnEventInvokeConfigProps.builder()
        .functionName("functionName")
        .qualifier("qualifier")

        // the properties below are optional
        .destinationConfig(DestinationConfigProperty.builder()
                .onFailure(OnFailureProperty.builder()
                        .destination("destination")
                        .build())
                .onSuccess(OnSuccessProperty.builder()
                        .destination("destination")
                        .build())
                .build())
        .maximumEventAgeInSeconds(123)
        .maximumRetryAttempts(123)
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;

var cfnEventInvokeConfigProps = new CfnEventInvokeConfigProps {
    FunctionName = "functionName",
    Qualifier = "qualifier",

    // the properties below are optional
    DestinationConfig = new DestinationConfigProperty {
        OnFailure = new OnFailureProperty {
            Destination = "destination"
        },
        OnSuccess = new OnSuccessProperty {
            Destination = "destination"
        }
    },
    MaximumEventAgeInSeconds = 123,
    MaximumRetryAttempts = 123
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnEventInvokeConfigProps := &CfnEventInvokeConfigProps{
	FunctionName: jsii.String("functionName"),
	Qualifier: jsii.String("qualifier"),

	// the properties below are optional
	DestinationConfig: &DestinationConfigProperty{
		OnFailure: &OnFailureProperty{
			Destination: jsii.String("destination"),
		},
		OnSuccess: &OnSuccessProperty{
			Destination: jsii.String("destination"),
		},
	},
	MaximumEventAgeInSeconds: jsii.Number(123),
	MaximumRetryAttempts: jsii.Number(123),
}

Properties

destinationConfig?optionalIResolvable | CfnEventInvokeConfig.DestinationConfigPropertydestination_config?optionaltyping.Union[IResolvable, DestinationConfigProperty]destinationConfig?optionalIResolvableDestinationConfig?optionalIResolvableDestinationConfig?optionalinterface{}#

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-_]+)

maximumEventAgeInSeconds?optionalnumbermaximum_event_age_in_seconds?optionalint | floatmaximumEventAgeInSeconds?optionalNumberMaximumEventAgeInSeconds?optionaldoubleMaximumEventAgeInSeconds?optional*float64#

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

maximumRetryAttempts?optionalnumbermaximum_retry_attempts?optionalint | floatmaximumRetryAttempts?optionalNumberMaximumRetryAttempts?optionaldoubleMaximumRetryAttempts?optional*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 .