pub struct TokenProviderChain { /* private fields */ }
Expand description

Access token provider that checks a series of inner providers.

Each provider will be evaluated in order:

  • If a provider returns valid Token they will be returned immediately. No other token providers will be used.
  • Otherwise, if a provider returns TokenError::TokenNotLoaded, the next provider will be checked.
  • Finally, if a provider returns any other error condition, an error will be returned immediately.

§Examples

use aws_config::meta::token::TokenProviderChain;
use aws_config::profile::ProfileFileTokenProvider;
use aws_credential_types::Token;

let provider = TokenProviderChain::first_try("Profile", ProfileFileTokenProvider::builder().build())
    .or_else("Static", Token::new("example", None));

Implementations§

source§

impl TokenProviderChain

source

pub fn first_try( name: impl Into<Cow<'static, str>>, provider: impl ProvideToken + 'static ) -> Self

Create a TokenProviderChain that begins by evaluating this provider

source

pub fn or_else( self, name: impl Into<Cow<'static, str>>, provider: impl ProvideToken + 'static ) -> Self

Add a fallback provider to the token provider chain

source

pub async fn or_default_provider(self) -> Self

Available on crate feature sso only.

Add a fallback to the default provider chain

source

pub async fn default_provider() -> Self

Available on crate feature sso only.

Creates a token provider chain that starts with the default provider

Trait Implementations§

source§

impl Debug for TokenProviderChain

source§

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

Formats the value using the given formatter. Read more
source§

impl ProvideToken for TokenProviderChain

source§

fn provide_token<'a>(&'a self) -> ProvideToken<'_>
where Self: 'a,

Returns a future that provides an access token.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more