Package software.amazon.awssdk.services.cloudfront.model

Class LambdaFunctionAssociation

java.lang.Object
software.amazon.awssdk.services.cloudfront.model.LambdaFunctionAssociation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LambdaFunctionAssociation.Builder,LambdaFunctionAssociation>
@Generated("software.amazon.awssdk:codegen") public final class LambdaFunctionAssociation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LambdaFunctionAssociation.Builder,LambdaFunctionAssociation>

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

See Also:

  • Method Details

    • lambdaFunctionARN

      public final String lambdaFunctionARN()

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

      Returns:
      The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.

    • eventType

      public final EventType eventType()

      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.

      If the service returns an enum value that is not available in the current SDK version, eventType will return EventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      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:

    • eventTypeAsString

      public final String eventTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, eventType will return EventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      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:

    • includeBody

      public final Boolean includeBody()

      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.

      Returns:
      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.

    • toBuilder

      public LambdaFunctionAssociation.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LambdaFunctionAssociation.Builder,LambdaFunctionAssociation>
      Returns:
      a builder for type T

    • builder

      public static LambdaFunctionAssociation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LambdaFunctionAssociation.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.