Struct aws_config::provider_config::ProviderConfig

source ·
pub struct ProviderConfig { /* private fields */ }
Expand description

Configuration options for Credential Providers

Most credential providers builders offer a configure method which applies general provider configuration options.

To use a region from the default region provider chain use ProviderConfig::with_default_region. Otherwise, use ProviderConfig::without_region. Note that some credentials providers require a region to be explicitly set.

Implementations§

source§

impl ProviderConfig

source

pub fn without_region() -> Self

Create a default provider config with the region unset.

Using this option means that you may need to set a region manually.

This constructor will use a default value for the HTTPS connector and Sleep implementation when they are enabled as crate features which is usually the correct option. To construct a ProviderConfig without these fields set, use ProviderConfig::empty.

§Examples
use aws_config::provider_config::ProviderConfig;
use aws_sdk_sts::config::Region;
use aws_config::web_identity_token::WebIdentityTokenCredentialsProvider;
let conf = ProviderConfig::without_region().with_region(Some(Region::new("us-east-1")));

let credential_provider = WebIdentityTokenCredentialsProvider::builder().configure(&conf).build();
source

pub fn empty() -> Self

Constructs a ProviderConfig with no fields set

source

pub async fn with_default_region() -> Self

Create a default provider config with the region region automatically loaded from the default chain.

§Examples
use aws_config::provider_config::ProviderConfig;
use aws_sdk_sts::config::Region;
use aws_config::web_identity_token::WebIdentityTokenCredentialsProvider;
let conf = ProviderConfig::with_default_region().await;
let credential_provider = WebIdentityTokenCredentialsProvider::builder().configure(&conf).build();
}
source

pub fn with_region(self, region: Option<Region>) -> Self

Override the region for the configuration

source

pub async fn load_default_region(self) -> Self

Use the default region chain to set the region for this configuration

Note: the env and fs already set on this provider will be used when loading the default region.

source

pub fn with_time_source(self, time_source: impl TimeSource + 'static) -> Self

Override the time source for this configuration

source

pub fn with_http_client(self, http_client: impl HttpClient + 'static) -> Self

Override the HTTP client for this configuration

source

pub fn with_sleep_impl(self, sleep_impl: impl AsyncSleep + 'static) -> Self

Override the sleep implementation for this configuration

Trait Implementations§

source§

impl Clone for ProviderConfig

source§

fn clone(&self) -> ProviderConfig

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ProviderConfig

source§

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

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

impl Default for ProviderConfig

source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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