DefaultCacheBehavior¶
Structure Class¶
DefaultCacheBehavior
dataclass
¶
Bases: _SerdeShape
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.
Warning
If your minimum TTL is greater than 0, CloudFront will cache content for
at least the duration specified in the cache policy's minimum TTL, even
if the Cache-Control: no-cache, no-store, or private directives
are present in the origin headers.
Attributes¶
allowed_methods
class-attribute
instance-attribute
¶
allowed_methods: AllowedMethods | None = ...
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
GETandHEADrequests. -
CloudFront forwards only
GET,HEAD, andOPTIONSrequests. -
CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST, andDELETErequests.
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.
cache_policy_id
class-attribute
instance-attribute
¶
cache_policy_id: str | None = ...
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.
compress
class-attribute
instance-attribute
¶
compress: bool | None = ...
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.
default_ttl
class-attribute
instance-attribute
¶
default_ttl: int | None = ...
Note
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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.
field_level_encryption_id
class-attribute
instance-attribute
¶
field_level_encryption_id: str | None = ...
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.
forwarded_values
class-attribute
instance-attribute
¶
forwarded_values: ForwardedValues | None = ...
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.
function_associations
class-attribute
instance-attribute
¶
function_associations: FunctionAssociations | None = ...
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.
grpc_config
class-attribute
instance-attribute
¶
grpc_config: GrpcConfig | None = ...
The gRPC configuration for your cache behavior.
lambda_function_associations
class-attribute
instance-attribute
¶
lambda_function_associations: LambdaFunctionAssociations | None = ...
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
max_ttl
class-attribute
instance-attribute
¶
max_ttl: int | None = ...
Note
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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.
min_ttl
class-attribute
instance-attribute
¶
min_ttl: int | None = ...
Note
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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).
origin_request_policy_id
class-attribute
instance-attribute
¶
origin_request_policy_id: str | None = ...
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.
realtime_log_config_arn
class-attribute
instance-attribute
¶
realtime_log_config_arn: str | None = ...
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.
response_headers_policy_id
class-attribute
instance-attribute
¶
response_headers_policy_id: str | None = ...
The identifier for a response headers policy.
smooth_streaming
class-attribute
instance-attribute
¶
smooth_streaming: bool | None = ...
Note
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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.
target_origin_id
instance-attribute
¶
target_origin_id: str
The value of ID for the origin that you want CloudFront to route
requests to when they use the default cache behavior.
trusted_key_groups
class-attribute
instance-attribute
¶
trusted_key_groups: TrustedKeyGroups | None = ...
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.
trusted_signers
class-attribute
instance-attribute
¶
trusted_signers: TrustedSigners | None = ...
Warning
We recommend using TrustedKeyGroups instead of TrustedSigners.
Note: This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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 a 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.
viewer_protocol_policy
instance-attribute
¶
viewer_protocol_policy: str
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.
Note
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.