AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
A complex type that describes how CloudFront processes requests.
You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.
For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide.
If you don't want to specify any cache behaviors, include only an empty CacheBehaviors
element. Don't specify an empty individual CacheBehavior
element, because this
is invalid. For more information, see CacheBehaviors.
To delete all cache behaviors in an existing distribution, update the distribution
configuration and include only an empty CacheBehaviors
element.
To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.
For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
Namespace: Amazon.CloudFront.Model
Assembly: AWSSDK.CloudFront.dll
Version: 3.x.y.z
public class CacheBehavior
The CacheBehavior type exposes the following members
Name | Description | |
---|---|---|
CacheBehavior() |
Name | Type | Description | |
---|---|---|---|
AllowedMethods | Amazon.CloudFront.Model.AllowedMethods |
Gets and sets the property AllowedMethods. |
|
CachePolicyId | System.String |
Gets and sets the property CachePolicyId. The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.
A |
|
Compress | System.Boolean |
Gets and sets the property Compress. 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 | System.Int64 |
Gets and sets the property DefaultTTL.
This field is deprecated. We recommend that you use the
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 |
|
FieldLevelEncryptionId | System.String |
Gets and sets the property FieldLevelEncryptionId.
The value of |
|
ForwardedValues | Amazon.CloudFront.Model.ForwardedValues |
Gets and sets the property ForwardedValues. 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 A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. |
|
FunctionAssociations | Amazon.CloudFront.Model.FunctionAssociations |
Gets and sets the property FunctionAssociations.
A list of CloudFront functions that are associated with this cache behavior. CloudFront
functions must be published to the |
|
LambdaFunctionAssociations | Amazon.CloudFront.Model.LambdaFunctionAssociations |
Gets and sets the property LambdaFunctionAssociations. A complex type that contains zero or more Lambda@Edge function associations for a cache behavior. |
|
MaxTTL | System.Int64 |
Gets and sets the property MaxTTL.
This field is deprecated. We recommend that you use the
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 |
|
MinTTL | System.Int64 |
Gets and sets the property MinTTL.
This field is deprecated. We recommend that you use the 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 |
|
OriginRequestPolicyId | System.String |
Gets and sets the property OriginRequestPolicyId. The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide. |
|
PathPattern | System.String |
Gets and sets the property PathPattern.
The pattern (for example,
You can optionally include a slash (
The path pattern for the default cache behavior is For more information, see Path Pattern in the Amazon CloudFront Developer Guide. |
|
RealtimeLogConfigArn | System.String |
Gets and sets the property RealtimeLogConfigArn. 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 | System.String |
Gets and sets the property ResponseHeadersPolicyId. The identifier for a response headers policy. |
|
SmoothStreaming | System.Boolean |
Gets and sets the property SmoothStreaming.
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
|
|
TargetOriginId | System.String |
Gets and sets the property TargetOriginId.
The value of |
|
TrustedKeyGroups | Amazon.CloudFront.Model.TrustedKeyGroups |
Gets and sets the property TrustedKeyGroups. 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 | Amazon.CloudFront.Model.TrustedSigners |
Gets and sets the property TrustedSigners.
We recommend using A list of Amazon Web Services 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 the trusted signer's Amazon Web Services 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. |
|
ViewerProtocolPolicy | Amazon.CloudFront.ViewerProtocolPolicy |
Gets and sets the property ViewerProtocolPolicy.
The protocol that viewers can use to access the files in the origin specified by
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. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5