aws-cdk-lib.aws_cloudfront.AddBehaviorOptions

AddBehaviorOptions Struct

Options for adding a new behavior to a Distribution.

Source

aws-cloudfront/lib/distribution.ts

Type last changed

v2.273.0 · 8 Oct 2026

Example

// Add a behavior to a Distribution after initial creation.
declare const myBucket: s3.Bucket;
declare const myWebDistribution: cloudfront.Distribution;
myWebDistribution.addBehavior('/images/*.jpg', new origins.S3Origin(myBucket), {
  viewerProtocolPolicy: cloudfront.ViewerProtocolPolicy.REDIRECT_TO_HTTPS,
});

Properties

allowedMethods?optionalAllowedMethodsallowed_methods?optionalAllowedMethodsallowedMethods?optionalAllowedMethodsAllowedMethods?optionalAllowedMethodsAllowedMethods?optionalAllowedMethods= AllowedMethods.ALLOW_GET_HEAD#

HTTP methods to allow for this behavior.

cachedMethods?optionalCachedMethodscached_methods?optionalCachedMethodscachedMethods?optionalCachedMethodsCachedMethods?optionalCachedMethodsCachedMethods?optionalCachedMethods= CachedMethods.CACHE_GET_HEAD#

HTTP methods to cache for this behavior.

cachePolicy?optionalICachePolicyRefcache_policy?optionalICachePolicyRefcachePolicy?optionalICachePolicyRefCachePolicy?optionalICachePolicyRefCachePolicy?optionalICachePolicyRef= CachePolicy.CACHING_OPTIMIZED#

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.

compress?optionalbooleancompress?optionalboolcompress?optionalBooleanCompress?optionalboolCompress?optional*bool= true#

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.

edgeLambdas?optionalEdgeLambda[]edge_lambdas?optionaltyping.List[EdgeLambda]edgeLambdas?optionalList<EdgeLambda>EdgeLambdas?optionalEdgeLambda[]EdgeLambdas?optional*[]EdgeLambda#

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

Default: no Lambda functions will be invoked

enableGrpc?optionalbooleanenable_grpc?optionalboolenableGrpc?optionalBooleanEnableGrpc?optionalboolEnableGrpc?optional*bool= false#

Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins.

notes

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.

functionAssociations?optionalFunctionAssociation[]function_associations?optionaltyping.List[FunctionAssociation]functionAssociations?optionalList<FunctionAssociation>FunctionAssociations?optionalFunctionAssociation[]FunctionAssociations?optional*[]FunctionAssociation#

The CloudFront functions to invoke before serving the contents.

Default: no functions will be invoked

originRequestPolicy?optionalIOriginRequestPolicyReforigin_request_policy?optionalIOriginRequestPolicyReforiginRequestPolicy?optionalIOriginRequestPolicyRefOriginRequestPolicy?optionalIOriginRequestPolicyRefOriginRequestPolicy?optionalIOriginRequestPolicyRef= none#

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.

realtimeLogConfig?optionalIRealtimeLogConfigRefrealtime_log_config?optionalIRealtimeLogConfigRefrealtimeLogConfig?optionalIRealtimeLogConfigRefRealtimeLogConfig?optionalIRealtimeLogConfigRefRealtimeLogConfig?optionalIRealtimeLogConfigRef= none#

The real-time log configuration to be attached to this cache behavior.

responseHeadersPolicy?optionalIResponseHeadersPolicyRefresponse_headers_policy?optionalIResponseHeadersPolicyRefresponseHeadersPolicy?optionalIResponseHeadersPolicyRefResponseHeadersPolicy?optionalIResponseHeadersPolicyRefResponseHeadersPolicy?optionalIResponseHeadersPolicyRef= none#

The response headers policy for this behavior.

The response headers policy determines which headers are included in responses

smoothStreaming?optionalbooleansmooth_streaming?optionalboolsmoothStreaming?optionalBooleanSmoothStreaming?optionalboolSmoothStreaming?optional*bool= false#

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

trustedKeyGroups?optionalIKeyGroupRef[]trusted_key_groups?optionaltyping.List[IKeyGroupRef]trustedKeyGroups?optionalList<IKeyGroupRef>TrustedKeyGroups?optionalIKeyGroupRef[]TrustedKeyGroups?optional*[]IKeyGroupRef#

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

Default: no KeyGroups are associated with cache behavior

viewerProtocolPolicy?optionalViewerProtocolPolicyviewer_protocol_policy?optionalViewerProtocolPolicyviewerProtocolPolicy?optionalViewerProtocolPolicyViewerProtocolPolicy?optionalViewerProtocolPolicyViewerProtocolPolicy?optionalViewerProtocolPolicy#

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

Default: ViewerProtocolPolicy.REDIRECT_TO_HTTPS if the @aws-cdk/aws-cloudfront:defaultViewerProtocolPolicyRedirectToHttps feature flag is enabled, otherwise ViewerProtocolPolicy.ALLOW_ALL