You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lambda::Types::PutFunctionEventInvokeConfigRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutFunctionEventInvokeConfigRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  function_name: "FunctionName", # required
  qualifier: "Qualifier",
  maximum_retry_attempts: 1,
  maximum_event_age_in_seconds: 1,
  destination_config: {
    on_success: {
      destination: "DestinationArn",
    },
    on_failure: {
      destination: "DestinationArn",
    },
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#destination_configTypes::DestinationConfig

A destination for events after they have been sent to a function for processing.

Destinations .title

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

Returns:

#function_nameString

The name of the Lambda function, version, or alias.

Name formats .title

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

  • (String)

    The name of the Lambda function, version, or alias.

#maximum_event_age_in_secondsInteger

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

Returns:

  • (Integer)

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

#maximum_retry_attemptsInteger

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

Returns:

  • (Integer)

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

#qualifierString

A version number or alias name.

Returns:

  • (String)

    A version number or alias name.