Struct ResponseHeadersPolicyServerTimingHeadersConfig

#[non_exhaustive]
pub struct ResponseHeadersPolicyServerTimingHeadersConfig {
    pub enabled: bool,
    pub sampling_rate: Option<f64>,
}

A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront. CloudFront adds this header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.

You can use the Server-Timing header to view metrics that can help you gain insights about the behavior and performance of CloudFront. For example, you can see which cache layer served a cache hit, or the first byte latency from the origin when there was a cache miss. You can use the metrics in the Server-Timing header to troubleshoot issues or test the efficiency of your CloudFront configuration. For more information, see Server-Timing header in the Amazon CloudFront Developer Guide.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.

sampling_rate: Option<f64>

A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.

Implementations

impl ResponseHeadersPolicyServerTimingHeadersConfig

pub fn enabled(&self) -> bool

A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.

pub fn sampling_rate(&self) -> Option<f64>

A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.

impl ResponseHeadersPolicyServerTimingHeadersConfig

pub fn builder() -> ResponseHeadersPolicyServerTimingHeadersConfigBuilder

Creates a new builder-style object to manufacture ResponseHeadersPolicyServerTimingHeadersConfig.

Trait Implementations

impl Clone for ResponseHeadersPolicyServerTimingHeadersConfig

fn clone(&self) -> ResponseHeadersPolicyServerTimingHeadersConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResponseHeadersPolicyServerTimingHeadersConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ResponseHeadersPolicyServerTimingHeadersConfig

fn eq(&self, other: &ResponseHeadersPolicyServerTimingHeadersConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ResponseHeadersPolicyServerTimingHeadersConfig