Struct OriginAccessControlConfig

#[non_exhaustive]
pub struct OriginAccessControlConfig {
    pub name: String,
    pub description: Option<String>,
    pub signing_protocol: OriginAccessControlSigningProtocols,
    pub signing_behavior: OriginAccessControlSigningBehaviors,
    pub origin_access_control_origin_type: OriginAccessControlOriginTypes,
}

A CloudFront origin access control configuration.

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.

name: String

A name to identify the origin access control. You can specify up to 64 characters.

description: Option<String>

A description of the origin access control.

signing_protocol: OriginAccessControlSigningProtocols

The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

signing_behavior: OriginAccessControlSigningBehaviors

Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

This field can have one of the following values:

• always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

• never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

• no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

origin_access_control_origin_type: OriginAccessControlOriginTypes

The type of origin that this origin access control is for.

Implementations

impl OriginAccessControlConfig

pub fn name(&self) -> &str

A name to identify the origin access control. You can specify up to 64 characters.

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

A description of the origin access control.

pub fn signing_protocol(&self) -> &OriginAccessControlSigningProtocols

The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

pub fn signing_behavior(&self) -> &OriginAccessControlSigningBehaviors

Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide.

This field can have one of the following values:

• always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists.

• never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.

• no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.

pub fn origin_access_control_origin_type( &self, ) -> &OriginAccessControlOriginTypes

The type of origin that this origin access control is for.

impl OriginAccessControlConfig

pub fn builder() -> OriginAccessControlConfigBuilder

Creates a new builder-style object to manufacture OriginAccessControlConfig.

Trait Implementations

impl Clone for OriginAccessControlConfig

fn clone(&self) -> OriginAccessControlConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OriginAccessControlConfig

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

Formats the value using the given formatter.

impl PartialEq for OriginAccessControlConfig

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