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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
LambdaFunctionAssociation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LambdaFunctionAssociation.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
EventType
eventType()
Specifies the event type that triggers a Lambda@Edge function invocation.String
eventTypeAsString()
Specifies the event type that triggers a Lambda@Edge function invocation.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Boolean
includeBody()
A flag that allows a Lambda@Edge function to have read access to the body content.String
lambdaFunctionARN()
The ARN of the Lambda@Edge function.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends LambdaFunctionAssociation.Builder>
serializableBuilderClass()
LambdaFunctionAssociation.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnEventType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventTypeAsString()
.- 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:
EventType
-
-
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 returnEventType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventTypeAsString()
.- 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:
EventType
-
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<LambdaFunctionAssociation.Builder,LambdaFunctionAssociation>
-
builder
public static LambdaFunctionAssociation.Builder builder()
-
serializableBuilderClass
public static Class<? extends LambdaFunctionAssociation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-