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 [email protected] function association.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#event_typeString

Specifies the event type that triggers a [email protected] 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.

Returns:

  • (String)

8348
8349
8350
8351
8352
8353
8354
# File 'lib/aws-sdk-cloudfront/types.rb', line 8348

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

#include_bodyBoolean

A flag that allows a [email protected] 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)

8348
8349
8350
8351
8352
8353
8354
# File 'lib/aws-sdk-cloudfront/types.rb', line 8348

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

#lambda_function_arnString

The ARN of the [email protected] function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.

Returns:

  • (String)

8348
8349
8350
8351
8352
8353
8354
# File 'lib/aws-sdk-cloudfront/types.rb', line 8348

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