#[non_exhaustive]pub struct ParametersInCacheKeyAndForwardedToOrigin {
pub enable_accept_encoding_gzip: Option<bool>,
pub enable_accept_encoding_brotli: Option<bool>,
pub headers_config: Option<CachePolicyHeadersConfig>,
pub cookies_config: Option<CachePolicyCookiesConfig>,
pub query_strings_config: Option<CachePolicyQueryStringsConfig>,
}
Expand description
This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy
.
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.enable_accept_encoding_gzip: Option<bool>
A flag that can affect whether the Accept-Encoding
HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli
field. If one or both of these fields is true
and the viewer request includes the Accept-Encoding
header, then CloudFront does the following:
-
Normalizes the value of the viewer’s
Accept-Encoding
header -
Includes the normalized header in the cache key
-
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to true
, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding
header in the origin request policy. CloudFront always includes the Accept-Encoding
header in origin requests when the value of this field is true
, so including this header in an origin request policy has no effect.
If both of these fields are false
, then CloudFront treats the Accept-Encoding
header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding
to the headers whitelist like any other HTTP header.
enable_accept_encoding_brotli: Option<bool>
A flag that can affect whether the Accept-Encoding
HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip
field. If one or both of these fields is true
and the viewer request includes the Accept-Encoding
header, then CloudFront does the following:
-
Normalizes the value of the viewer’s
Accept-Encoding
header -
Includes the normalized header in the cache key
-
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to true
, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding
header in the origin request policy. CloudFront always includes the Accept-Encoding
header in origin requests when the value of this field is true
, so including this header in an origin request policy has no effect.
If both of these fields are false
, then CloudFront treats the Accept-Encoding
header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding
to the headers whitelist like any other HTTP header.
headers_config: Option<CachePolicyHeadersConfig>
An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
query_strings_config: Option<CachePolicyQueryStringsConfig>
An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
Implementations
sourceimpl ParametersInCacheKeyAndForwardedToOrigin
impl ParametersInCacheKeyAndForwardedToOrigin
sourcepub fn enable_accept_encoding_gzip(&self) -> Option<bool>
pub fn enable_accept_encoding_gzip(&self) -> Option<bool>
A flag that can affect whether the Accept-Encoding
HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingBrotli
field. If one or both of these fields is true
and the viewer request includes the Accept-Encoding
header, then CloudFront does the following:
-
Normalizes the value of the viewer’s
Accept-Encoding
header -
Includes the normalized header in the cache key
-
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to true
, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding
header in the origin request policy. CloudFront always includes the Accept-Encoding
header in origin requests when the value of this field is true
, so including this header in an origin request policy has no effect.
If both of these fields are false
, then CloudFront treats the Accept-Encoding
header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding
to the headers whitelist like any other HTTP header.
sourcepub fn enable_accept_encoding_brotli(&self) -> Option<bool>
pub fn enable_accept_encoding_brotli(&self) -> Option<bool>
A flag that can affect whether the Accept-Encoding
HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
This field is related to the EnableAcceptEncodingGzip
field. If one or both of these fields is true
and the viewer request includes the Accept-Encoding
header, then CloudFront does the following:
-
Normalizes the value of the viewer’s
Accept-Encoding
header -
Includes the normalized header in the cache key
-
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to true
, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding
header in the origin request policy. CloudFront always includes the Accept-Encoding
header in origin requests when the value of this field is true
, so including this header in an origin request policy has no effect.
If both of these fields are false
, then CloudFront treats the Accept-Encoding
header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding
to the headers whitelist like any other HTTP header.
sourcepub fn headers_config(&self) -> Option<&CachePolicyHeadersConfig>
pub fn headers_config(&self) -> Option<&CachePolicyHeadersConfig>
An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
sourcepub fn query_strings_config(&self) -> Option<&CachePolicyQueryStringsConfig>
pub fn query_strings_config(&self) -> Option<&CachePolicyQueryStringsConfig>
An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
sourceimpl ParametersInCacheKeyAndForwardedToOrigin
impl ParametersInCacheKeyAndForwardedToOrigin
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture ParametersInCacheKeyAndForwardedToOrigin
Trait Implementations
sourceimpl Clone for ParametersInCacheKeyAndForwardedToOrigin
impl Clone for ParametersInCacheKeyAndForwardedToOrigin
sourcefn clone(&self) -> ParametersInCacheKeyAndForwardedToOrigin
fn clone(&self) -> ParametersInCacheKeyAndForwardedToOrigin
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 PartialEq<ParametersInCacheKeyAndForwardedToOrigin> for ParametersInCacheKeyAndForwardedToOrigin
impl PartialEq<ParametersInCacheKeyAndForwardedToOrigin> for ParametersInCacheKeyAndForwardedToOrigin
sourcefn eq(&self, other: &ParametersInCacheKeyAndForwardedToOrigin) -> bool
fn eq(&self, other: &ParametersInCacheKeyAndForwardedToOrigin) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ParametersInCacheKeyAndForwardedToOrigin) -> bool
fn ne(&self, other: &ParametersInCacheKeyAndForwardedToOrigin) -> bool
This method tests for !=
.
impl StructuralPartialEq for ParametersInCacheKeyAndForwardedToOrigin
Auto Trait Implementations
impl RefUnwindSafe for ParametersInCacheKeyAndForwardedToOrigin
impl Send for ParametersInCacheKeyAndForwardedToOrigin
impl Sync for ParametersInCacheKeyAndForwardedToOrigin
impl Unpin for ParametersInCacheKeyAndForwardedToOrigin
impl UnwindSafe for ParametersInCacheKeyAndForwardedToOrigin
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