Package software.amazon.awscdk.services.cloudfront

Interface AddBehaviorOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

BehaviorOptions

All Known Implementing Classes:

AddBehaviorOptions.Jsii$Proxy, BehaviorOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.413Z")
@Stability(Stable)
public interface AddBehaviorOptions
extends software.amazon.jsii.JsiiSerializable

Options for adding a new behavior to a Distribution.

Example:

 // Add a behavior to a Distribution after initial creation.
 Bucket myBucket;
 Distribution myWebDistribution;
 myWebDistribution.addBehavior("/images/*.jpg", new S3Origin(myBucket), AddBehaviorOptions.builder()
         .viewerProtocolPolicy(ViewerProtocolPolicy.REDIRECT_TO_HTTPS)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AddBehaviorOptions.Builder	builder()
default AllowedMethods	getAllowedMethods()	HTTP methods to allow for this behavior.
default CachedMethods	getCachedMethods()	HTTP methods to cache for this behavior.
default ICachePolicy	getCachePolicy()	The cache policy for this behavior.
default Boolean	getCompress()	Whether you want CloudFront to automatically compress certain files for this cache behavior.
default List<EdgeLambda>	getEdgeLambdas()	The Lambda@Edge functions to invoke before serving the contents.
default List<FunctionAssociation>	getFunctionAssociations()	The CloudFront functions to invoke before serving the contents.
default IOriginRequestPolicy	getOriginRequestPolicy()	The origin request policy for this behavior.
default IResponseHeadersPolicy	getResponseHeadersPolicy()	The response headers policy for this behavior.
default Boolean	getSmoothStreaming()	Set this to true to indicate you want to distribute media files in the Microsoft Smooth Streaming format using this behavior.
default List<IKeyGroup>	getTrustedKeyGroups()	A list of Key Groups that CloudFront can use to validate signed URLs or signed cookies.
default ViewerProtocolPolicy	getViewerProtocolPolicy()	The protocol that viewers can use to access the files controlled by this behavior.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowedMethods

@Stability(Stable)
@Nullable
default AllowedMethods getAllowedMethods()

HTTP methods to allow for this behavior.

Default: AllowedMethods.ALLOW_GET_HEAD

getCachedMethods

@Stability(Stable)
@Nullable
default CachedMethods getCachedMethods()

HTTP methods to cache for this behavior.

Default: CachedMethods.CACHE_GET_HEAD

getCachePolicy

@Stability(Stable)
@Nullable
default ICachePolicy getCachePolicy()

The cache policy for this behavior.

The cache policy determines what values are included in the cache key, and the time-to-live (TTL) values for the cache.

Default: CachePolicy.CACHING_OPTIMIZED

See Also:

• https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html.

getCompress

@Stability(Stable)
@Nullable
default Boolean getCompress()

Whether you want CloudFront to automatically compress certain files for this cache behavior.

See https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html#compressed-content-cloudfront-file-types for file types CloudFront will compress.

Default: true

getEdgeLambdas

@Stability(Stable)
@Nullable
default List<EdgeLambda> getEdgeLambdas()

The Lambda@Edge functions to invoke before serving the contents.

Default: - no Lambda functions will be invoked

See Also:

• https://aws.amazon.com/lambda/edge

getFunctionAssociations

@Stability(Stable)
@Nullable
default List<FunctionAssociation> getFunctionAssociations()

The CloudFront functions to invoke before serving the contents.

Default: - no functions will be invoked

getOriginRequestPolicy

@Stability(Stable)
@Nullable
default IOriginRequestPolicy getOriginRequestPolicy()

The origin request policy for this behavior.

The origin request policy determines which values (e.g., headers, cookies) are included in requests that CloudFront sends to the origin.

Default: - none

getResponseHeadersPolicy

@Stability(Stable)
@Nullable
default IResponseHeadersPolicy getResponseHeadersPolicy()

The response headers policy for this behavior.

The response headers policy determines which headers are included in responses

Default: - none

getSmoothStreaming

@Stability(Stable)
@Nullable
default Boolean getSmoothStreaming()

Set this to true to indicate you want to distribute media files in the Microsoft Smooth Streaming format using this behavior.

Default: false

getTrustedKeyGroups

@Stability(Stable)
@Nullable
default List<IKeyGroup> getTrustedKeyGroups()

A list of Key Groups that CloudFront can use to validate signed URLs or signed cookies.

Default: - no KeyGroups are associated with cache behavior

See Also:

• https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html

getViewerProtocolPolicy

@Stability(Stable)
@Nullable
default ViewerProtocolPolicy getViewerProtocolPolicy()

The protocol that viewers can use to access the files controlled by this behavior.

Default: ViewerProtocolPolicy.ALLOW_ALL

builder

@Stability(Stable)
static AddBehaviorOptions.Builder builder()

Returns:

a AddBehaviorOptions.Builder of AddBehaviorOptions