Package software.amazon.awscdk.services.cloudfront

Enum FunctionEventType

java.lang.Object

java.lang.Enum<FunctionEventType>

software.amazon.awscdk.services.cloudfront.FunctionEventType

All Implemented Interfaces:

Serializable, Comparable<FunctionEventType>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.688Z")
@Stability(Stable)
public enum FunctionEventType
extends Enum<FunctionEventType>

The type of events that a CloudFront function can be invoked in response to.

Example:

 Bucket s3Bucket;
 // Add a cloudfront Function to a Distribution
 Function cfFunction = Function.Builder.create(this, "Function")
         .code(FunctionCode.fromInline("function handler(event) { return event.request }"))
         .build();
 Distribution.Builder.create(this, "distro")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(new S3Origin(s3Bucket))
                 .functionAssociations(List.of(FunctionAssociation.builder()
                         .function(cfFunction)
                         .eventType(FunctionEventType.VIEWER_REQUEST)
                         .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
VIEWER_REQUEST	The viewer-request specifies the incoming request.
VIEWER_RESPONSE	The viewer-response specifies the outgoing response.

Method Summary

Modifier and Type	Method	Description
static FunctionEventType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FunctionEventType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VIEWER_REQUEST

@Stability(Stable)
public static final FunctionEventType VIEWER_REQUEST

The viewer-request specifies the incoming request.

VIEWER_RESPONSE

@Stability(Stable)
public static final FunctionEventType VIEWER_RESPONSE

The viewer-response specifies the outgoing response.

Method Details

values

public static FunctionEventType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FunctionEventType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null