CfnEventInvokeConfigProps

class aws_cdk.aws_lambda.CfnEventInvokeConfigProps(*, function_name, qualifier, destination_config=None, maximum_event_age_in_seconds=None, maximum_retry_attempts=None)

Bases: object

Properties for defining a CfnEventInvokeConfig.

Parameters
  • function_name (str) – The name of the Lambda function. Minimum : 1 Maximum : 64 Pattern : ([a-zA-Z0-9-_]+)

  • qualifier (str) – The identifier of a version or alias. - Version - A version number. - Alias - An alias name. - Latest - To specify the unpublished version, use $LATEST .

  • destination_config (Union[IResolvable, DestinationConfigProperty, None]) – 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 an SQS queue. - Topic - The ARN of an SNS topic. - Event Bus - The ARN of an Amazon EventBridge event bus.

  • maximum_event_age_in_seconds (Union[int, float, None]) – The maximum age of a request that Lambda sends to a function for processing.

  • maximum_retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error.

Link

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

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_

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
)

Attributes

destination_config

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 an SQS queue.

  • Topic - The ARN of an SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

Link

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

Return type

Union[IResolvable, DestinationConfigProperty, None]

function_name

The name of the Lambda function.

Minimum : 1

Maximum : 64

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

Link

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

Return type

str

maximum_event_age_in_seconds

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

Link

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

Return type

Union[int, float, None]

maximum_retry_attempts

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

Link

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

Return type

Union[int, float, None]

qualifier

The identifier of a version or alias.

  • Version - A version number.

  • Alias - An alias name.

  • Latest - To specify the unpublished version, use $LATEST .

Link

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

Return type

str