EventInvokeConfigOptions

class aws_cdk.aws_lambda.EventInvokeConfigOptions(*, max_event_age=None, on_failure=None, on_success=None, retry_attempts=None)

Bases: object

Options to add an EventInvokeConfig to a function.

Parameters:

  • max_event_age (Optional[Duration]) – The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours Default: Duration.hours(6)

  • on_failure (Optional[IDestination]) – The destination for failed invocations. Default: - no destination

  • on_success (Optional[IDestination]) – The destination for successful invocations. Default: - no destination

  • retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2 Default: 2

ExampleMetadata:

fixture=_generated

Example:

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

# destination: lambda.IDestination

event_invoke_config_options = lambda.EventInvokeConfigOptions(
    max_event_age=cdk.Duration.minutes(30),
    on_failure=destination,
    on_success=destination,
    retry_attempts=123
)

Attributes

max_event_age

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

Minimum: 60 seconds Maximum: 6 hours

Default:

Duration.hours(6)

on_failure

The destination for failed invocations.

Default:

  • no destination

on_success

The destination for successful invocations.

Default:

  • no destination

retry_attempts

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

Minimum: 0 Maximum: 2

Default:

2