1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#![deny(missing_docs)]
//! AWS Shared Config
//!
//! This module contains an shared configuration representation that is agnostic from a specific service.
use std::sync::Arc;
use aws_smithy_async::rt::sleep::AsyncSleep;
use aws_smithy_types::retry::RetryConfig;
use aws_smithy_types::timeout::TimeoutConfig;
use crate::app_name::AppName;
use crate::credentials::SharedCredentialsProvider;
use crate::region::Region;
/// AWS Shared Configuration
#[derive(Debug)]
pub struct Config {
app_name: Option<AppName>,
credentials_provider: Option<SharedCredentialsProvider>,
region: Option<Region>,
retry_config: Option<RetryConfig>,
sleep_impl: Option<Arc<dyn AsyncSleep>>,
timeout_config: Option<TimeoutConfig>,
}
/// Builder for AWS Shared Configuration
#[derive(Debug, Default)]
pub struct Builder {
app_name: Option<AppName>,
credentials_provider: Option<SharedCredentialsProvider>,
region: Option<Region>,
retry_config: Option<RetryConfig>,
sleep_impl: Option<Arc<dyn AsyncSleep>>,
timeout_config: Option<TimeoutConfig>,
}
impl Builder {
/// Set the region for the builder
///
/// # Examples
/// ```rust
/// use aws_types::config::Config;
/// use aws_types::region::Region;
/// let config = Config::builder().region(Region::new("us-east-1")).build();
/// ```
pub fn region(mut self, region: impl Into<Option<Region>>) -> Self {
self.set_region(region);
self
}
/// Set the region for the builder
///
/// # Examples
/// ```rust
/// fn region_override() -> Option<Region> {
/// // ...
/// # None
/// }
/// use aws_types::config::Config;
/// use aws_types::region::Region;
/// let mut builder = Config::builder();
/// if let Some(region) = region_override() {
/// builder.set_region(region);
/// }
/// let config = builder.build();
/// ```
pub fn set_region(&mut self, region: impl Into<Option<Region>>) -> &mut Self {
self.region = region.into();
self
}
/// Set the retry_config for the builder
///
/// # Examples
/// ```rust
/// use aws_types::config::Config;
/// use aws_smithy_types::retry::RetryConfig;
///
/// let retry_config = RetryConfig::new().with_max_attempts(5);
/// let config = Config::builder().retry_config(retry_config).build();
/// ```
pub fn retry_config(mut self, retry_config: RetryConfig) -> Self {
self.set_retry_config(Some(retry_config));
self
}
/// Set the retry_config for the builder
///
/// # Examples
/// ```rust
/// use aws_types::config::{Config, Builder};
/// use aws_smithy_types::retry::RetryConfig;
///
/// fn disable_retries(builder: &mut Builder) {
/// let retry_config = RetryConfig::new().with_max_attempts(1);
/// builder.set_retry_config(Some(retry_config));
/// }
///
/// let mut builder = Config::builder();
/// disable_retries(&mut builder);
/// let config = builder.build();
/// ```
pub fn set_retry_config(&mut self, retry_config: Option<RetryConfig>) -> &mut Self {
self.retry_config = retry_config;
self
}
/// Set the [`TimeoutConfig`] for the builder
///
/// # Examples
///
/// ```rust
/// # use std::time::Duration;
/// use aws_types::config::Config;
/// use aws_smithy_types::timeout::TimeoutConfig;
///
/// let timeout_config = TimeoutConfig::new()
/// .with_api_call_attempt_timeout(Some(Duration::from_secs(1)));
/// let config = Config::builder().timeout_config(timeout_config).build();
/// ```
pub fn timeout_config(mut self, timeout_config: TimeoutConfig) -> Self {
self.set_timeout_config(Some(timeout_config));
self
}
/// Set the [`TimeoutConfig`] for the builder
///
/// # Examples
/// ```rust
/// # use std::time::Duration;
/// use aws_types::config::{Config, Builder};
/// use aws_smithy_types::timeout::TimeoutConfig;
///
/// fn set_preferred_timeouts(builder: &mut Builder) {
/// let timeout_config = TimeoutConfig::new()
/// .with_api_call_attempt_timeout(Some(Duration::from_secs(2)))
/// .with_api_call_timeout(Some(Duration::from_secs(5)));
/// builder.set_timeout_config(Some(timeout_config));
/// }
///
/// let mut builder = Config::builder();
/// set_preferred_timeouts(&mut builder);
/// let config = builder.build();
/// ```
pub fn set_timeout_config(&mut self, timeout_config: Option<TimeoutConfig>) -> &mut Self {
self.timeout_config = timeout_config;
self
}
#[doc(hidden)]
/// Set the sleep implementation for the builder. The sleep implementation is used to create
/// timeout futures.
///
/// # Examples
///
/// ```rust
/// use std::sync::Arc;
/// use aws_smithy_async::rt::sleep::{AsyncSleep, Sleep};
/// use aws_types::config::Config;
///
/// ##[derive(Debug)]
/// pub struct ForeverSleep;
///
/// impl AsyncSleep for ForeverSleep {
/// fn sleep(&self, duration: std::time::Duration) -> Sleep {
/// Sleep::new(std::future::pending())
/// }
/// }
///
/// let sleep_impl = Arc::new(ForeverSleep);
/// let config = Config::builder().sleep_impl(sleep_impl).build();
/// ```
pub fn sleep_impl(mut self, sleep_impl: Arc<dyn AsyncSleep>) -> Self {
self.set_sleep_impl(Some(sleep_impl));
self
}
#[doc(hidden)]
/// Set the sleep implementation for the builder. The sleep implementation is used to create
/// timeout futures.
///
/// # Examples
/// ```rust
/// # use aws_smithy_async::rt::sleep::{AsyncSleep, Sleep};
/// # use aws_types::config::{Builder, Config};
/// #[derive(Debug)]
/// pub struct ForeverSleep;
///
/// impl AsyncSleep for ForeverSleep {
/// fn sleep(&self, duration: std::time::Duration) -> Sleep {
/// Sleep::new(std::future::pending())
/// }
/// }
///
/// fn set_never_ending_sleep_impl(builder: &mut Builder) {
/// let sleep_impl = std::sync::Arc::new(ForeverSleep);
/// builder.set_sleep_impl(Some(sleep_impl));
/// }
///
/// let mut builder = Config::builder();
/// set_never_ending_sleep_impl(&mut builder);
/// let config = builder.build();
/// ```
pub fn set_sleep_impl(&mut self, sleep_impl: Option<Arc<dyn AsyncSleep>>) -> &mut Self {
self.sleep_impl = sleep_impl;
self
}
/// Set the credentials provider for the builder
///
/// # Examples
/// ```rust
/// use aws_types::credentials::{ProvideCredentials, SharedCredentialsProvider};
/// use aws_types::config::Config;
/// fn make_provider() -> impl ProvideCredentials {
/// // ...
/// # use aws_types::Credentials;
/// # Credentials::new("test", "test", None, None, "example")
/// }
///
/// let config = Config::builder()
/// .credentials_provider(SharedCredentialsProvider::new(make_provider()))
/// .build();
/// ```
pub fn credentials_provider(mut self, provider: SharedCredentialsProvider) -> Self {
self.set_credentials_provider(Some(provider));
self
}
/// Set the credentials provider for the builder
///
/// # Examples
/// ```rust
/// use aws_types::credentials::{ProvideCredentials, SharedCredentialsProvider};
/// use aws_types::config::Config;
/// fn make_provider() -> impl ProvideCredentials {
/// // ...
/// # use aws_types::Credentials;
/// # Credentials::new("test", "test", None, None, "example")
/// }
///
/// fn override_provider() -> bool {
/// // ...
/// # true
/// }
///
/// let mut builder = Config::builder();
/// if override_provider() {
/// builder.set_credentials_provider(Some(SharedCredentialsProvider::new(make_provider())));
/// }
/// let config = builder.build();
/// ```
pub fn set_credentials_provider(
&mut self,
provider: Option<SharedCredentialsProvider>,
) -> &mut Self {
self.credentials_provider = provider;
self
}
/// Sets the name of the app that is using the client.
///
/// This _optional_ name is used to identify the application in the user agent that
/// gets sent along with requests.
pub fn app_name(mut self, app_name: AppName) -> Self {
self.set_app_name(Some(app_name));
self
}
/// Sets the name of the app that is using the client.
///
/// This _optional_ name is used to identify the application in the user agent that
/// gets sent along with requests.
pub fn set_app_name(&mut self, app_name: Option<AppName>) -> &mut Self {
self.app_name = app_name;
self
}
/// Build a [`Config`](Config) from this builder
pub fn build(self) -> Config {
Config {
app_name: self.app_name,
credentials_provider: self.credentials_provider,
region: self.region,
retry_config: self.retry_config,
sleep_impl: self.sleep_impl,
timeout_config: self.timeout_config,
}
}
}
impl Config {
/// Configured region
pub fn region(&self) -> Option<&Region> {
self.region.as_ref()
}
/// Configured retry config
pub fn retry_config(&self) -> Option<&RetryConfig> {
self.retry_config.as_ref()
}
/// Configured timeout config
pub fn timeout_config(&self) -> Option<&TimeoutConfig> {
self.timeout_config.as_ref()
}
#[doc(hidden)]
/// Configured sleep implementation
pub fn sleep_impl(&self) -> Option<Arc<dyn AsyncSleep>> {
self.sleep_impl.clone()
}
/// Configured credentials provider
pub fn credentials_provider(&self) -> Option<&SharedCredentialsProvider> {
self.credentials_provider.as_ref()
}
/// Configured app name
pub fn app_name(&self) -> Option<&AppName> {
self.app_name.as_ref()
}
/// Config builder
pub fn builder() -> Builder {
Builder::default()
}
}