aws_config::profile::token

Struct ProfileFileTokenProvider

Source
pub struct ProfileFileTokenProvider { /* private fields */ }
Expand description

AWS profile-based access token provider

This token provider loads SSO session config from ~/.aws/config, and uses that config to resolve a cached SSO token from ~/.aws/sso/cache. The AWS CLI can be used to establish the cached SSO token.

Generally, this provider is constructed via the default provider chain. However, it can also be manually constructed with the builder:

use aws_config::profile::ProfileFileTokenProvider;
let provider = ProfileFileTokenProvider::builder().build();

Note: this provider, when called, will load and parse the ~/.aws/config file only once. Parsed file contents will be cached indefinitely.

This provider requires a profile with a sso_session configured. For example,

[default]
sso_session = example
region = us-west-2

[sso-session example]
sso_start_url = https://example.awsapps.com/start
sso_region = us-west-2

Implementations§

Source§

impl ProfileFileTokenProvider

Source

pub fn builder() -> Builder

Builder for this token provider.

Trait Implementations§

Source§

impl Debug for ProfileFileTokenProvider

Source§

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

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

impl ProvideToken for ProfileFileTokenProvider

Source§

fn provide_token<'a>(&'a self) -> ProvideToken<'a>
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

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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