aws_sdk_signin/config.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#![allow(clippy::empty_line_after_doc_comments)]
3/// Configuration for a aws_sdk_signin service client.
4///
5/// Service configuration allows for customization of endpoints, region, credentials providers,
6/// and retry configuration. Generally, it is constructed automatically for you from a shared
7/// configuration loaded by the `aws-config` crate. For example:
8///
9/// ```ignore
10/// // Load a shared config from the environment
11/// let shared_config = aws_config::from_env().load().await;
12/// // The client constructor automatically converts the shared config into the service config
13/// let client = Client::new(&shared_config);
14/// ```
15///
16/// The service config can also be constructed manually using its builder.
17///
18#[derive(::std::clone::Clone, ::std::fmt::Debug)]
19pub struct Config {
20 // Both `config` and `cloneable` are the same config, but the cloneable one
21 // is kept around so that it is possible to convert back into a builder. This can be
22 // optimized in the future.
23 pub(crate) config: crate::config::FrozenLayer,
24 cloneable: ::aws_smithy_types::config_bag::CloneableLayer,
25 pub(crate) runtime_components: crate::config::RuntimeComponentsBuilder,
26 pub(crate) runtime_plugins: ::std::vec::Vec<crate::config::SharedRuntimePlugin>,
27 pub(crate) behavior_version: ::std::option::Option<crate::config::BehaviorVersion>,
28}
29impl Config {
30 ///
31 /// Constructs a config builder.
32 /// <div class="warning">
33 /// Note that a config created from this builder will not have the same safe defaults as one created by
34 /// the <a href="https://crates.io/crates/aws-config" target="_blank">aws-config</a> crate.
35 /// </div>
36 ///
37 pub fn builder() -> Builder { Builder::default() }
38 /// Converts this config back into a builder so that it can be tweaked.
39 pub fn to_builder(&self) -> Builder {
40 Builder {
41 config: self.cloneable.clone(),
42 runtime_components: self.runtime_components.clone(),
43 runtime_plugins: self.runtime_plugins.clone(),
44 behavior_version: self.behavior_version,
45 }
46 }
47 /// Return a reference to the stalled stream protection configuration contained in this config, if any.
48 pub fn stalled_stream_protection(&self) -> ::std::option::Option<&crate::config::StalledStreamProtectionConfig> {
49 self.config.load::<crate::config::StalledStreamProtectionConfig>()
50 }
51 /// Return the [`SharedHttpClient`](crate::config::SharedHttpClient) to use when making requests, if any.
52 pub fn http_client(&self) -> Option<crate::config::SharedHttpClient> {
53 self.runtime_components.http_client()
54 }
55 /// Return the auth schemes configured on this service config
56 pub fn auth_schemes(&self) -> impl Iterator<Item = ::aws_smithy_runtime_api::client::auth::SharedAuthScheme> + '_ {
57 self.runtime_components.auth_schemes()
58 }
59
60 /// Return the auth scheme resolver configured on this service config
61 pub fn auth_scheme_resolver(&self) -> ::std::option::Option<::aws_smithy_runtime_api::client::auth::SharedAuthSchemeOptionResolver> {
62 self.runtime_components.auth_scheme_option_resolver()
63 }
64 /// Returns the configured auth scheme preference
65 pub fn auth_scheme_preference(&self) -> ::std::option::Option<&::aws_smithy_runtime_api::client::auth::AuthSchemePreference> {
66 self.config.load::<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>()
67 }
68 /// Returns the endpoint resolver.
69 pub fn endpoint_resolver(&self) -> ::aws_smithy_runtime_api::client::endpoint::SharedEndpointResolver {
70 self.runtime_components.endpoint_resolver().expect("resolver defaulted if not set")
71 }
72 /// Return a reference to the retry configuration contained in this config, if any.
73 pub fn retry_config(&self) -> ::std::option::Option<&::aws_smithy_types::retry::RetryConfig> {
74 self.config.load::<::aws_smithy_types::retry::RetryConfig>()
75 }
76
77 /// Return a cloned shared async sleep implementation from this config, if any.
78 pub fn sleep_impl(&self) -> ::std::option::Option<crate::config::SharedAsyncSleep> {
79 self.runtime_components.sleep_impl()
80 }
81
82 /// Return a reference to the timeout configuration contained in this config, if any.
83 pub fn timeout_config(&self) -> ::std::option::Option<&::aws_smithy_types::timeout::TimeoutConfig> {
84 self.config.load::<::aws_smithy_types::timeout::TimeoutConfig>()
85 }
86
87 /// Returns a reference to the retry partition contained in this config, if any.
88 ///
89 /// WARNING: This method is unstable and may be removed at any time. Do not rely on this
90 /// method for anything!
91 pub fn retry_partition(&self) -> ::std::option::Option<&::aws_smithy_runtime::client::retries::RetryPartition> {
92 self.config.load::<::aws_smithy_runtime::client::retries::RetryPartition>()
93 }
94 /// Returns the configured identity cache for auth.
95 pub fn identity_cache(&self) -> ::std::option::Option<crate::config::SharedIdentityCache> {
96 self.runtime_components.identity_cache()
97 }
98 /// Returns interceptors currently registered by the user.
99 pub fn interceptors(&self) -> impl Iterator<Item = crate::config::SharedInterceptor> + '_ {
100 self.runtime_components.interceptors()
101 }
102 /// Return time source used for this service.
103 pub fn time_source(&self) -> ::std::option::Option<::aws_smithy_async::time::SharedTimeSource> {
104 self.runtime_components.time_source()
105 }
106 /// Returns retry classifiers currently registered by the user.
107 pub fn retry_classifiers(&self) -> impl Iterator<Item = ::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier> + '_ {
108 self.runtime_components.retry_classifiers()
109 }
110 /// Returns the name of the app that is using the client, if it was provided.
111 ///
112 /// This _optional_ name is used to identify the application in the user agent that
113 /// gets sent along with requests.
114 pub fn app_name(&self) -> ::std::option::Option<&::aws_types::app_name::AppName> {
115 self.config.load::<::aws_types::app_name::AppName>()
116 }
117 /// Returns the invocation ID generator if one was given in config.
118 ///
119 /// 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.
120 pub fn invocation_id_generator(&self) -> ::std::option::Option<::aws_runtime::invocation_id::SharedInvocationIdGenerator> {
121 self.config.load::<::aws_runtime::invocation_id::SharedInvocationIdGenerator>().cloned()
122 }
123 /// Creates a new [service config](crate::Config) from a [shared `config`](::aws_types::sdk_config::SdkConfig).
124 pub fn new(config: &::aws_types::sdk_config::SdkConfig) -> Self {
125 Builder::from(config).build()
126 }
127 /// The signature version 4 service signing name to use in the credential scope when signing requests.
128 ///
129 /// The signing service may be overridden by the `Endpoint`, or by specifying a custom
130 /// [`SigningName`](aws_types::SigningName) during operation construction
131 pub fn signing_name(&self) -> &'static str {
132 "signin"
133 }
134 /// Returns the AWS region, if it was provided.
135 pub fn region(&self) -> ::std::option::Option<&crate::config::Region> {
136 self.config.load::<crate::config::Region>()
137 }
138 /// 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.
139 #[deprecated(note = "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.")]
140 pub fn credentials_provider(&self) -> Option<crate::config::SharedCredentialsProvider> {
141 ::std::option::Option::None
142 }
143}
144/// Builder for creating a `Config`.
145#[derive(::std::clone::Clone, ::std::fmt::Debug)]
146pub struct Builder {
147 pub(crate) config: ::aws_smithy_types::config_bag::CloneableLayer,
148 pub(crate) runtime_components: crate::config::RuntimeComponentsBuilder,
149 pub(crate) runtime_plugins: ::std::vec::Vec<crate::config::SharedRuntimePlugin>,
150 pub(crate) behavior_version: ::std::option::Option<crate::config::BehaviorVersion>,
151}
152impl ::std::default::Default for Builder {
153 fn default() -> Self {
154 Self {
155 config: ::std::default::Default::default(),
156 runtime_components: crate::config::RuntimeComponentsBuilder::new("service config"),
157 runtime_plugins: ::std::default::Default::default(),
158 behavior_version: ::std::default::Default::default(),
159 }
160 }
161}
162impl Builder {
163 ///
164 /// Constructs a config builder.
165 /// <div class="warning">
166 /// Note that a config created from this builder will not have the same safe defaults as one created by
167 /// the <a href="https://crates.io/crates/aws-config" target="_blank">aws-config</a> crate.
168 /// </div>
169 ///
170 pub fn new() -> Self { Self::default() }
171 /// Constructs a config builder from the given `config_bag`, setting only fields stored in the config bag,
172 /// but not those in runtime components.
173 #[allow(unused)]
174 pub(crate) fn from_config_bag(config_bag: &::aws_smithy_types::config_bag::ConfigBag) -> Self {
175 let mut builder = Self::new();
176 builder.set_stalled_stream_protection(config_bag.load::<crate::config::StalledStreamProtectionConfig>().cloned());
177 builder.set_auth_scheme_preference(config_bag.load::<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>().cloned());
178 builder.set_retry_config(config_bag.load::<::aws_smithy_types::retry::RetryConfig>().cloned());
179 builder.set_timeout_config(config_bag.load::<::aws_smithy_types::timeout::TimeoutConfig>().cloned());
180 builder.set_retry_partition(config_bag.load::<::aws_smithy_runtime::client::retries::RetryPartition>().cloned());
181 builder.set_app_name(config_bag.load::<::aws_types::app_name::AppName>().cloned());
182 builder.set_endpoint_url(config_bag.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()));
183 builder.set_use_dual_stack(config_bag.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0));
184 builder.set_use_fips(config_bag.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0));
185 builder.set_region(config_bag.load::<crate::config::Region>().cloned());
186 builder
187 }
188 /// Set the [`StalledStreamProtectionConfig`](crate::config::StalledStreamProtectionConfig)
189 /// to configure protection for stalled streams.
190 pub fn stalled_stream_protection(
191 mut self,
192 stalled_stream_protection_config: crate::config::StalledStreamProtectionConfig
193 ) -> Self {
194 self.set_stalled_stream_protection(::std::option::Option::Some(stalled_stream_protection_config));
195 self
196 }
197 /// Set the [`StalledStreamProtectionConfig`](crate::config::StalledStreamProtectionConfig)
198 /// to configure protection for stalled streams.
199 pub fn set_stalled_stream_protection(
200 &mut self,
201 stalled_stream_protection_config: ::std::option::Option<crate::config::StalledStreamProtectionConfig>
202 ) -> &mut Self {
203 self.config.store_or_unset(stalled_stream_protection_config);
204 self
205 }
206 /// Sets the HTTP client to use when making requests.
207 ///
208 /// # Examples
209 /// ```no_run
210 /// # #[cfg(test)]
211 /// # mod tests {
212 /// # #[test]
213 /// # fn example() {
214 /// use std::time::Duration;
215 /// use aws_sdk_signin::config::Config;
216 /// use aws_smithy_runtime::client::http::hyper_014::HyperClientBuilder;
217 ///
218 /// let https_connector = hyper_rustls::HttpsConnectorBuilder::new()
219 /// .with_webpki_roots()
220 /// .https_only()
221 /// .enable_http1()
222 /// .enable_http2()
223 /// .build();
224 /// let hyper_client = HyperClientBuilder::new().build(https_connector);
225 ///
226 /// // This connector can then be given to a generated service Config
227 /// let config = my_service_client::Config::builder()
228 /// .endpoint_url("https://example.com")
229 /// .http_client(hyper_client)
230 /// .build();
231 /// let client = my_service_client::Client::from_conf(config);
232 /// # }
233 /// # }
234 /// ```
235 pub fn http_client(mut self, http_client: impl crate::config::HttpClient + 'static) -> Self {
236 self.set_http_client(::std::option::Option::Some(crate::config::IntoShared::into_shared(http_client)));
237 self
238 }
239
240 /// Sets the HTTP client to use when making requests.
241 ///
242 /// # Examples
243 /// ```no_run
244 /// # #[cfg(test)]
245 /// # mod tests {
246 /// # #[test]
247 /// # fn example() {
248 /// use std::time::Duration;
249 /// use aws_sdk_signin::config::{Builder, Config};
250 /// use aws_smithy_runtime::client::http::hyper_014::HyperClientBuilder;
251 ///
252 /// fn override_http_client(builder: &mut Builder) {
253 /// let https_connector = hyper_rustls::HttpsConnectorBuilder::new()
254 /// .with_webpki_roots()
255 /// .https_only()
256 /// .enable_http1()
257 /// .enable_http2()
258 /// .build();
259 /// let hyper_client = HyperClientBuilder::new().build(https_connector);
260 /// builder.set_http_client(Some(hyper_client));
261 /// }
262 ///
263 /// let mut builder = aws_sdk_signin::Config::builder();
264 /// override_http_client(&mut builder);
265 /// let config = builder.build();
266 /// # }
267 /// # }
268 /// ```
269 pub fn set_http_client(&mut self, http_client: Option<crate::config::SharedHttpClient>) -> &mut Self {
270 self.runtime_components.set_http_client(http_client);
271 self
272 }
273 /// Adds an auth scheme to the builder
274 ///
275 /// If `auth_scheme` has an existing [AuthSchemeId](aws_smithy_runtime_api::client::auth::AuthSchemeId) in the runtime, the current identity
276 /// resolver and signer for that scheme will be replaced by those from `auth_scheme`.
277 ///
278 /// _Important:_ When introducing a custom auth scheme, ensure you override either
279 /// [`Self::auth_scheme_resolver`] or [`Self::set_auth_scheme_resolver`]
280 /// so that the custom auth scheme is included in the list of resolved auth scheme options.
281 /// [The default auth scheme resolver](crate::config::auth::DefaultAuthSchemeResolver) will not recognize your custom auth scheme.
282 ///
283 /// # Examples
284 /// ```no_run
285 /// # use aws_smithy_runtime_api::{
286 /// # box_error::BoxError,
287 /// # client::{
288 /// # auth::{
289 /// # AuthScheme, AuthSchemeEndpointConfig, AuthSchemeId, AuthSchemeOption,
290 /// # AuthSchemeOptionsFuture, Sign,
291 /// # },
292 /// # identity::{Identity, IdentityFuture, ResolveIdentity, SharedIdentityResolver},
293 /// # orchestrator::HttpRequest,
294 /// # runtime_components::{GetIdentityResolver, RuntimeComponents},
295 /// # },
296 /// # shared::IntoShared,
297 /// # };
298 /// # use aws_smithy_types::config_bag::ConfigBag;
299 /// // Auth scheme with customer identity resolver and signer
300 /// #[derive(Debug)]
301 /// struct CustomAuthScheme {
302 /// id: AuthSchemeId,
303 /// identity_resolver: SharedIdentityResolver,
304 /// signer: CustomSigner,
305 /// }
306 /// impl Default for CustomAuthScheme {
307 /// fn default() -> Self {
308 /// Self {
309 /// id: AuthSchemeId::new("custom"),
310 /// identity_resolver: CustomIdentityResolver.into_shared(),
311 /// signer: CustomSigner,
312 /// }
313 /// }
314 /// }
315 /// impl AuthScheme for CustomAuthScheme {
316 /// fn scheme_id(&self) -> AuthSchemeId {
317 /// self.id.clone()
318 /// }
319 /// fn identity_resolver(
320 /// &self,
321 /// _identity_resolvers: &dyn GetIdentityResolver,
322 /// ) -> Option<SharedIdentityResolver> {
323 /// Some(self.identity_resolver.clone())
324 /// }
325 /// fn signer(&self) -> &dyn Sign {
326 /// &self.signer
327 /// }
328 /// }
329 ///
330 /// #[derive(Debug, Default)]
331 /// struct CustomSigner;
332 /// impl Sign for CustomSigner {
333 /// fn sign_http_request(
334 /// &self,
335 /// _request: &mut HttpRequest,
336 /// _identity: &Identity,
337 /// _auth_scheme_endpoint_config: AuthSchemeEndpointConfig<'_>,
338 /// _runtime_components: &RuntimeComponents,
339 /// _config_bag: &ConfigBag,
340 /// ) -> Result<(), BoxError> {
341 /// // --snip--
342 /// # todo!()
343 /// }
344 /// }
345 ///
346 /// #[derive(Debug)]
347 /// struct CustomIdentityResolver;
348 /// impl ResolveIdentity for CustomIdentityResolver {
349 /// fn resolve_identity<'a>(
350 /// &'a self,
351 /// _runtime_components: &'a RuntimeComponents,
352 /// _config_bag: &'a ConfigBag,
353 /// ) -> IdentityFuture<'a> {
354 /// // --snip--
355 /// # todo!()
356 /// }
357 /// }
358 ///
359 /// // Auth scheme resolver that favors `CustomAuthScheme`
360 /// #[derive(Debug)]
361 /// struct CustomAuthSchemeResolver;
362 /// impl aws_sdk_signin::config::auth::ResolveAuthScheme for CustomAuthSchemeResolver {
363 /// fn resolve_auth_scheme<'a>(
364 /// &'a self,
365 /// _params: &'a aws_sdk_signin::config::auth::Params,
366 /// _cfg: &'a ConfigBag,
367 /// _runtime_components: &'a RuntimeComponents,
368 /// ) -> AuthSchemeOptionsFuture<'a> {
369 /// AuthSchemeOptionsFuture::ready(Ok(vec![AuthSchemeOption::from(AuthSchemeId::new(
370 /// "custom",
371 /// ))]))
372 /// }
373 /// }
374 ///
375 /// let config = aws_sdk_signin::Config::builder()
376 /// .push_auth_scheme(CustomAuthScheme::default())
377 /// .auth_scheme_resolver(CustomAuthSchemeResolver)
378 /// // other configurations
379 /// .build();
380 /// ```
381 pub fn push_auth_scheme(mut self, auth_scheme: impl ::aws_smithy_runtime_api::client::auth::AuthScheme + 'static) -> Self {
382 self.runtime_components.push_auth_scheme(auth_scheme);
383 self
384 }
385
386 /// Set the auth scheme resolver for the builder
387 ///
388 /// # Examples
389 /// ```no_run
390 /// # use aws_smithy_runtime_api::{
391 /// # client::{
392 /// # auth::AuthSchemeOptionsFuture,
393 /// # runtime_components::RuntimeComponents,
394 /// # },
395 /// # };
396 /// # use aws_smithy_types::config_bag::ConfigBag;
397 /// #[derive(Debug)]
398 /// struct CustomAuthSchemeResolver;
399 /// impl aws_sdk_signin::config::auth::ResolveAuthScheme for CustomAuthSchemeResolver {
400 /// fn resolve_auth_scheme<'a>(
401 /// &'a self,
402 /// _params: &'a aws_sdk_signin::config::auth::Params,
403 /// _cfg: &'a ConfigBag,
404 /// _runtime_components: &'a RuntimeComponents,
405 /// ) -> AuthSchemeOptionsFuture<'a> {
406 /// // --snip--
407 /// # todo!()
408 /// }
409 /// }
410 ///
411 /// let config = aws_sdk_signin::Config::builder()
412 /// .auth_scheme_resolver(CustomAuthSchemeResolver)
413 /// // other configurations
414 /// .build();
415 /// ```
416 pub fn auth_scheme_resolver(mut self, auth_scheme_resolver: impl crate::config::auth::ResolveAuthScheme + 'static) -> Self {
417 self.set_auth_scheme_resolver(auth_scheme_resolver);
418 self
419 }
420
421 /// Set the auth scheme resolver for the builder
422 ///
423 /// # Examples
424 /// See an example for [`Self::auth_scheme_resolver`].
425 pub fn set_auth_scheme_resolver(&mut self, auth_scheme_resolver: impl crate::config::auth::ResolveAuthScheme + 'static) -> &mut Self {
426 self.runtime_components.set_auth_scheme_option_resolver(::std::option::Option::Some(auth_scheme_resolver.into_shared_resolver()));
427 self
428 }
429
430 /// Add [NoAuthScheme](aws_smithy_runtime::client::auth::no_auth::NoAuthScheme) as a fallback for operations that don't require authentication
431 ///
432 /// The auth scheme resolver will use this when no other auth schemes are applicable.
433 pub fn allow_no_auth(mut self) -> Self {
434 self.set_allow_no_auth();
435 self
436 }
437
438 /// Add [NoAuthScheme](aws_smithy_runtime::client::auth::no_auth::NoAuthScheme) as a fallback for operations that don't require authentication
439 ///
440 /// The auth scheme resolver will use this when no other auth schemes are applicable.
441 pub fn set_allow_no_auth(&mut self) -> &mut Self {
442 self.push_runtime_plugin(::aws_smithy_runtime::client::auth::no_auth::NoAuthRuntimePluginV2::new().into_shared());
443 self
444 }
445 /// Set the auth scheme preference for an auth scheme resolver
446 /// (typically the default auth scheme resolver).
447 ///
448 /// Each operation has a predefined order of auth schemes, as determined by the service,
449 /// for auth scheme resolution. By using the auth scheme preference, customers
450 /// can reorder the schemes resolved by the auth scheme resolver.
451 ///
452 /// The preference list is intended as a hint rather than a strict override.
453 /// Any schemes not present in the originally resolved auth schemes will be ignored.
454 ///
455 /// # Examples
456 ///
457 /// ```no_run
458 /// # use aws_smithy_runtime_api::client::auth::AuthSchemeId;
459 /// let config = aws_sdk_signin::Config::builder()
460 /// .auth_scheme_preference([AuthSchemeId::from("scheme1"), AuthSchemeId::from("scheme2")])
461 /// // ...
462 /// .build();
463 /// let client = aws_sdk_signin::Client::from_conf(config);
464 /// ```
465
466 pub fn auth_scheme_preference(mut self, preference: impl ::std::convert::Into<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>) -> Self {
467 self.set_auth_scheme_preference(::std::option::Option::Some(preference.into()));
468 self
469 }
470
471
472 /// Set the auth scheme preference for an auth scheme resolver
473 /// (typically the default auth scheme resolver).
474 ///
475 /// Each operation has a predefined order of auth schemes, as determined by the service,
476 /// for auth scheme resolution. By using the auth scheme preference, customers
477 /// can reorder the schemes resolved by the auth scheme resolver.
478 ///
479 /// The preference list is intended as a hint rather than a strict override.
480 /// Any schemes not present in the originally resolved auth schemes will be ignored.
481 ///
482 /// # Examples
483 ///
484 /// ```no_run
485 /// # use aws_smithy_runtime_api::client::auth::AuthSchemeId;
486 /// let config = aws_sdk_signin::Config::builder()
487 /// .auth_scheme_preference([AuthSchemeId::from("scheme1"), AuthSchemeId::from("scheme2")])
488 /// // ...
489 /// .build();
490 /// let client = aws_sdk_signin::Client::from_conf(config);
491 /// ```
492
493 pub fn set_auth_scheme_preference(&mut self, preference: ::std::option::Option<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>) -> &mut Self {
494 self.config.store_or_unset(preference);
495 self
496 }
497 /// Sets the endpoint resolver to use when making requests.
498 ///
499 ///
500 /// When unset, the client will used a generated endpoint resolver based on the endpoint resolution
501 /// rules for `aws_sdk_signin`.
502 ///
503 ///
504 /// Note: setting an endpoint resolver will replace any endpoint URL that has been set.
505 /// This method accepts an endpoint resolver [specific to this service](crate::config::endpoint::ResolveEndpoint). If you want to
506 /// provide a shared endpoint resolver, use [`Self::set_endpoint_resolver`].
507 ///
508 /// # Examples
509 /// Create a custom endpoint resolver that resolves a different endpoing per-stage, e.g. staging vs. production.
510 /// ```no_run
511 /// use aws_sdk_signin::config::endpoint::{ResolveEndpoint, EndpointFuture, Params, Endpoint};
512 /// #[derive(Debug)]
513 /// struct StageResolver { stage: String }
514 /// impl ResolveEndpoint for StageResolver {
515 /// fn resolve_endpoint(&self, params: &Params) -> EndpointFuture<'_> {
516 /// let stage = &self.stage;
517 /// EndpointFuture::ready(Ok(Endpoint::builder().url(format!("{stage}.myservice.com")).build()))
518 /// }
519 /// }
520 /// let resolver = StageResolver { stage: std::env::var("STAGE").unwrap() };
521 /// let config = aws_sdk_signin::Config::builder().endpoint_resolver(resolver).build();
522 /// let client = aws_sdk_signin::Client::from_conf(config);
523 /// ```
524 pub fn endpoint_resolver(mut self, endpoint_resolver: impl crate::config::endpoint::ResolveEndpoint + 'static) -> Self {
525 self.set_endpoint_resolver(::std::option::Option::Some(endpoint_resolver.into_shared_resolver()));
526 self
527 }
528
529 /// Sets the endpoint resolver to use when making requests.
530 ///
531 ///
532 /// When unset, the client will used a generated endpoint resolver based on the endpoint resolution
533 /// rules for `aws_sdk_signin`.
534 ///
535 pub fn set_endpoint_resolver(&mut self, endpoint_resolver: ::std::option::Option<::aws_smithy_runtime_api::client::endpoint::SharedEndpointResolver>) -> &mut Self {
536 self.runtime_components.set_endpoint_resolver(endpoint_resolver);
537 self
538 }
539 /// Set the retry_config for the builder
540 ///
541 /// # Examples
542 /// ```no_run
543 /// use aws_sdk_signin::config::Config;
544 /// use aws_sdk_signin::config::retry::RetryConfig;
545 ///
546 /// let retry_config = RetryConfig::standard().with_max_attempts(5);
547 /// let config = Config::builder().retry_config(retry_config).build();
548 /// ```
549 pub fn retry_config(mut self, retry_config: ::aws_smithy_types::retry::RetryConfig) -> Self {
550 self.set_retry_config(Some(retry_config));
551 self
552 }
553
554 /// Set the retry_config for the builder
555 ///
556 /// # Examples
557 /// ```no_run
558 /// use aws_sdk_signin::config::{Builder, Config};
559 /// use aws_sdk_signin::config::retry::RetryConfig;
560 ///
561 /// fn disable_retries(builder: &mut Builder) {
562 /// let retry_config = RetryConfig::standard().with_max_attempts(1);
563 /// builder.set_retry_config(Some(retry_config));
564 /// }
565 ///
566 /// let mut builder = Config::builder();
567 /// disable_retries(&mut builder);
568 /// let config = builder.build();
569 /// ```
570 pub fn set_retry_config(&mut self, retry_config: ::std::option::Option<::aws_smithy_types::retry::RetryConfig>) -> &mut Self {
571 retry_config.map(|r| self.config.store_put(r));
572 self
573 }
574 /// Set the sleep_impl for the builder
575 ///
576 /// # Examples
577 ///
578 /// ```no_run
579 /// use aws_sdk_signin::config::{AsyncSleep, Config, SharedAsyncSleep, Sleep};
580 ///
581 /// #[derive(Debug)]
582 /// pub struct ForeverSleep;
583 ///
584 /// impl AsyncSleep for ForeverSleep {
585 /// fn sleep(&self, duration: std::time::Duration) -> Sleep {
586 /// Sleep::new(std::future::pending())
587 /// }
588 /// }
589 ///
590 /// let sleep_impl = SharedAsyncSleep::new(ForeverSleep);
591 /// let config = Config::builder().sleep_impl(sleep_impl).build();
592 /// ```
593 pub fn sleep_impl(mut self, sleep_impl: impl crate::config::AsyncSleep + 'static) -> Self {
594 self.set_sleep_impl(Some(::aws_smithy_runtime_api::shared::IntoShared::into_shared(sleep_impl)));
595 self
596 }
597
598 /// Set the sleep_impl for the builder
599 ///
600 /// # Examples
601 ///
602 /// ```no_run
603 /// use aws_sdk_signin::config::{AsyncSleep, Builder, Config, SharedAsyncSleep, Sleep};
604 ///
605 /// #[derive(Debug)]
606 /// pub struct ForeverSleep;
607 ///
608 /// impl AsyncSleep for ForeverSleep {
609 /// fn sleep(&self, duration: std::time::Duration) -> Sleep {
610 /// Sleep::new(std::future::pending())
611 /// }
612 /// }
613 ///
614 /// fn set_never_ending_sleep_impl(builder: &mut Builder) {
615 /// let sleep_impl = SharedAsyncSleep::new(ForeverSleep);
616 /// builder.set_sleep_impl(Some(sleep_impl));
617 /// }
618 ///
619 /// let mut builder = Config::builder();
620 /// set_never_ending_sleep_impl(&mut builder);
621 /// let config = builder.build();
622 /// ```
623 pub fn set_sleep_impl(&mut self, sleep_impl: ::std::option::Option<crate::config::SharedAsyncSleep>) -> &mut Self {
624 self.runtime_components.set_sleep_impl(sleep_impl);
625 self
626 }
627 /// Set the timeout_config for the builder
628 ///
629 /// # Examples
630 ///
631 /// ```no_run
632 /// # use std::time::Duration;
633 /// use aws_sdk_signin::config::Config;
634 /// use aws_sdk_signin::config::timeout::TimeoutConfig;
635 ///
636 /// let timeout_config = TimeoutConfig::builder()
637 /// .operation_attempt_timeout(Duration::from_secs(1))
638 /// .build();
639 /// let config = Config::builder().timeout_config(timeout_config).build();
640 /// ```
641 pub fn timeout_config(mut self, timeout_config: ::aws_smithy_types::timeout::TimeoutConfig) -> Self {
642 self.set_timeout_config(Some(timeout_config));
643 self
644 }
645
646 /// Set the timeout_config for the builder.
647 ///
648 /// Setting this to `None` has no effect if another source of configuration has set timeouts. If you
649 /// are attempting to disable timeouts, use [`TimeoutConfig::disabled`](::aws_smithy_types::timeout::TimeoutConfig::disabled)
650 ///
651 ///
652 /// # Examples
653 ///
654 /// ```no_run
655 /// # use std::time::Duration;
656 /// use aws_sdk_signin::config::{Builder, Config};
657 /// use aws_sdk_signin::config::timeout::TimeoutConfig;
658 ///
659 /// fn set_request_timeout(builder: &mut Builder) {
660 /// let timeout_config = TimeoutConfig::builder()
661 /// .operation_attempt_timeout(Duration::from_secs(1))
662 /// .build();
663 /// builder.set_timeout_config(Some(timeout_config));
664 /// }
665 ///
666 /// let mut builder = Config::builder();
667 /// set_request_timeout(&mut builder);
668 /// let config = builder.build();
669 /// ```
670 pub fn set_timeout_config(&mut self, timeout_config: ::std::option::Option<::aws_smithy_types::timeout::TimeoutConfig>) -> &mut Self {
671 // passing None has no impact.
672 let Some(mut timeout_config) = timeout_config else {
673 return self
674 };
675
676 if let Some(base) = self.config.load::<::aws_smithy_types::timeout::TimeoutConfig>() {
677 timeout_config.take_defaults_from(base);
678 }
679 self.config.store_put(timeout_config);
680 self
681 }
682 /// Set the partition for retry-related state. When clients share a retry partition, they will
683 /// also share components such as token buckets and client rate limiters.
684 /// See the [`RetryPartition`](::aws_smithy_runtime::client::retries::RetryPartition) documentation for more details.
685 ///
686 /// # Default Behavior
687 ///
688 /// When no retry partition is explicitly set, the SDK automatically creates a default retry partition named `signin`
689 /// (or `signin-<region>` if a region is configured).
690 /// All Signin clients without an explicit retry partition will share this default partition.
691 ///
692 /// # Notes
693 ///
694 /// - This is an advanced setting — most users won't need to modify it.
695 /// - A configured client rate limiter has no effect unless [`RetryConfig::adaptive`](::aws_smithy_types::retry::RetryConfig::adaptive) is used.
696 ///
697 /// # Examples
698 ///
699 /// Creating a custom retry partition with a token bucket:
700 /// ```no_run
701 /// use aws_sdk_signin::config::Config;
702 /// use aws_sdk_signin::config::retry::{RetryPartition, TokenBucket};
703 ///
704 /// let token_bucket = TokenBucket::new(10);
705 /// let config = Config::builder()
706 /// .retry_partition(RetryPartition::custom("custom")
707 /// .token_bucket(token_bucket)
708 /// .build()
709 /// )
710 /// .build();
711 /// ```
712 ///
713 /// Configuring a client rate limiter with adaptive retry mode:
714 /// ```no_run
715 /// use aws_sdk_signin::config::Config;
716 /// use aws_sdk_signin::config::retry::{ClientRateLimiter, RetryConfig, RetryPartition};
717 ///
718 /// let client_rate_limiter = ClientRateLimiter::new(10.0);
719 /// let config = Config::builder()
720 /// .retry_partition(RetryPartition::custom("custom")
721 /// .client_rate_limiter(client_rate_limiter)
722 /// .build()
723 /// )
724 /// .retry_config(RetryConfig::adaptive())
725 /// .build();
726 /// ```
727 pub fn retry_partition(mut self, retry_partition: ::aws_smithy_runtime::client::retries::RetryPartition) -> Self {
728 self.set_retry_partition(Some(retry_partition));
729 self
730 }
731 /// Like [`Self::retry_partition`], but takes a mutable reference to the builder and an optional `RetryPartition`
732 pub fn set_retry_partition(&mut self, retry_partition: ::std::option::Option<::aws_smithy_runtime::client::retries::RetryPartition>) -> &mut Self {
733 retry_partition.map(|r| self.config.store_put(r));
734 self
735 }
736 /// Set the identity cache for auth.
737 ///
738 /// The identity cache defaults to a lazy caching implementation that will resolve
739 /// an identity when it is requested, and place it in the cache thereafter. Subsequent
740 /// requests will take the value from the cache while it is still valid. Once it expires,
741 /// the next request will result in refreshing the identity.
742 ///
743 /// This configuration allows you to disable or change the default caching mechanism.
744 /// To use a custom caching mechanism, implement the [`ResolveCachedIdentity`](crate::config::ResolveCachedIdentity)
745 /// trait and pass that implementation into this function.
746 ///
747 /// # Examples
748 ///
749 /// Disabling identity caching:
750 /// ```no_run
751 /// use aws_sdk_signin::config::IdentityCache;
752 ///
753 /// let config = aws_sdk_signin::Config::builder()
754 /// .identity_cache(IdentityCache::no_cache())
755 /// // ...
756 /// .build();
757 /// let client = aws_sdk_signin::Client::from_conf(config);
758 /// ```
759 ///
760 /// Customizing lazy caching:
761 /// ```no_run
762 /// use aws_sdk_signin::config::IdentityCache;
763 /// use std::time::Duration;
764 ///
765 /// let config = aws_sdk_signin::Config::builder()
766 /// .identity_cache(
767 /// IdentityCache::lazy()
768 /// // change the load timeout to 10 seconds
769 /// .load_timeout(Duration::from_secs(10))
770 /// .build()
771 /// )
772 /// // ...
773 /// .build();
774 /// let client = aws_sdk_signin::Client::from_conf(config);
775 /// ```
776 ///
777 pub fn identity_cache(mut self, identity_cache: impl crate::config::ResolveCachedIdentity + 'static) -> Self {
778 self.set_identity_cache(identity_cache);
779 self
780 }
781
782
783 /// Set the identity cache for auth.
784 ///
785 /// The identity cache defaults to a lazy caching implementation that will resolve
786 /// an identity when it is requested, and place it in the cache thereafter. Subsequent
787 /// requests will take the value from the cache while it is still valid. Once it expires,
788 /// the next request will result in refreshing the identity.
789 ///
790 /// This configuration allows you to disable or change the default caching mechanism.
791 /// To use a custom caching mechanism, implement the [`ResolveCachedIdentity`](crate::config::ResolveCachedIdentity)
792 /// trait and pass that implementation into this function.
793 ///
794 /// # Examples
795 ///
796 /// Disabling identity caching:
797 /// ```no_run
798 /// use aws_sdk_signin::config::IdentityCache;
799 ///
800 /// let config = aws_sdk_signin::Config::builder()
801 /// .identity_cache(IdentityCache::no_cache())
802 /// // ...
803 /// .build();
804 /// let client = aws_sdk_signin::Client::from_conf(config);
805 /// ```
806 ///
807 /// Customizing lazy caching:
808 /// ```no_run
809 /// use aws_sdk_signin::config::IdentityCache;
810 /// use std::time::Duration;
811 ///
812 /// let config = aws_sdk_signin::Config::builder()
813 /// .identity_cache(
814 /// IdentityCache::lazy()
815 /// // change the load timeout to 10 seconds
816 /// .load_timeout(Duration::from_secs(10))
817 /// .build()
818 /// )
819 /// // ...
820 /// .build();
821 /// let client = aws_sdk_signin::Client::from_conf(config);
822 /// ```
823 ///
824 pub fn set_identity_cache(&mut self, identity_cache: impl crate::config::ResolveCachedIdentity + 'static) -> &mut Self {
825 self.runtime_components.set_identity_cache(::std::option::Option::Some(identity_cache));
826 self
827 }
828 /// Add an [interceptor](crate::config::Intercept) that runs at specific stages of the request execution pipeline.
829 ///
830 /// Interceptors targeted at a certain stage are executed according to the pre-defined priority.
831 /// The SDK provides a default set of interceptors. An interceptor configured by this method
832 /// will run after those default interceptors.
833 ///
834 /// # Examples
835 /// ```no_run
836 /// # fn example() {
837 /// use aws_smithy_runtime_api::box_error::BoxError;
838 /// use aws_smithy_runtime_api::client::interceptors::context::BeforeTransmitInterceptorContextMut;
839 /// use aws_smithy_runtime_api::client::interceptors::Intercept;
840 /// use aws_smithy_runtime_api::client::runtime_components::RuntimeComponents;
841 /// use aws_smithy_types::config_bag::ConfigBag;
842 /// use aws_sdk_signin::config::Config;
843 /// use ::http::uri::Uri;
844 ///
845 /// fn base_url() -> String {
846 /// // ...
847 /// # String::new()
848 /// }
849 ///
850 /// #[derive(Debug)]
851 /// pub struct UriModifierInterceptor;
852 /// impl Intercept for UriModifierInterceptor {
853 /// fn name(&self) -> &'static str {
854 /// "UriModifierInterceptor"
855 /// }
856 /// fn modify_before_signing(
857 /// &self,
858 /// context: &mut BeforeTransmitInterceptorContextMut<'_>,
859 /// _runtime_components: &RuntimeComponents,
860 /// _cfg: &mut ConfigBag,
861 /// ) -> Result<(), BoxError> {
862 /// let request = context.request_mut();
863 /// let uri = format!("{}{}", base_url(), request.uri());
864 /// *request.uri_mut() = uri.parse::<Uri>()?.into();
865 ///
866 /// Ok(())
867 /// }
868 /// }
869 ///
870 /// let config = Config::builder()
871 /// .interceptor(UriModifierInterceptor)
872 /// .build();
873 /// # }
874 /// ```
875 pub fn interceptor(mut self, interceptor: impl crate::config::Intercept + 'static) -> Self {
876 self.push_interceptor(crate::config::SharedInterceptor::new(interceptor));
877 self
878 }
879
880 /// Like [`Self::interceptor`], but takes a [`SharedInterceptor`](crate::config::SharedInterceptor).
881 pub fn push_interceptor(&mut self, interceptor: crate::config::SharedInterceptor) -> &mut Self {
882 self.runtime_components.push_interceptor(interceptor);
883 self
884 }
885
886 /// Set [`SharedInterceptor`](crate::config::SharedInterceptor)s for the builder.
887 pub fn set_interceptors(&mut self, interceptors: impl IntoIterator<Item = crate::config::SharedInterceptor>) -> &mut Self {
888 self.runtime_components.set_interceptors(interceptors.into_iter());
889 self
890 }
891 /// Sets the time source used for this service
892 pub fn time_source(
893 mut self,
894 time_source: impl ::aws_smithy_async::time::TimeSource + 'static,
895 ) -> Self {
896 self.set_time_source(::std::option::Option::Some(::aws_smithy_runtime_api::shared::IntoShared::into_shared(time_source)));
897 self
898 }
899 /// Sets the time source used for this service
900 pub fn set_time_source(
901 &mut self,
902 time_source: ::std::option::Option<::aws_smithy_async::time::SharedTimeSource>,
903 ) -> &mut Self {
904 self.runtime_components.set_time_source(time_source);
905 self
906 }
907 /// Add type implementing [`ClassifyRetry`](::aws_smithy_runtime_api::client::retries::classifiers::ClassifyRetry) that will be used by the
908 /// [`RetryStrategy`](::aws_smithy_runtime_api::client::retries::RetryStrategy) to determine what responses should be retried.
909 ///
910 /// A retry classifier configured by this method will run according to its [priority](::aws_smithy_runtime_api::client::retries::classifiers::RetryClassifierPriority).
911 ///
912 /// # Examples
913 /// ```no_run
914 /// # fn example() {
915 /// use aws_smithy_runtime_api::client::interceptors::context::InterceptorContext;
916 /// use aws_smithy_runtime_api::client::orchestrator::OrchestratorError;
917 /// use aws_smithy_runtime_api::client::retries::classifiers::{
918 /// ClassifyRetry, RetryAction, RetryClassifierPriority,
919 /// };
920 /// use aws_smithy_types::error::metadata::ProvideErrorMetadata;
921 /// use aws_smithy_types::retry::ErrorKind;
922 /// use std::error::Error as StdError;
923 /// use std::marker::PhantomData;
924 /// use std::fmt;
925 /// use aws_sdk_signin::config::Config;
926 /// # #[derive(Debug)]
927 /// # struct SomeOperationError {}
928 /// # impl StdError for SomeOperationError {}
929 /// # impl fmt::Display for SomeOperationError {
930 /// # fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { todo!() }
931 /// # }
932 /// # impl ProvideErrorMetadata for SomeOperationError {
933 /// # fn meta(&self) -> &aws_sdk_signin::error::ErrorMetadata { todo!() }
934 /// # }
935 ///
936 /// const RETRYABLE_ERROR_CODES: &[&str] = &[
937 /// // List error codes to be retried here...
938 /// ];
939 ///
940 /// // When classifying at an operation's error type, classifiers require a generic parameter.
941 /// // When classifying the HTTP response alone, no generic is needed.
942 /// #[derive(Debug, Default)]
943 /// pub struct ExampleErrorCodeClassifier<E> {
944 /// _inner: PhantomData<E>,
945 /// }
946 ///
947 /// impl<E> ExampleErrorCodeClassifier<E> {
948 /// pub fn new() -> Self {
949 /// Self {
950 /// _inner: PhantomData,
951 /// }
952 /// }
953 /// }
954 ///
955 /// impl<E> ClassifyRetry for ExampleErrorCodeClassifier<E>
956 /// where
957 /// // Adding a trait bound for ProvideErrorMetadata allows us to inspect the error code.
958 /// E: StdError + ProvideErrorMetadata + Send + Sync + 'static,
959 /// {
960 /// fn classify_retry(&self, ctx: &InterceptorContext) -> RetryAction {
961 /// // Check for a result
962 /// let output_or_error = ctx.output_or_error();
963 /// // Check for an error
964 /// let error = match output_or_error {
965 /// Some(Ok(_)) | None => return RetryAction::NoActionIndicated,
966 /// Some(Err(err)) => err,
967 /// };
968 ///
969 /// // Downcast the generic error and extract the code
970 /// let error_code = OrchestratorError::as_operation_error(error)
971 /// .and_then(|err| err.downcast_ref::<E>())
972 /// .and_then(|err| err.code());
973 ///
974 /// // If this error's code is in our list, return an action that tells the RetryStrategy to retry this request.
975 /// if let Some(error_code) = error_code {
976 /// if RETRYABLE_ERROR_CODES.contains(&error_code) {
977 /// return RetryAction::transient_error();
978 /// }
979 /// }
980 ///
981 /// // Otherwise, return that no action is indicated i.e. that this classifier doesn't require a retry.
982 /// // Another classifier may still classify this response as retryable.
983 /// RetryAction::NoActionIndicated
984 /// }
985 ///
986 /// fn name(&self) -> &'static str { "Example Error Code Classifier" }
987 /// }
988 ///
989 /// let config = Config::builder()
990 /// .retry_classifier(ExampleErrorCodeClassifier::<SomeOperationError>::new())
991 /// .build();
992 /// # }
993 /// ```
994 pub fn retry_classifier(mut self, retry_classifier: impl ::aws_smithy_runtime_api::client::retries::classifiers::ClassifyRetry + 'static) -> Self {
995 self.push_retry_classifier(::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier::new(retry_classifier));
996 self
997 }
998
999 /// Like [`Self::retry_classifier`], but takes a [`SharedRetryClassifier`](::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier).
1000 pub fn push_retry_classifier(&mut self, retry_classifier: ::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier) -> &mut Self {
1001 self.runtime_components.push_retry_classifier(retry_classifier);
1002 self
1003 }
1004
1005 /// Set [`SharedRetryClassifier`](::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier)s for the builder, replacing any that
1006 /// were previously set.
1007 pub fn set_retry_classifiers(&mut self, retry_classifiers: impl IntoIterator<Item = ::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier>) -> &mut Self {
1008 self.runtime_components.set_retry_classifiers(retry_classifiers.into_iter());
1009 self
1010 }
1011 /// Sets the name of the app that is using the client.
1012 ///
1013 /// This _optional_ name is used to identify the application in the user agent that
1014 /// gets sent along with requests.
1015 pub fn app_name(mut self, app_name: ::aws_types::app_name::AppName) -> Self {
1016 self.set_app_name(Some(app_name));
1017 self
1018 }
1019 /// Sets the name of the app that is using the client.
1020 ///
1021 /// This _optional_ name is used to identify the application in the user agent that
1022 /// gets sent along with requests.
1023 pub fn set_app_name(&mut self, app_name: ::std::option::Option<::aws_types::app_name::AppName>) -> &mut Self {
1024 self.config.store_or_unset(app_name);
1025 self
1026 }
1027 /// Overrides the default invocation ID generator.
1028 ///
1029 /// 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.
1030 pub fn invocation_id_generator(mut self, gen: impl ::aws_runtime::invocation_id::InvocationIdGenerator + 'static) -> Self {
1031 self.set_invocation_id_generator(::std::option::Option::Some(::aws_runtime::invocation_id::SharedInvocationIdGenerator::new(gen)));
1032 self
1033 }
1034 /// Overrides the default invocation ID generator.
1035 ///
1036 /// 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.
1037 pub fn set_invocation_id_generator(&mut self, gen: ::std::option::Option<::aws_runtime::invocation_id::SharedInvocationIdGenerator>) -> &mut Self {
1038 self.config.store_or_unset(gen);
1039 self
1040 }
1041 /// Sets the endpoint URL used to communicate with this service.
1042 ///
1043 /// Note: this is used in combination with other endpoint rules, e.g. an API that applies a host-label prefix
1044 /// will be prefixed onto this URL. To fully override the endpoint resolver, use
1045 /// [`Builder::endpoint_resolver`].
1046 pub fn endpoint_url(mut self, endpoint_url: impl Into<::std::string::String>) -> Self {
1047 self.set_endpoint_url(Some(endpoint_url.into()));
1048 self
1049 }
1050 /// Sets the endpoint URL used to communicate with this service.
1051 ///
1052 /// Note: this is used in combination with other endpoint rules, e.g. an API that applies a host-label prefix
1053 /// will be prefixed onto this URL. To fully override the endpoint resolver, use
1054 /// [`Builder::endpoint_resolver`].
1055 pub fn set_endpoint_url(&mut self, endpoint_url: Option<::std::string::String>) -> &mut Self {
1056 self.config.store_or_unset(endpoint_url.map(::aws_types::endpoint_config::EndpointUrl));
1057 self
1058 }
1059 /// When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
1060 pub fn use_dual_stack(mut self, use_dual_stack: impl Into<bool>) -> Self {
1061 self.set_use_dual_stack(Some(use_dual_stack.into()));
1062 self
1063 }
1064 /// When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
1065 pub fn set_use_dual_stack(&mut self, use_dual_stack: Option<bool>) -> &mut Self {
1066 self.config.store_or_unset(use_dual_stack.map(::aws_types::endpoint_config::UseDualStack));
1067 self
1068 }
1069 /// When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
1070 pub fn use_fips(mut self, use_fips: impl Into<bool>) -> Self {
1071 self.set_use_fips(Some(use_fips.into()));
1072 self
1073 }
1074 /// When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
1075 pub fn set_use_fips(&mut self, use_fips: Option<bool>) -> &mut Self {
1076 self.config.store_or_unset(use_fips.map(::aws_types::endpoint_config::UseFips));
1077 self
1078 }
1079 /// Sets the AWS region to use when making requests.
1080 ///
1081 /// # Examples
1082 /// ```no_run
1083 /// use aws_types::region::Region;
1084 /// use aws_sdk_signin::config::{Builder, Config};
1085 ///
1086 /// let config = aws_sdk_signin::Config::builder()
1087 /// .region(Region::new("us-east-1"))
1088 /// .build();
1089 /// ```
1090 pub fn region(mut self, region: impl ::std::convert::Into<::std::option::Option<crate::config::Region>>) -> Self {
1091 self.set_region(region.into());
1092 self
1093 }
1094 /// Sets the AWS region to use when making requests.
1095 pub fn set_region(&mut self, region: ::std::option::Option<crate::config::Region>) -> &mut Self {
1096 self.config.store_or_unset(region);
1097 self
1098 }
1099 /// Sets the credentials provider for this service
1100 pub fn credentials_provider(mut self, credentials_provider: impl crate::config::ProvideCredentials + 'static) -> Self {
1101 self.set_credentials_provider(::std::option::Option::Some(crate::config::SharedCredentialsProvider::new(credentials_provider)));
1102 self
1103 }
1104 /// Sets the credentials provider for this service
1105 pub fn set_credentials_provider(&mut self, credentials_provider: ::std::option::Option<crate::config::SharedCredentialsProvider>) -> &mut Self {
1106 if let Some(credentials_provider) = credentials_provider {
1107 self.runtime_components.set_identity_resolver(::aws_runtime::auth::sigv4::SCHEME_ID, credentials_provider);
1108 }
1109 self
1110 }
1111 /// Sets the [`behavior major version`](crate::config::BehaviorVersion).
1112 ///
1113 /// Over time, new best-practice behaviors are introduced. However, these behaviors might not be backwards
1114 /// compatible. For example, a change which introduces new default timeouts or a new retry-mode for
1115 /// all operations might be the ideal behavior but could break existing applications.
1116 ///
1117 /// # Examples
1118 ///
1119 /// Set the behavior major version to `latest`. This is equivalent to enabling the `behavior-version-latest` cargo feature.
1120 /// ```no_run
1121 /// use aws_sdk_signin::config::BehaviorVersion;
1122 ///
1123 /// let config = aws_sdk_signin::Config::builder()
1124 /// .behavior_version(BehaviorVersion::latest())
1125 /// // ...
1126 /// .build();
1127 /// let client = aws_sdk_signin::Client::from_conf(config);
1128 /// ```
1129 ///
1130 /// Customizing behavior major version:
1131 /// ```no_run
1132 /// use aws_sdk_signin::config::BehaviorVersion;
1133 ///
1134 /// let config = aws_sdk_signin::Config::builder()
1135 /// .behavior_version(BehaviorVersion::v2023_11_09())
1136 /// // ...
1137 /// .build();
1138 /// let client = aws_sdk_signin::Client::from_conf(config);
1139 /// ```
1140 ///
1141 pub fn behavior_version(mut self, behavior_version: crate::config::BehaviorVersion) -> Self {
1142 self.set_behavior_version(Some(behavior_version));
1143 self
1144 }
1145
1146
1147 /// Sets the [`behavior major version`](crate::config::BehaviorVersion).
1148 ///
1149 /// Over time, new best-practice behaviors are introduced. However, these behaviors might not be backwards
1150 /// compatible. For example, a change which introduces new default timeouts or a new retry-mode for
1151 /// all operations might be the ideal behavior but could break existing applications.
1152 ///
1153 /// # Examples
1154 ///
1155 /// Set the behavior major version to `latest`. This is equivalent to enabling the `behavior-version-latest` cargo feature.
1156 /// ```no_run
1157 /// use aws_sdk_signin::config::BehaviorVersion;
1158 ///
1159 /// let config = aws_sdk_signin::Config::builder()
1160 /// .behavior_version(BehaviorVersion::latest())
1161 /// // ...
1162 /// .build();
1163 /// let client = aws_sdk_signin::Client::from_conf(config);
1164 /// ```
1165 ///
1166 /// Customizing behavior major version:
1167 /// ```no_run
1168 /// use aws_sdk_signin::config::BehaviorVersion;
1169 ///
1170 /// let config = aws_sdk_signin::Config::builder()
1171 /// .behavior_version(BehaviorVersion::v2023_11_09())
1172 /// // ...
1173 /// .build();
1174 /// let client = aws_sdk_signin::Client::from_conf(config);
1175 /// ```
1176 ///
1177 pub fn set_behavior_version(&mut self, behavior_version: Option<crate::config::BehaviorVersion>) -> &mut Self {
1178 self.behavior_version = behavior_version;
1179 self
1180 }
1181
1182 /// Convenience method to set the latest behavior major version
1183 ///
1184 /// This is equivalent to enabling the `behavior-version-latest` Cargo feature
1185 pub fn behavior_version_latest(mut self) -> Self {
1186 self.set_behavior_version(Some(crate::config::BehaviorVersion::latest()));
1187 self
1188 }
1189 /// Adds a runtime plugin to the config.
1190 #[allow(unused)]
1191 pub(crate) fn runtime_plugin(mut self, plugin: impl crate::config::RuntimePlugin + 'static) -> Self {
1192 self.push_runtime_plugin(crate::config::SharedRuntimePlugin::new(plugin));
1193 self
1194 }
1195 /// Adds a runtime plugin to the config.
1196 #[allow(unused)]
1197 pub(crate) fn push_runtime_plugin(&mut self, plugin: crate::config::SharedRuntimePlugin) -> &mut Self {
1198 self.runtime_plugins.push(plugin);
1199 self
1200 }
1201 #[cfg(any(feature = "test-util", test))]
1202 #[allow(unused_mut)]
1203 /// Apply test defaults to the builder. NOTE: Consider migrating to use `apply_test_defaults_v2` instead.
1204 pub fn apply_test_defaults(&mut self) -> &mut Self {
1205 self
1206 .set_time_source(::std::option::Option::Some(::aws_smithy_async::time::SharedTimeSource::new(
1207 ::aws_smithy_async::time::StaticTimeSource::new(::std::time::UNIX_EPOCH + ::std::time::Duration::from_secs(1234567890)))
1208 ));
1209 self.config.store_put(::aws_runtime::user_agent::AwsUserAgent::for_tests());
1210 self.set_credentials_provider(Some(crate::config::SharedCredentialsProvider::new(::aws_credential_types::Credentials::for_tests())));
1211 self.behavior_version = ::std::option::Option::Some(crate::config::BehaviorVersion::latest());
1212 self
1213 }
1214 #[cfg(any(feature = "test-util", test))]
1215 #[allow(unused_mut)]
1216 /// Apply test defaults to the builder. NOTE: Consider migrating to use `with_test_defaults_v2` instead.
1217 pub fn with_test_defaults(mut self) -> Self {
1218 self.apply_test_defaults(); self
1219 }
1220 #[cfg(any(feature = "test-util", test))]
1221 #[allow(unused_mut)]
1222 /// Apply test defaults to the builder. V2 of this function sets additional test defaults such as region configuration (if applicable).
1223 pub fn apply_test_defaults_v2(&mut self) -> &mut Self {
1224 self.apply_test_defaults();
1225 if self.config.load::<crate::config::Region>().is_none() {
1226 self.set_region(::std::option::Option::Some(crate::config::Region::new("us-east-1")));
1227 }
1228 self
1229 }
1230 #[cfg(any(feature = "test-util", test))]
1231 #[allow(unused_mut)]
1232 /// Apply test defaults to the builder. V2 of this function sets additional test defaults such as region configuration (if applicable).
1233 pub fn with_test_defaults_v2(mut self) -> Self {
1234 self.apply_test_defaults_v2(); self
1235 }
1236 /// Builds a [`Config`].
1237 #[allow(unused_mut)]
1238 pub fn build(mut self) -> Config {
1239 let mut layer = self.config;
1240 if self.runtime_components.time_source().is_none() {
1241 self.runtime_components.set_time_source(::std::option::Option::Some(::std::default::Default::default()));
1242 }
1243 layer.store_put(crate::meta::API_METADATA.clone());
1244 layer.store_put(::aws_types::SigningName::from_static("signin"));
1245 layer.load::<::aws_types::region::Region>().cloned().map(|r| layer.store_put(::aws_types::region::SigningRegion::from(r)));
1246 Config {
1247 config: crate::config::Layer::from(layer.clone()).with_name("aws_sdk_signin::config::Config").freeze(),
1248 cloneable: layer,
1249 runtime_components: self.runtime_components,
1250 runtime_plugins: self.runtime_plugins,
1251 behavior_version: self.behavior_version,
1252 }
1253 }
1254}
1255#[derive(::std::fmt::Debug)]
1256 pub(crate) struct ServiceRuntimePlugin {
1257 config: ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer>,
1258 runtime_components: ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1259 }
1260
1261 impl ServiceRuntimePlugin {
1262 pub fn new(_service_config: crate::config::Config) -> Self {
1263 let config = { let mut cfg = ::aws_smithy_types::config_bag::Layer::new("Signin");
1264 cfg.store_put(::aws_smithy_runtime::client::orchestrator::AuthSchemeAndEndpointOrchestrationV2);
1265 ::std::option::Option::Some(cfg.freeze()) };
1266 let mut runtime_components = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ServiceRuntimePlugin");
1267 runtime_components.set_auth_scheme_option_resolver(::std::option::Option::Some({
1268 use crate::config::auth::ResolveAuthScheme;
1269 crate::config::auth::DefaultAuthSchemeResolver::default().into_shared_resolver()
1270 }));
1271runtime_components.set_endpoint_resolver(::std::option::Option::Some({
1272 use crate::config::endpoint::ResolveEndpoint;
1273 crate::config::endpoint::DefaultResolver::new().into_shared_resolver()
1274 }));
1275runtime_components.push_interceptor(::aws_smithy_runtime::client::http::connection_poisoning::ConnectionPoisoningInterceptor::new());
1276runtime_components.push_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::HttpStatusCodeClassifier::default());
1277runtime_components.push_interceptor(crate::sdk_feature_tracker::retry_mode::RetryModeFeatureTrackerInterceptor::new());
1278runtime_components.push_interceptor(::aws_runtime::service_clock_skew::ServiceClockSkewInterceptor::new());
1279runtime_components.push_interceptor(::aws_runtime::request_info::RequestInfoInterceptor::new());
1280runtime_components.push_interceptor(::aws_runtime::user_agent::UserAgentInterceptor::new());
1281runtime_components.push_interceptor(::aws_runtime::invocation_id::InvocationIdInterceptor::new());
1282runtime_components.push_interceptor(::aws_runtime::recursion_detection::RecursionDetectionInterceptor::new());
1283runtime_components.push_auth_scheme(::aws_smithy_runtime_api::client::auth::SharedAuthScheme::new(::aws_runtime::auth::sigv4::SigV4AuthScheme::new()));
1284runtime_components.push_interceptor(crate::config::endpoint::EndpointOverrideFeatureTrackerInterceptor);
1285 Self { config, runtime_components }
1286 }
1287 }
1288
1289 impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ServiceRuntimePlugin {
1290 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
1291 self.config.clone()
1292 }
1293
1294 fn order(&self) -> ::aws_smithy_runtime_api::client::runtime_plugin::Order {
1295 ::aws_smithy_runtime_api::client::runtime_plugin::Order::Defaults
1296 }
1297
1298 fn runtime_components(&self, _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
1299 ::std::borrow::Cow::Borrowed(&self.runtime_components)
1300 }
1301 }
1302
1303 // Cross-operation shared-state singletons
1304
1305/// A plugin that enables configuration for a single operation invocation
1306 ///
1307 /// The `config` method will return a `FrozenLayer` by storing values from `config_override`.
1308 /// In the case of default values requested, they will be obtained from `client_config`.
1309 #[derive(Debug)]
1310 pub(crate) struct ConfigOverrideRuntimePlugin {
1311 pub(crate) config: ::aws_smithy_types::config_bag::FrozenLayer,
1312 pub(crate) components: ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1313 }
1314
1315 impl ConfigOverrideRuntimePlugin {
1316 #[allow(dead_code)] // unused when a service does not provide any operations
1317 pub(crate) fn new(
1318 config_override: Builder,
1319 initial_config: ::aws_smithy_types::config_bag::FrozenLayer,
1320 initial_components: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder
1321 ) -> Self {
1322 let mut layer = config_override.config;
1323 let mut components = config_override.runtime_components;
1324 #[allow(unused_mut)]
1325 let mut resolver = ::aws_smithy_runtime::client::config_override::Resolver::overrid(initial_config, initial_components, &mut layer, &mut components);
1326
1327 resolver.config_mut()
1328 .load::<::aws_types::region::Region>()
1329 .cloned()
1330 .map(|r| resolver.config_mut().store_put(::aws_types::region::SigningRegion::from(r)));
1331
1332 let _ = resolver;
1333 Self {
1334 config: ::aws_smithy_types::config_bag::Layer::from(layer)
1335 .with_name("aws_sdk_signin::config::ConfigOverrideRuntimePlugin").freeze(),
1336 components,
1337 }
1338 }
1339 }
1340
1341 impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ConfigOverrideRuntimePlugin {
1342 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
1343 Some(self.config.clone())
1344 }
1345
1346 fn runtime_components(&self, _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
1347 ::std::borrow::Cow::Borrowed(&self.components)
1348 }
1349 }
1350
1351pub use ::aws_smithy_types::config_bag::ConfigBag;
1352 pub use ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents;
1353 pub use ::aws_smithy_runtime::client::identity::IdentityCache;
1354
1355pub use ::aws_credential_types::Credentials;
1356
1357impl From<&::aws_types::sdk_config::SdkConfig> for Builder {
1358 fn from(input: &::aws_types::sdk_config::SdkConfig) -> Self {
1359 let mut builder = Builder::default();
1360 builder.set_credentials_provider(input.credentials_provider());
1361builder =
1362 builder.region(input.region().cloned());
1363builder.set_use_fips(input.use_fips());
1364builder.set_use_dual_stack(input.use_dual_stack());
1365if input.get_origin("endpoint_url").is_client_config() {
1366 builder.set_endpoint_url(input.endpoint_url().map(|s|s.to_string()));
1367 } else {
1368 builder.set_endpoint_url(
1369 input
1370 .service_config()
1371 .and_then(|conf| conf.load_config(service_config_key("Signin", "AWS_ENDPOINT_URL", "endpoint_url")).map(|it| it.parse().unwrap()))
1372 .or_else(|| input.endpoint_url().map(|s|s.to_string()))
1373 );
1374 }
1375// resiliency
1376 builder.set_retry_config(input.retry_config().cloned());
1377 builder.set_timeout_config(input.timeout_config().cloned());
1378 builder.set_sleep_impl(input.sleep_impl());
1379
1380 builder.set_http_client(input.http_client());
1381 builder.set_time_source(input.time_source());
1382 builder.set_behavior_version(input.behavior_version());
1383 builder.set_auth_scheme_preference(input.auth_scheme_preference().cloned());
1384 // setting `None` here removes the default
1385 if let Some(config) = input.stalled_stream_protection() {
1386 builder.set_stalled_stream_protection(Some(config));
1387 }
1388
1389 if let Some(cache) = input.identity_cache() {
1390 builder.set_identity_cache(cache);
1391 }
1392builder.set_app_name(input.app_name().cloned());
1393
1394 builder
1395 }
1396 }
1397
1398 impl From<&::aws_types::sdk_config::SdkConfig> for Config {
1399 fn from(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
1400 Builder::from(sdk_config).build()
1401 }
1402 }
1403
1404pub use ::aws_types::app_name::AppName;
1405
1406#[allow(dead_code)]
1407fn service_config_key<'a>(
1408 service_id: &'a str,
1409 env: &'a str,
1410 profile: &'a str,
1411 ) -> aws_types::service_config::ServiceConfigKey<'a> {
1412 ::aws_types::service_config::ServiceConfigKey::builder()
1413 .service_id(service_id)
1414 .env(env)
1415 .profile(profile)
1416 .build()
1417 .expect("all field sets explicitly, can't fail")
1418 }
1419
1420pub use ::aws_smithy_async::rt::sleep::{Sleep};
1421
1422pub(crate) fn base_client_runtime_plugins(
1423 mut config: crate::Config,
1424 ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
1425 let mut configured_plugins = ::std::vec::Vec::new();
1426 ::std::mem::swap(&mut config.runtime_plugins, &mut configured_plugins);
1427 #[cfg(feature = "behavior-version-latest")] {
1428 if config.behavior_version.is_none() {
1429 config.behavior_version = Some(::aws_smithy_runtime_api::client::behavior_version::BehaviorVersion::latest());
1430 }
1431}
1432
1433 let default_retry_partition = "signin";
1434 let default_retry_partition = match config.region() {
1435 Some(region) => ::std::borrow::Cow::from(format!("{default_retry_partition}-{region}")),
1436 None => ::std::borrow::Cow::from(default_retry_partition),
1437 };
1438
1439 let scope = "aws-sdk-signin";
1440
1441 #[allow(deprecated)]
1442 let mut plugins = ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins::new()
1443 // defaults
1444 .with_client_plugins(::aws_smithy_runtime::client::defaults::default_plugins(
1445 ::aws_smithy_runtime::client::defaults::DefaultPluginParams::new()
1446 .with_retry_partition_name(default_retry_partition)
1447 .with_behavior_version(config.behavior_version.expect("Invalid client configuration: A behavior major version must be set when sending a request or constructing a client. You must set it during client construction or by enabling the `behavior-version-latest` cargo feature."))
1448 ))
1449 // user config
1450 .with_client_plugin(
1451 ::aws_smithy_runtime_api::client::runtime_plugin::StaticRuntimePlugin::new()
1452 .with_config(config.config.clone())
1453 .with_runtime_components(config.runtime_components.clone())
1454 )
1455 // codegen config
1456 .with_client_plugin(crate::config::ServiceRuntimePlugin::new(config.clone()))
1457 .with_client_plugin(::aws_smithy_runtime::client::auth::no_auth::NoAuthRuntimePlugin::new())
1458 .with_client_plugin(
1459 ::aws_smithy_runtime::client::metrics::MetricsRuntimePlugin::builder()
1460 .with_scope(scope)
1461 .with_time_source(config.runtime_components.time_source().unwrap_or_default())
1462 .build()
1463 .expect("All required fields have been set")
1464 );
1465
1466
1467
1468 for plugin in configured_plugins {
1469 plugins = plugins.with_client_plugin(plugin);
1470 }
1471 plugins
1472 }
1473
1474pub use ::aws_smithy_types::config_bag::FrozenLayer;
1475
1476pub use ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder;
1477
1478pub use ::aws_smithy_runtime_api::client::runtime_plugin::SharedRuntimePlugin;
1479
1480pub use ::aws_smithy_runtime_api::client::behavior_version::BehaviorVersion;
1481
1482pub use ::aws_smithy_runtime_api::client::stalled_stream_protection::StalledStreamProtectionConfig;
1483
1484pub use ::aws_smithy_runtime_api::client::http::SharedHttpClient;
1485
1486pub use ::aws_smithy_async::rt::sleep::SharedAsyncSleep;
1487
1488pub use ::aws_smithy_runtime_api::client::identity::SharedIdentityCache;
1489
1490pub use ::aws_smithy_runtime_api::client::interceptors::SharedInterceptor;
1491
1492pub use ::aws_types::region::Region;
1493
1494pub use ::aws_credential_types::provider::SharedCredentialsProvider;
1495
1496pub use ::aws_smithy_runtime_api::client::http::HttpClient;
1497
1498pub use ::aws_smithy_runtime_api::shared::IntoShared;
1499
1500pub use ::aws_smithy_async::rt::sleep::AsyncSleep;
1501
1502pub use ::aws_smithy_runtime_api::client::identity::ResolveCachedIdentity;
1503
1504pub use ::aws_smithy_runtime_api::client::interceptors::Intercept;
1505
1506pub use ::aws_credential_types::provider::ProvideCredentials;
1507
1508pub use ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin;
1509
1510pub use ::aws_smithy_types::config_bag::Layer;
1511
1512/// Types needed to configure endpoint resolution.
1513pub mod endpoint;
1514
1515/// HTTP request and response types.
1516pub mod http;
1517
1518/// Types needed to implement [`Intercept`](crate::config::Intercept).
1519pub mod interceptors;
1520
1521/// Retry configuration.
1522pub mod retry;
1523
1524/// Timeout configuration.
1525pub mod timeout;
1526
1527/// Types needed to configure auth scheme resolution.
1528pub mod auth;
1529