pub struct AwsCustomAuthOptions { /* private fields */ }
Expand description
A struct that holds all relevant details needed to perform custom authentication with AWS IoT Core.
Implementations§
Source§impl AwsCustomAuthOptions
impl AwsCustomAuthOptions
Sourcepub fn builder_unsigned(
authorizer_name: Option<&str>,
) -> AwsCustomAuthOptionsBuilder
pub fn builder_unsigned( authorizer_name: Option<&str>, ) -> AwsCustomAuthOptionsBuilder
Creates a new custom authentication options builder to use an unsigned authorizer.
authorizer_name
- name of the AWS IoT authorizer to use. This value must be URI-encoded if necessary. A
value is required unless the AWS account has a default authorizer configured for it.
Sourcepub fn builder_signed(
authorizer_name: Option<&str>,
authorizer_signature: &str,
authorizer_token_key_name: &str,
authorizer_token_key_value: &str,
) -> AwsCustomAuthOptionsBuilder
pub fn builder_signed( authorizer_name: Option<&str>, authorizer_signature: &str, authorizer_token_key_name: &str, authorizer_token_key_value: &str, ) -> AwsCustomAuthOptionsBuilder
Creates a new custom authentication options builder to use a signed authorizer. See
AWS IoT Custom Authentication
for more details. The authenticator’s Lambda will not be invoked unless authorizer_signature
is the URI-encoded Base64-encoded signature of authorizer_token_key_value
via the private key
associated with the public key that was registered with the authorizer on creation.
authorizer_name
- name of the AWS IoT authorizer to use. This value must be URI-encoded if necessary. A
value is required unless the AWS account has a default authorizer configured for it.
authorizer_signature
- The URI-encoded, Base64-encoded cryptographic signature of the value contained in authorizer_token_key_value
. The signature must be
made with the private key associated with the public key that was registered with the authorizer.
authorizer_token_key_name
- key name registered with the signing authorizer that indicates the name of the field whose value will contain the authorizer_token_key_value
authorizer_token_key_value
- arbitrary, developer-selected value whose digital signature must be provided in the authorizer_signature
Both authorizer_token_key_name
and authorizer_name
must be valid URI-encoded values.
Auto Trait Implementations§
impl Freeze for AwsCustomAuthOptions
impl RefUnwindSafe for AwsCustomAuthOptions
impl Send for AwsCustomAuthOptions
impl Sync for AwsCustomAuthOptions
impl Unpin for AwsCustomAuthOptions
impl UnwindSafe for AwsCustomAuthOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more