Package software.amazon.awscdk.services.lambda

Interface CfnEventInvokeConfigProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventInvokeConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:41.146Z")
@Stability(Stable)
public interface CfnEventInvokeConfigProps
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEventInvokeConfigProps.Builder	A builder for CfnEventInvokeConfigProps
static final class	CfnEventInvokeConfigProps.Jsii$Proxy	An implementation for CfnEventInvokeConfigProps

Method Summary

Modifier and Type	Method	Description
static CfnEventInvokeConfigProps.Builder	builder()
default Object	getDestinationConfig()	A destination for events after they have been sent to a function for processing.
String	getFunctionName()	The name of the Lambda function.
default Number	getMaximumEventAgeInSeconds()	The maximum age of a request that Lambda sends to a function for processing.
default Number	getMaximumRetryAttempts()	The maximum number of times to retry when the function returns an error.
String	getQualifier()	The identifier of a version or alias.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFunctionName

@Stability(Stable)
@NotNull
String getFunctionName()

The name of the Lambda function.

Minimum : 1

Maximum : 64

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-functionname

getQualifier

@Stability(Stable)
@NotNull
String getQualifier()

The identifier of a version or alias.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-qualifier

getDestinationConfig

@Stability(Stable)
@Nullable
default Object getDestinationConfig()

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.
• 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.

Returns union: either IResolvable or CfnEventInvokeConfig.DestinationConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig

getMaximumEventAgeInSeconds

@Stability(Stable)
@Nullable
default Number getMaximumEventAgeInSeconds()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds

getMaximumRetryAttempts

@Stability(Stable)
@Nullable
default Number getMaximumRetryAttempts()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts

builder

@Stability(Stable)
static CfnEventInvokeConfigProps.Builder builder()

Returns:

a CfnEventInvokeConfigProps.Builder of CfnEventInvokeConfigProps