software.amazon.awscdk.services.lambda

Interface EventInvokeConfigOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AliasOptions, AliasProps, DockerImageFunctionProps, EdgeFunctionProps, EventInvokeConfigProps, FunctionOptions, FunctionProps, GoFunctionProps, NodejsFunctionProps, PythonFunctionProps, SingletonFunctionProps, TriggerFunctionProps, VersionOptions, VersionProps

All Known Implementing Classes:

AliasOptions.Jsii$Proxy, AliasProps.Jsii$Proxy, DockerImageFunctionProps.Jsii$Proxy, EdgeFunctionProps.Jsii$Proxy, EventInvokeConfigOptions.Jsii$Proxy, EventInvokeConfigProps.Jsii$Proxy, FunctionOptions.Jsii$Proxy, FunctionProps.Jsii$Proxy, GoFunctionProps.Jsii$Proxy, NodejsFunctionProps.Jsii$Proxy, PythonFunctionProps.Jsii$Proxy, SingletonFunctionProps.Jsii$Proxy, TriggerFunctionProps.Jsii$Proxy, VersionOptions.Jsii$Proxy, VersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:52.101Z")
 @Stability(value=Experimental)
public interface EventInvokeConfigOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options to add an EventInvokeConfig to a function.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.services.lambda.*;
 IDestination destination;
 Duration duration;
 EventInvokeConfigOptions eventInvokeConfigOptions = EventInvokeConfigOptions.builder()
         .maxEventAge(duration)
         .onFailure(destination)
         .onSuccess(destination)
         .retryAttempts(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EventInvokeConfigOptions.Builder	builder()
default Duration	getMaxEventAge() (experimental) The maximum age of a request that Lambda sends to a function for processing.
default IDestination	getOnFailure() (experimental) The destination for failed invocations.
default IDestination	getOnSuccess() (experimental) The destination for successful invocations.
default Number	getRetryAttempts() (experimental) The maximum number of times to retry when the function returns an error.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMaxEventAge

@Stability(value=Experimental)
 @Nullable
default Duration getMaxEventAge()

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

Minimum: 60 seconds Maximum: 6 hours

Default: Duration.hours(6)

getOnFailure

@Stability(value=Experimental)
 @Nullable
default IDestination getOnFailure()

(experimental) The destination for failed invocations.

Default: - no destination

getOnSuccess

@Stability(value=Experimental)
 @Nullable
default IDestination getOnSuccess()

(experimental) The destination for successful invocations.

Default: - no destination

getRetryAttempts

@Stability(value=Experimental)
 @Nullable
default Number getRetryAttempts()

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

Minimum: 0 Maximum: 2

Default: 2

builder

@Stability(value=Experimental)
static EventInvokeConfigOptions.Builder builder()

Returns:

a EventInvokeConfigOptions.Builder of EventInvokeConfigOptions