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.121.0 (build d7af9b9)", date="2025-12-18T18:20:06.424Z") @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());

  • 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 ICachePolicyRef 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:

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

    • getEnableGrpc

      @Stability(Stable) @Nullable default Boolean getEnableGrpc()
      Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins.

      If the enableGrpc is set to true, the following restrictions apply:

      • The allowedMethods property must be AllowedMethods.ALLOW_ALL to include POST method because gRPC only supports POST method.
      • The httpVersion property must be HttpVersion.HTTP2 or HttpVersion.HTTP2_AND_3 because gRPC only supports versions including HTTP/2.
      • The edgeLambdas property can't be specified because gRPC is not supported with Lambda@Edge.

      Default: false

      See Also:

    • 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 IOriginRequestPolicyRef 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

    • getRealtimeLogConfig

      @Stability(Stable) @Nullable default IRealtimeLogConfigRef getRealtimeLogConfig()
      The real-time log configuration to be attached to this cache behavior.

      Default: - none

    • getResponseHeadersPolicy

      @Stability(Stable) @Nullable default IResponseHeadersPolicyRef 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<IKeyGroupRef> 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:

    • 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