Struct Config

pub struct Config { /* private fields */ }

Configuration for a aws_sdk_kms 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

impl Config

pub fn builder() -> Builder

Constructs a config builder.

pub fn to_builder(&self) -> Builder

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

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

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

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

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

pub fn endpoint_resolver(&self) -> SharedEndpointResolver

Returns the endpoint resolver.

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

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

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

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

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

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

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!

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

Returns the configured identity cache for auth.

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

Returns interceptors currently registered by the user.

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

Return time source used for this service.

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

Returns retry classifiers currently registered by the user.

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.

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.

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

Creates a new service config from a shared config.

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

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

Returns the AWS region, if it was provided.

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

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl From<&SdkConfig> for Config

fn from(sdk_config: &SdkConfig) -> Self

Converts to this type from the input type.