Struct MutualTlsAuthentication

#[non_exhaustive]
pub struct MutualTlsAuthentication {
    pub truststore_uri: Option<String>,
    pub truststore_version: Option<String>,
    pub truststore_warnings: Option<Vec<String>>,
}

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

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.

truststore_uri: Option<String>

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

truststore_version: Option<String>

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

truststore_warnings: Option<Vec<String>>

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

Implementations

impl MutualTlsAuthentication

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

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

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

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

pub fn truststore_warnings(&self) -> &[String]

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .truststore_warnings.is_none().

impl MutualTlsAuthentication

pub fn builder() -> MutualTlsAuthenticationBuilder

Creates a new builder-style object to manufacture MutualTlsAuthentication.

Trait Implementations

impl Clone for MutualTlsAuthentication

fn clone(&self) -> MutualTlsAuthentication

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MutualTlsAuthentication

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

Formats the value using the given formatter.

impl PartialEq for MutualTlsAuthentication

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

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

const 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 MutualTlsAuthentication