Struct aws_sdk_cloudfront::model::DefaultCacheBehavior
source · [−]#[non_exhaustive]pub struct DefaultCacheBehavior {Show 18 fields
pub target_origin_id: Option<String>,
pub trusted_signers: Option<TrustedSigners>,
pub trusted_key_groups: Option<TrustedKeyGroups>,
pub viewer_protocol_policy: Option<ViewerProtocolPolicy>,
pub allowed_methods: Option<AllowedMethods>,
pub smooth_streaming: Option<bool>,
pub compress: Option<bool>,
pub lambda_function_associations: Option<LambdaFunctionAssociations>,
pub function_associations: Option<FunctionAssociations>,
pub field_level_encryption_id: Option<String>,
pub realtime_log_config_arn: Option<String>,
pub cache_policy_id: Option<String>,
pub origin_request_policy_id: Option<String>,
pub response_headers_policy_id: Option<String>,
pub forwarded_values: Option<ForwardedValues>,
pub min_ttl: Option<i64>,
pub default_ttl: Option<i64>,
pub max_ttl: Option<i64>,
}
Expand description
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.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.target_origin_id: Option<String>
The value of ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior.
trusted_signers: Option<TrustedSigners>
We recommend using TrustedKeyGroups
instead of TrustedSigners
.
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.
trusted_key_groups: Option<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.
viewer_protocol_policy: Option<ViewerProtocolPolicy>
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.
allowed_methods: Option<AllowedMethods>
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
andHEAD
requests. -
CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. -
CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
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.
smooth_streaming: Option<bool>
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
.
compress: Option<bool>
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.
lambda_function_associations: Option<LambdaFunctionAssociations>
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
function_associations: Option<FunctionAssociations>
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE
stage to associate them with a cache behavior.
field_level_encryption_id: Option<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.
realtime_log_config_arn: Option<String>
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.
cache_policy_id: Option<String>
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
.
origin_request_policy_id: Option<String>
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.
response_headers_policy_id: Option<String>
The identifier for a response headers policy.
forwarded_values: Option<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 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.
min_ttl: Option<i64>
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
).
default_ttl: Option<i64>
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.
max_ttl: Option<i64>
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.
Implementations
sourceimpl DefaultCacheBehavior
impl DefaultCacheBehavior
sourcepub fn target_origin_id(&self) -> Option<&str>
pub fn target_origin_id(&self) -> Option<&str>
The value of ID
for the origin that you want CloudFront to route requests to when they use the default cache behavior.
sourcepub fn trusted_signers(&self) -> Option<&TrustedSigners>
pub fn trusted_signers(&self) -> Option<&TrustedSigners>
We recommend using TrustedKeyGroups
instead of TrustedSigners
.
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.
sourcepub fn trusted_key_groups(&self) -> Option<&TrustedKeyGroups>
pub fn trusted_key_groups(&self) -> Option<&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.
sourcepub fn viewer_protocol_policy(&self) -> Option<&ViewerProtocolPolicy>
pub fn viewer_protocol_policy(&self) -> Option<&ViewerProtocolPolicy>
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.
sourcepub fn allowed_methods(&self) -> Option<&AllowedMethods>
pub fn allowed_methods(&self) -> Option<&AllowedMethods>
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
andHEAD
requests. -
CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. -
CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
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.
sourcepub fn smooth_streaming(&self) -> Option<bool>
pub fn smooth_streaming(&self) -> Option<bool>
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
.
sourcepub fn compress(&self) -> Option<bool>
pub fn compress(&self) -> Option<bool>
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.
sourcepub fn lambda_function_associations(
&self
) -> Option<&LambdaFunctionAssociations>
pub fn lambda_function_associations(
&self
) -> Option<&LambdaFunctionAssociations>
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.
sourcepub fn function_associations(&self) -> Option<&FunctionAssociations>
pub fn function_associations(&self) -> Option<&FunctionAssociations>
A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE
stage to associate them with a cache behavior.
sourcepub fn field_level_encryption_id(&self) -> Option<&str>
pub fn field_level_encryption_id(&self) -> Option<&str>
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.
sourcepub fn realtime_log_config_arn(&self) -> Option<&str>
pub fn realtime_log_config_arn(&self) -> Option<&str>
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.
sourcepub fn cache_policy_id(&self) -> Option<&str>
pub fn cache_policy_id(&self) -> Option<&str>
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
.
sourcepub fn origin_request_policy_id(&self) -> Option<&str>
pub fn origin_request_policy_id(&self) -> Option<&str>
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.
sourcepub fn response_headers_policy_id(&self) -> Option<&str>
pub fn response_headers_policy_id(&self) -> Option<&str>
The identifier for a response headers policy.
sourcepub fn forwarded_values(&self) -> Option<&ForwardedValues>
pub fn forwarded_values(&self) -> Option<&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 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.
sourcepub fn min_ttl(&self) -> Option<i64>
pub fn min_ttl(&self) -> Option<i64>
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
).
sourcepub fn default_ttl(&self) -> Option<i64>
pub fn default_ttl(&self) -> Option<i64>
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.
sourcepub fn max_ttl(&self) -> Option<i64>
pub fn max_ttl(&self) -> Option<i64>
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.
sourceimpl DefaultCacheBehavior
impl DefaultCacheBehavior
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture DefaultCacheBehavior
Trait Implementations
sourceimpl Clone for DefaultCacheBehavior
impl Clone for DefaultCacheBehavior
sourcefn clone(&self) -> DefaultCacheBehavior
fn clone(&self) -> DefaultCacheBehavior
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for DefaultCacheBehavior
impl Debug for DefaultCacheBehavior
sourceimpl PartialEq<DefaultCacheBehavior> for DefaultCacheBehavior
impl PartialEq<DefaultCacheBehavior> for DefaultCacheBehavior
sourcefn eq(&self, other: &DefaultCacheBehavior) -> bool
fn eq(&self, other: &DefaultCacheBehavior) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DefaultCacheBehavior) -> bool
fn ne(&self, other: &DefaultCacheBehavior) -> bool
This method tests for !=
.
impl StructuralPartialEq for DefaultCacheBehavior
Auto Trait Implementations
impl RefUnwindSafe for DefaultCacheBehavior
impl Send for DefaultCacheBehavior
impl Sync for DefaultCacheBehavior
impl Unpin for DefaultCacheBehavior
impl UnwindSafe for DefaultCacheBehavior
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more