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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass LambdaFunctionAssociation data as a 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 forwards 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.

Returns:

  • (String) 


4893
4894
4895
4896
4897
4898
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 4893

class LambdaFunctionAssociation < Struct.new(
  :lambda_function_arn,
  :event_type,
  :include_body)
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html

Returns:

  • (Boolean) 


4893
4894
4895
4896
4897
4898
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 4893

class LambdaFunctionAssociation < Struct.new(
  :lambda_function_arn,
  :event_type,
  :include_body)
  include Aws::Structure
end

#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) 


4893
4894
4895
4896
4897
4898
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 4893

class LambdaFunctionAssociation < Struct.new(
  :lambda_function_arn,
  :event_type,
  :include_body)
  include Aws::Structure
end