Struct CacheSettings 

#[non_exhaustive]
pub struct CacheSettings {
    pub default_ttl: Option<i64>,
    pub minimum_ttl: Option<i64>,
    pub maximum_ttl: Option<i64>,
    pub allowed_http_methods: Option<String>,
    pub cached_http_methods: Option<String>,
    pub forwarded_cookies: Option<CookieObject>,
    pub forwarded_headers: Option<HeaderObject>,
    pub forwarded_query_strings: Option<QueryStringObject>,
}

Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.

These settings apply only to your distribution's cacheBehaviors (including the defaultCacheBehavior) that have a behavior of cache.

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.

default_ttl: Option<i64>

The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.

The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

minimum_ttl: Option<i64>

The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.

maximum_ttl: Option<i64>

The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

allowed_http_methods: Option<String>

The HTTP methods that are processed and forwarded to the distribution's origin.

You can specify the following options:

• GET,HEAD - The distribution forwards the GET and HEAD methods.

• GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.

• GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.

If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.

cached_http_methods: Option<String>

The HTTP method responses that are cached by your distribution.

You can specify the following options:

• GET,HEAD - The distribution caches responses to the GET and HEAD methods.

• GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.

forwarded_cookies: Option<CookieObject>

An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.

forwarded_headers: Option<HeaderObject>

An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.

forwarded_query_strings: Option<QueryStringObject>

An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.

Implementations

impl CacheSettings

pub fn default_ttl(&self) -> Option<i64>

The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.

The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

pub fn minimum_ttl(&self) -> Option<i64>

The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.

pub fn maximum_ttl(&self) -> Option<i64>

The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

pub fn allowed_http_methods(&self) -> Option<&str>

The HTTP methods that are processed and forwarded to the distribution's origin.

You can specify the following options:

• GET,HEAD - The distribution forwards the GET and HEAD methods.

• GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.

• GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.

If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.

pub fn cached_http_methods(&self) -> Option<&str>

The HTTP method responses that are cached by your distribution.

You can specify the following options:

• GET,HEAD - The distribution caches responses to the GET and HEAD methods.

• GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.

pub fn forwarded_cookies(&self) -> Option<&CookieObject>

An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.

pub fn forwarded_headers(&self) -> Option<&HeaderObject>

An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.

pub fn forwarded_query_strings(&self) -> Option<&QueryStringObject>

An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.

impl CacheSettings

pub fn builder() -> CacheSettingsBuilder

Creates a new builder-style object to manufacture CacheSettings.

Trait Implementations

impl Clone for CacheSettings

fn clone(&self) -> CacheSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheSettings

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

Formats the value using the given formatter.

impl PartialEq for CacheSettings

fn eq(&self, other: &CacheSettings) -> 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 CacheSettings