EventInvokeConfig

class aws_cdk.aws_lambda.EventInvokeConfig(scope, id, *, function, qualifier=None, max_event_age=None, on_failure=None, on_success=None, retry_attempts=None)

Bases: aws_cdk.core.Resource

Configure options for asynchronous invocation on a version or an alias.

By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it.

__init__(scope, id, *, function, qualifier=None, max_event_age=None, on_failure=None, on_success=None, retry_attempts=None)
Parameters

  • scope (Construct) –

  • id (str) –

  • function (IFunction) – The Lambda function.

  • qualifier (Optional[str]) – The qualifier. Default: - latest version

  • 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

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool