interface DefaultCacheBehaviorProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CloudFront.CfnDistribution.DefaultCacheBehaviorProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#CfnDistribution_DefaultCacheBehaviorProperty`
Java	`software.amazon.awscdk.services.cloudfront.CfnDistribution.DefaultCacheBehaviorProperty`
Python	`aws_cdk.aws_cloudfront.CfnDistribution.DefaultCacheBehaviorProperty`
TypeScript	`aws-cdk-lib` » `aws_cloudfront` » `CfnDistribution` » `DefaultCacheBehaviorProperty`

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if request URLs don't match any of the values of PathPattern in CacheBehavior elements.

You must create exactly one default cache behavior.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const defaultCacheBehaviorProperty: cloudfront.CfnDistribution.DefaultCacheBehaviorProperty = {
  targetOriginId: 'targetOriginId',
  viewerProtocolPolicy: 'viewerProtocolPolicy',

  // the properties below are optional
  allowedMethods: ['allowedMethods'],
  cachedMethods: ['cachedMethods'],
  cachePolicyId: 'cachePolicyId',
  compress: false,
  defaultTtl: 123,
  fieldLevelEncryptionId: 'fieldLevelEncryptionId',
  forwardedValues: {
    queryString: false,

    // the properties below are optional
    cookies: {
      forward: 'forward',

      // the properties below are optional
      whitelistedNames: ['whitelistedNames'],
    },
    headers: ['headers'],
    queryStringCacheKeys: ['queryStringCacheKeys'],
  },
  functionAssociations: [{
    eventType: 'eventType',
    functionArn: 'functionArn',
  }],
  grpcConfig: {
    enabled: false,
  },
  lambdaFunctionAssociations: [{
    eventType: 'eventType',
    includeBody: false,
    lambdaFunctionArn: 'lambdaFunctionArn',
  }],
  maxTtl: 123,
  minTtl: 123,
  originRequestPolicyId: 'originRequestPolicyId',
  realtimeLogConfigArn: 'realtimeLogConfigArn',
  responseHeadersPolicyId: 'responseHeadersPolicyId',
  smoothStreaming: false,
  trustedKeyGroups: ['trustedKeyGroups'],
  trustedSigners: ['trustedSigners'],
};

Properties

Name	Type	Description
targetOriginId	`string`	The value of `ID` for the origin that you want CloudFront to route requests to when they use the default cache behavior.
viewerProtocolPolicy	`string`	The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern` .
allowedMethods?	`string[]`	A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin.
cachePolicyId?	`string`	The unique identifier of the cache policy that is attached to the default cache behavior.
cachedMethods?	`string[]`	A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods.
compress?	`boolean \|` `IResolvable`	Whether you want CloudFront to automatically compress certain files for this cache behavior.
defaultTtl?	`number`	This field is deprecated.
fieldLevelEncryptionId?	`string`	The value of `ID` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.
forwardedValues?	`IResolvable` `\|` `ForwardedValuesProperty`	This field is deprecated.
functionAssociations?	`IResolvable` `\|` `IResolvable` `\|` `FunctionAssociationProperty[]`	A list of CloudFront functions that are associated with this cache behavior.
grpcConfig?	`IResolvable` `\|` `GrpcConfigProperty`	The gRPC configuration for your cache behavior.
lambdaFunctionAssociations?	`IResolvable` `\|` `IResolvable` `\|` `LambdaFunctionAssociationProperty[]`	A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
maxTtl?	`number`	This field is deprecated.
minTtl?	`number`	This field is deprecated.
originRequestPolicyId?	`string`	The unique identifier of the origin request policy that is attached to the default cache behavior.
realtimeLogConfigArn?	`string`	The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior.
responseHeadersPolicyId?	`string`	The identifier for a response headers policy.
smoothStreaming?	`boolean \|` `IResolvable`	Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior.
trustedKeyGroups?	`string[]`	A list of key groups that CloudFront can use to validate signed URLs or signed cookies.
trustedSigners?	`string[]`	> We recommend using `TrustedKeyGroups` instead of `TrustedSigners` .

targetOriginId

Type: string

The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.

viewerProtocolPolicy

Type: string

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern .

You can specify the following options:

allow-all : Viewers can use HTTP or HTTPS.
redirect-to-https : If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.
https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .

allowedMethods?

Type: string[] (optional)

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin.

There are three choices:

CloudFront forwards only GET and HEAD requests.
CloudFront forwards only GET , HEAD , and OPTIONS requests.
CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST , and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

cachePolicyId?

Type: string (optional, default: "")

The unique identifier of the cache policy that is attached to the default cache behavior.

For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .

A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .

cachedMethods?

Type: string[] (optional)

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods.

There are two choices:

CloudFront caches responses to GET and HEAD requests.
CloudFront caches responses to GET , HEAD , and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

compress?

Type: boolean | IResolvable (optional, default: false)

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

If so, specify true ; if not, specify false . For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .

defaultTtl?

Type: number (optional, default: 86400)

This field is deprecated.

We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .

fieldLevelEncryptionId?

Type: string (optional, default: "")

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.

forwardedValues?

Type: IResolvable | ForwardedValuesProperty (optional)

This field is deprecated.

We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .

If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .

If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .

A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId .

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

functionAssociations?

Type: IResolvable | IResolvable | FunctionAssociationProperty[] (optional)

A list of CloudFront functions that are associated with this cache behavior.

Your functions must be published to the LIVE stage to associate them with a cache behavior.

grpcConfig?

Type: IResolvable | GrpcConfigProperty (optional)

The gRPC configuration for your cache behavior.

lambdaFunctionAssociations?

Type: IResolvable | IResolvable | LambdaFunctionAssociationProperty[] (optional)

A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.

maxTtl?

Type: number (optional, default: 31536000)

This field is deprecated.

We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .

minTtl?

Type: number (optional, default: 0)

This field is deprecated.

We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers , if you specify 1 for Quantity and * for Name ).

originRequestPolicyId?

Type: string (optional, default: "")

The unique identifier of the origin request policy that is attached to the default cache behavior.

For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .

realtimeLogConfigArn?

Type: string (optional, default: "")

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior.

For more information, see Real-time logs in the Amazon CloudFront Developer Guide .

responseHeadersPolicyId?

Type: string (optional, default: "")

The identifier for a response headers policy.

smoothStreaming?

Type: boolean | IResolvable (optional, default: false)

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior.

If so, specify true ; if not, specify false . If you specify true for SmoothStreaming , you can still distribute other content using this cache behavior if the content matches the value of PathPattern .

trustedKeyGroups?

Type: string[] (optional)

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .

trustedSigners?

Type: string[] (optional)

We recommend using TrustedKeyGroups instead of TrustedSigners .

A list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS account . The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .