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

Class: Aws::CloudFront::Types::LambdaFunctionAssociation

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

Overview

Note:

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

{
  lambda_function_arn: "LambdaFunctionARN", # required
  event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
  include_body: false,
}

A complex type that contains a Lambda function association.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#event_type ⇒ String

Specifies the event type that triggers a Lambda function invocation. You can specify the following values:

  • viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.

  • origin-request: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn\'t execute.

  • origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn\'t execute.

  • viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn\'t execute.

    Possible values:

    • viewer-request
    • viewer-response
    • origin-request
    • origin-response

Returns:

  • (String) —

    Specifies the event type that triggers a Lambda function invocation.

#include_body ⇒ Boolean

A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.

Returns:

  • (Boolean) —

    A flag that allows a Lambda function to have read access to the body content.

#lambda_function_arn ⇒ String

The ARN of the Lambda function. You must specify the ARN of a function version; you can\'t specify a Lambda alias or $LATEST.

Returns:

  • (String) —

    The ARN of the Lambda function.