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

Configuration for a aws_sdk_cognitoidentity service client.

Service configuration allows for customization of endpoints, region, credentials providers, and retry configuration. Generally, it is constructed automatically for you from a shared configuration loaded by the aws-config crate. For example:

// Load a shared config from the environment
let shared_config = aws_config::from_env().load().await;
// The client constructor automatically converts the shared config into the service config
let client = Client::new(&shared_config);

The service config can also be constructed manually using its builder.

Implementations§

source§

impl Config

source

pub fn builder() -> Builder

Constructs a config builder.

source

pub fn to_builder(&self) -> Builder

Converts this config back into a builder so that it can be tweaked.

source

pub fn stalled_stream_protection( &self ) -> Option<&StalledStreamProtectionConfig>

Return a reference to the stalled stream protection configuration contained in this config, if any.

source

pub fn http_client(&self) -> Option<SharedHttpClient>

Return the SharedHttpClient to use when making requests, if any.

source

pub fn endpoint_resolver(&self) -> SharedEndpointResolver

Returns the endpoint resolver.

source

pub fn retry_config(&self) -> Option<&RetryConfig>

Return a reference to the retry configuration contained in this config, if any.

source

pub fn sleep_impl(&self) -> Option<SharedAsyncSleep>

Return a cloned shared async sleep implementation from this config, if any.

source

pub fn timeout_config(&self) -> Option<&TimeoutConfig>

Return a reference to the timeout configuration contained in this config, if any.

source

pub fn retry_partition(&self) -> Option<&RetryPartition>

Returns a reference to the retry partition contained in this config, if any.

WARNING: This method is unstable and may be removed at any time. Do not rely on this method for anything!

source

pub fn identity_cache(&self) -> Option<SharedIdentityCache>

Returns the configured identity cache for auth.

source

pub fn interceptors(&self) -> impl Iterator<Item = SharedInterceptor> + '_

Returns interceptors currently registered by the user.

source

pub fn time_source(&self) -> Option<SharedTimeSource>

Return time source used for this service.

source

pub fn retry_classifiers( &self ) -> impl Iterator<Item = SharedRetryClassifier> + '_

Returns retry classifiers currently registered by the user.

source

pub fn app_name(&self) -> Option<&AppName>

Returns the name of the app that is using the client, if it was provided.

This optional name is used to identify the application in the user agent that gets sent along with requests.

source

pub fn invocation_id_generator(&self) -> Option<SharedInvocationIdGenerator>

Returns the invocation ID generator if one was given in config.

The invocation ID generator generates ID values for the amz-sdk-invocation-id header. By default, this will be a random UUID. Overriding it may be useful in tests that examine the HTTP request and need to be deterministic.

source

pub fn new(config: &SdkConfig) -> Self

Creates a new service config from a shared config.

source

pub fn signing_name(&self) -> &'static str

The signature version 4 service signing name to use in the credential scope when signing requests.

The signing service may be overridden by the Endpoint, or by specifying a custom SigningName during operation construction

source

pub fn region(&self) -> Option<&Region>

Returns the AWS region, if it was provided.

source

pub fn credentials_provider(&self) -> Option<SharedCredentialsProvider>

👎Deprecated: This function was intended to be removed, and has been broken since release-2023-11-15 as it always returns a None. Do not use.

This function was intended to be removed, and has been broken since release-2023-11-15 as it always returns a None. Do not use.

Trait Implementations§

source§

impl Clone for Config

source§

fn clone(&self) -> Config

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 Config

source§

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

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

impl From<&SdkConfig> for Config

source§

fn from(sdk_config: &SdkConfig) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Config

§

impl !RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl !UnwindSafe for Config

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