Struct AWSV4Signature 

#[non_exhaustive]
pub struct AWSV4Signature {
    pub access_key: Option<String>,
    pub access_key_id: Option<String>,
    pub access_key_version: Option<String>,
    pub origin_region: Option<String>,
    /* private fields */
}

Available on crate features backend-services or region-backend-services only.

Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to ‘s3’.

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.

access_key: Option<String>

The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request.

@InputOnly

access_key_id: Option<String>

The identifier of an access key used for s3 bucket authentication.

access_key_version: Option<String>

The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.

origin_region: Option<String>

The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, “us-east-1” for AWS or “us-ashburn-1” for OCI.

Implementations

impl AWSV4Signature

pub fn new() -> Self

Creates a new default instance.

pub fn set_access_key<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of access_key.

Example

let x = AWSV4Signature::new().set_access_key("example");

pub fn set_or_clear_access_key<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of access_key.

Example

let x = AWSV4Signature::new().set_or_clear_access_key(Some("example"));
let x = AWSV4Signature::new().set_or_clear_access_key(None::<String>);

pub fn set_access_key_id<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of access_key_id.

Example

let x = AWSV4Signature::new().set_access_key_id("example");

pub fn set_or_clear_access_key_id<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of access_key_id.

Example

let x = AWSV4Signature::new().set_or_clear_access_key_id(Some("example"));
let x = AWSV4Signature::new().set_or_clear_access_key_id(None::<String>);

pub fn set_access_key_version<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of access_key_version.

Example

let x = AWSV4Signature::new().set_access_key_version("example");

pub fn set_or_clear_access_key_version<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of access_key_version.

Example

let x = AWSV4Signature::new().set_or_clear_access_key_version(Some("example"));
let x = AWSV4Signature::new().set_or_clear_access_key_version(None::<String>);

pub fn set_origin_region<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of origin_region.

Example

let x = AWSV4Signature::new().set_origin_region("example");

pub fn set_or_clear_origin_region<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of origin_region.

Example

let x = AWSV4Signature::new().set_or_clear_origin_region(Some("example"));
let x = AWSV4Signature::new().set_or_clear_origin_region(None::<String>);

Trait Implementations

impl Clone for AWSV4Signature

fn clone(&self) -> AWSV4Signature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AWSV4Signature

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

Formats the value using the given formatter.

impl Default for AWSV4Signature

fn default() -> AWSV4Signature

Returns the “default value” for a type.

impl Message for AWSV4Signature

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AWSV4Signature

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AWSV4Signature