Package software.amazon.awscdk.services.cloudfront

Interface CfnDistribution.LambdaFunctionAssociationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistribution.LambdaFunctionAssociationProperty.Jsii$Proxy

Enclosing class:

CfnDistribution

@Stability(Stable)
public static interface CfnDistribution.LambdaFunctionAssociationProperty
extends software.amazon.jsii.JsiiSerializable

A complex type that contains a Lambda@Edge function association.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 LambdaFunctionAssociationProperty lambdaFunctionAssociationProperty = LambdaFunctionAssociationProperty.builder()
         .eventType("eventType")
         .includeBody(false)
         .lambdaFunctionArn("lambdaFunctionArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDistribution.LambdaFunctionAssociationProperty.Builder	A builder for CfnDistribution.LambdaFunctionAssociationProperty
static final class	CfnDistribution.LambdaFunctionAssociationProperty.Jsii$Proxy	An implementation for CfnDistribution.LambdaFunctionAssociationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDistribution.LambdaFunctionAssociationProperty.Builder	builder()
default String	getEventType()	Specifies the event type that triggers a Lambda@Edge function invocation.
default Object	getIncludeBody()	A flag that allows a Lambda@Edge function to have read access to the body content.
default String	getLambdaFunctionArn()	The ARN of the Lambda@Edge function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventType

@Stability(Stable)
@Nullable
default String getEventType()

Specifies the event type that triggers a Lambda@Edge 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-eventtype

getIncludeBody

@Stability(Stable)
@Nullable
default Object getIncludeBody()

A flag that allows a Lambda@Edge 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-includebody

getLambdaFunctionArn

@Stability(Stable)
@Nullable
default String getLambdaFunctionArn()

The ARN of the Lambda@Edge function.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-lambdafunctionarn

builder

@Stability(Stable)
static CfnDistribution.LambdaFunctionAssociationProperty.Builder builder()

Returns:

a CfnDistribution.LambdaFunctionAssociationProperty.Builder of CfnDistribution.LambdaFunctionAssociationProperty