aws_sdk_ssooidc/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_ssooidc 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 "sso-oauth"
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_ssooidc::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_ssooidc::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_ssooidc::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_ssooidc::config::auth::ResolveAuthScheme for CustomAuthSchemeResolver {
363 /// fn resolve_auth_scheme<'a>(
364 /// &'a self,
365 /// _params: &'a aws_sdk_ssooidc::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_ssooidc::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_ssooidc::config::auth::ResolveAuthScheme for CustomAuthSchemeResolver {
400 /// fn resolve_auth_scheme<'a>(
401 /// &'a self,
402 /// _params: &'a aws_sdk_ssooidc::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_ssooidc::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 /// Enable no authentication regardless of what authentication mechanisms operations support
431 ///
432 /// This adds [NoAuthScheme](aws_smithy_runtime::client::auth::no_auth::NoAuthScheme) as a fallback
433 /// and the auth scheme resolver will use it when no other auth schemes are applicable.
434 pub fn allow_no_auth(mut self) -> Self {
435 self.set_allow_no_auth();
436 self
437 }
438
439 /// Enable no authentication regardless of what authentication mechanisms operations support
440 ///
441 /// This adds [NoAuthScheme](aws_smithy_runtime::client::auth::no_auth::NoAuthScheme) as a fallback
442 /// and the auth scheme resolver will use it when no other auth schemes are applicable.
443 pub fn set_allow_no_auth(&mut self) -> &mut Self {
444 self.push_runtime_plugin(::aws_smithy_runtime::client::auth::no_auth::NoAuthRuntimePluginV2::new().into_shared());
445 self
446 }
447 /// Set the auth scheme preference for an auth scheme resolver
448 /// (typically the default auth scheme resolver).
449 ///
450 /// Each operation has a predefined order of auth schemes, as determined by the service,
451 /// for auth scheme resolution. By using the auth scheme preference, customers
452 /// can reorder the schemes resolved by the auth scheme resolver.
453 ///
454 /// The preference list is intended as a hint rather than a strict override.
455 /// Any schemes not present in the originally resolved auth schemes will be ignored.
456 ///
457 /// # Examples
458 ///
459 /// ```no_run
460 /// # use aws_smithy_runtime_api::client::auth::AuthSchemeId;
461 /// let config = aws_sdk_ssooidc::Config::builder()
462 /// .auth_scheme_preference([AuthSchemeId::from("scheme1"), AuthSchemeId::from("scheme2")])
463 /// // ...
464 /// .build();
465 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
466 /// ```
467
468 pub fn auth_scheme_preference(mut self, preference: impl ::std::convert::Into<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>) -> Self {
469 self.set_auth_scheme_preference(::std::option::Option::Some(preference.into()));
470 self
471 }
472
473
474 /// Set the auth scheme preference for an auth scheme resolver
475 /// (typically the default auth scheme resolver).
476 ///
477 /// Each operation has a predefined order of auth schemes, as determined by the service,
478 /// for auth scheme resolution. By using the auth scheme preference, customers
479 /// can reorder the schemes resolved by the auth scheme resolver.
480 ///
481 /// The preference list is intended as a hint rather than a strict override.
482 /// Any schemes not present in the originally resolved auth schemes will be ignored.
483 ///
484 /// # Examples
485 ///
486 /// ```no_run
487 /// # use aws_smithy_runtime_api::client::auth::AuthSchemeId;
488 /// let config = aws_sdk_ssooidc::Config::builder()
489 /// .auth_scheme_preference([AuthSchemeId::from("scheme1"), AuthSchemeId::from("scheme2")])
490 /// // ...
491 /// .build();
492 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
493 /// ```
494
495 pub fn set_auth_scheme_preference(&mut self, preference: ::std::option::Option<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>) -> &mut Self {
496 self.config.store_or_unset(preference);
497 self
498 }
499 /// Sets the endpoint resolver to use when making requests.
500 ///
501 ///
502 /// When unset, the client will used a generated endpoint resolver based on the endpoint resolution
503 /// rules for `aws_sdk_ssooidc`.
504 ///
505 ///
506 /// Note: setting an endpoint resolver will replace any endpoint URL that has been set.
507 /// This method accepts an endpoint resolver [specific to this service](crate::config::endpoint::ResolveEndpoint). If you want to
508 /// provide a shared endpoint resolver, use [`Self::set_endpoint_resolver`].
509 ///
510 /// # Examples
511 /// Create a custom endpoint resolver that resolves a different endpoing per-stage, e.g. staging vs. production.
512 /// ```no_run
513 /// use aws_sdk_ssooidc::config::endpoint::{ResolveEndpoint, EndpointFuture, Params, Endpoint};
514 /// #[derive(Debug)]
515 /// struct StageResolver { stage: String }
516 /// impl ResolveEndpoint for StageResolver {
517 /// fn resolve_endpoint(&self, params: &Params) -> EndpointFuture<'_> {
518 /// let stage = &self.stage;
519 /// EndpointFuture::ready(Ok(Endpoint::builder().url(format!("{stage}.myservice.com")).build()))
520 /// }
521 /// }
522 /// let resolver = StageResolver { stage: std::env::var("STAGE").unwrap() };
523 /// let config = aws_sdk_ssooidc::Config::builder().endpoint_resolver(resolver).build();
524 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
525 /// ```
526 pub fn endpoint_resolver(mut self, endpoint_resolver: impl crate::config::endpoint::ResolveEndpoint + 'static) -> Self {
527 self.set_endpoint_resolver(::std::option::Option::Some(endpoint_resolver.into_shared_resolver()));
528 self
529 }
530
531 /// Sets the endpoint resolver to use when making requests.
532 ///
533 ///
534 /// When unset, the client will used a generated endpoint resolver based on the endpoint resolution
535 /// rules for `aws_sdk_ssooidc`.
536 ///
537 pub fn set_endpoint_resolver(&mut self, endpoint_resolver: ::std::option::Option<::aws_smithy_runtime_api::client::endpoint::SharedEndpointResolver>) -> &mut Self {
538 self.runtime_components.set_endpoint_resolver(endpoint_resolver);
539 self
540 }
541 /// Set the retry_config for the builder
542 ///
543 /// # Examples
544 /// ```no_run
545 /// use aws_sdk_ssooidc::config::Config;
546 /// use aws_sdk_ssooidc::config::retry::RetryConfig;
547 ///
548 /// let retry_config = RetryConfig::standard().with_max_attempts(5);
549 /// let config = Config::builder().retry_config(retry_config).build();
550 /// ```
551 pub fn retry_config(mut self, retry_config: ::aws_smithy_types::retry::RetryConfig) -> Self {
552 self.set_retry_config(Some(retry_config));
553 self
554 }
555
556 /// Set the retry_config for the builder
557 ///
558 /// # Examples
559 /// ```no_run
560 /// use aws_sdk_ssooidc::config::{Builder, Config};
561 /// use aws_sdk_ssooidc::config::retry::RetryConfig;
562 ///
563 /// fn disable_retries(builder: &mut Builder) {
564 /// let retry_config = RetryConfig::standard().with_max_attempts(1);
565 /// builder.set_retry_config(Some(retry_config));
566 /// }
567 ///
568 /// let mut builder = Config::builder();
569 /// disable_retries(&mut builder);
570 /// let config = builder.build();
571 /// ```
572 pub fn set_retry_config(&mut self, retry_config: ::std::option::Option<::aws_smithy_types::retry::RetryConfig>) -> &mut Self {
573 retry_config.map(|r| self.config.store_put(r));
574 self
575 }
576 /// Set the sleep_impl for the builder
577 ///
578 /// # Examples
579 ///
580 /// ```no_run
581 /// use aws_sdk_ssooidc::config::{AsyncSleep, Config, SharedAsyncSleep, Sleep};
582 ///
583 /// #[derive(Debug)]
584 /// pub struct ForeverSleep;
585 ///
586 /// impl AsyncSleep for ForeverSleep {
587 /// fn sleep(&self, duration: std::time::Duration) -> Sleep {
588 /// Sleep::new(std::future::pending())
589 /// }
590 /// }
591 ///
592 /// let sleep_impl = SharedAsyncSleep::new(ForeverSleep);
593 /// let config = Config::builder().sleep_impl(sleep_impl).build();
594 /// ```
595 pub fn sleep_impl(mut self, sleep_impl: impl crate::config::AsyncSleep + 'static) -> Self {
596 self.set_sleep_impl(Some(::aws_smithy_runtime_api::shared::IntoShared::into_shared(sleep_impl)));
597 self
598 }
599
600 /// Set the sleep_impl for the builder
601 ///
602 /// # Examples
603 ///
604 /// ```no_run
605 /// use aws_sdk_ssooidc::config::{AsyncSleep, Builder, Config, SharedAsyncSleep, Sleep};
606 ///
607 /// #[derive(Debug)]
608 /// pub struct ForeverSleep;
609 ///
610 /// impl AsyncSleep for ForeverSleep {
611 /// fn sleep(&self, duration: std::time::Duration) -> Sleep {
612 /// Sleep::new(std::future::pending())
613 /// }
614 /// }
615 ///
616 /// fn set_never_ending_sleep_impl(builder: &mut Builder) {
617 /// let sleep_impl = SharedAsyncSleep::new(ForeverSleep);
618 /// builder.set_sleep_impl(Some(sleep_impl));
619 /// }
620 ///
621 /// let mut builder = Config::builder();
622 /// set_never_ending_sleep_impl(&mut builder);
623 /// let config = builder.build();
624 /// ```
625 pub fn set_sleep_impl(&mut self, sleep_impl: ::std::option::Option<crate::config::SharedAsyncSleep>) -> &mut Self {
626 self.runtime_components.set_sleep_impl(sleep_impl);
627 self
628 }
629 /// Set the timeout_config for the builder
630 ///
631 /// # Examples
632 ///
633 /// ```no_run
634 /// # use std::time::Duration;
635 /// use aws_sdk_ssooidc::config::Config;
636 /// use aws_sdk_ssooidc::config::timeout::TimeoutConfig;
637 ///
638 /// let timeout_config = TimeoutConfig::builder()
639 /// .operation_attempt_timeout(Duration::from_secs(1))
640 /// .build();
641 /// let config = Config::builder().timeout_config(timeout_config).build();
642 /// ```
643 pub fn timeout_config(mut self, timeout_config: ::aws_smithy_types::timeout::TimeoutConfig) -> Self {
644 self.set_timeout_config(Some(timeout_config));
645 self
646 }
647
648 /// Set the timeout_config for the builder.
649 ///
650 /// Setting this to `None` has no effect if another source of configuration has set timeouts. If you
651 /// are attempting to disable timeouts, use [`TimeoutConfig::disabled`](::aws_smithy_types::timeout::TimeoutConfig::disabled)
652 ///
653 ///
654 /// # Examples
655 ///
656 /// ```no_run
657 /// # use std::time::Duration;
658 /// use aws_sdk_ssooidc::config::{Builder, Config};
659 /// use aws_sdk_ssooidc::config::timeout::TimeoutConfig;
660 ///
661 /// fn set_request_timeout(builder: &mut Builder) {
662 /// let timeout_config = TimeoutConfig::builder()
663 /// .operation_attempt_timeout(Duration::from_secs(1))
664 /// .build();
665 /// builder.set_timeout_config(Some(timeout_config));
666 /// }
667 ///
668 /// let mut builder = Config::builder();
669 /// set_request_timeout(&mut builder);
670 /// let config = builder.build();
671 /// ```
672 pub fn set_timeout_config(&mut self, timeout_config: ::std::option::Option<::aws_smithy_types::timeout::TimeoutConfig>) -> &mut Self {
673 // passing None has no impact.
674 let Some(mut timeout_config) = timeout_config else {
675 return self
676 };
677
678 if let Some(base) = self.config.load::<::aws_smithy_types::timeout::TimeoutConfig>() {
679 timeout_config.take_defaults_from(base);
680 }
681 self.config.store_put(timeout_config);
682 self
683 }
684 /// Set the partition for retry-related state. When clients share a retry partition, they will
685 /// also share components such as token buckets and client rate limiters.
686 /// See the [`RetryPartition`](::aws_smithy_runtime::client::retries::RetryPartition) documentation for more details.
687 ///
688 /// # Default Behavior
689 ///
690 /// When no retry partition is explicitly set, the SDK automatically creates a default retry partition named `ssooidc`
691 /// (or `ssooidc-<region>` if a region is configured).
692 /// All SSO OIDC clients without an explicit retry partition will share this default partition.
693 ///
694 /// # Notes
695 ///
696 /// - This is an advanced setting — most users won't need to modify it.
697 /// - A configured client rate limiter has no effect unless [`RetryConfig::adaptive`](::aws_smithy_types::retry::RetryConfig::adaptive) is used.
698 ///
699 /// # Examples
700 ///
701 /// Creating a custom retry partition with a token bucket:
702 /// ```no_run
703 /// use aws_sdk_ssooidc::config::Config;
704 /// use aws_sdk_ssooidc::config::retry::{RetryPartition, TokenBucket};
705 ///
706 /// let token_bucket = TokenBucket::new(10);
707 /// let config = Config::builder()
708 /// .retry_partition(RetryPartition::custom("custom")
709 /// .token_bucket(token_bucket)
710 /// .build()
711 /// )
712 /// .build();
713 /// ```
714 ///
715 /// Configuring a client rate limiter with adaptive retry mode:
716 /// ```no_run
717 /// use aws_sdk_ssooidc::config::Config;
718 /// use aws_sdk_ssooidc::config::retry::{ClientRateLimiter, RetryConfig, RetryPartition};
719 ///
720 /// let client_rate_limiter = ClientRateLimiter::new(10.0);
721 /// let config = Config::builder()
722 /// .retry_partition(RetryPartition::custom("custom")
723 /// .client_rate_limiter(client_rate_limiter)
724 /// .build()
725 /// )
726 /// .retry_config(RetryConfig::adaptive())
727 /// .build();
728 /// ```
729 pub fn retry_partition(mut self, retry_partition: ::aws_smithy_runtime::client::retries::RetryPartition) -> Self {
730 self.set_retry_partition(Some(retry_partition));
731 self
732 }
733 /// Like [`Self::retry_partition`], but takes a mutable reference to the builder and an optional `RetryPartition`
734 pub fn set_retry_partition(&mut self, retry_partition: ::std::option::Option<::aws_smithy_runtime::client::retries::RetryPartition>) -> &mut Self {
735 retry_partition.map(|r| self.config.store_put(r));
736 self
737 }
738 /// Set the identity cache for auth.
739 ///
740 /// The identity cache defaults to a lazy caching implementation that will resolve
741 /// an identity when it is requested, and place it in the cache thereafter. Subsequent
742 /// requests will take the value from the cache while it is still valid. Once it expires,
743 /// the next request will result in refreshing the identity.
744 ///
745 /// This configuration allows you to disable or change the default caching mechanism.
746 /// To use a custom caching mechanism, implement the [`ResolveCachedIdentity`](crate::config::ResolveCachedIdentity)
747 /// trait and pass that implementation into this function.
748 ///
749 /// # Examples
750 ///
751 /// Disabling identity caching:
752 /// ```no_run
753 /// use aws_sdk_ssooidc::config::IdentityCache;
754 ///
755 /// let config = aws_sdk_ssooidc::Config::builder()
756 /// .identity_cache(IdentityCache::no_cache())
757 /// // ...
758 /// .build();
759 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
760 /// ```
761 ///
762 /// Customizing lazy caching:
763 /// ```no_run
764 /// use aws_sdk_ssooidc::config::IdentityCache;
765 /// use std::time::Duration;
766 ///
767 /// let config = aws_sdk_ssooidc::Config::builder()
768 /// .identity_cache(
769 /// IdentityCache::lazy()
770 /// // change the load timeout to 10 seconds
771 /// .load_timeout(Duration::from_secs(10))
772 /// .build()
773 /// )
774 /// // ...
775 /// .build();
776 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
777 /// ```
778 ///
779 pub fn identity_cache(mut self, identity_cache: impl crate::config::ResolveCachedIdentity + 'static) -> Self {
780 self.set_identity_cache(identity_cache);
781 self
782 }
783
784
785 /// Set the identity cache for auth.
786 ///
787 /// The identity cache defaults to a lazy caching implementation that will resolve
788 /// an identity when it is requested, and place it in the cache thereafter. Subsequent
789 /// requests will take the value from the cache while it is still valid. Once it expires,
790 /// the next request will result in refreshing the identity.
791 ///
792 /// This configuration allows you to disable or change the default caching mechanism.
793 /// To use a custom caching mechanism, implement the [`ResolveCachedIdentity`](crate::config::ResolveCachedIdentity)
794 /// trait and pass that implementation into this function.
795 ///
796 /// # Examples
797 ///
798 /// Disabling identity caching:
799 /// ```no_run
800 /// use aws_sdk_ssooidc::config::IdentityCache;
801 ///
802 /// let config = aws_sdk_ssooidc::Config::builder()
803 /// .identity_cache(IdentityCache::no_cache())
804 /// // ...
805 /// .build();
806 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
807 /// ```
808 ///
809 /// Customizing lazy caching:
810 /// ```no_run
811 /// use aws_sdk_ssooidc::config::IdentityCache;
812 /// use std::time::Duration;
813 ///
814 /// let config = aws_sdk_ssooidc::Config::builder()
815 /// .identity_cache(
816 /// IdentityCache::lazy()
817 /// // change the load timeout to 10 seconds
818 /// .load_timeout(Duration::from_secs(10))
819 /// .build()
820 /// )
821 /// // ...
822 /// .build();
823 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
824 /// ```
825 ///
826 pub fn set_identity_cache(&mut self, identity_cache: impl crate::config::ResolveCachedIdentity + 'static) -> &mut Self {
827 self.runtime_components.set_identity_cache(::std::option::Option::Some(identity_cache));
828 self
829 }
830 /// Add an [interceptor](crate::config::Intercept) that runs at specific stages of the request execution pipeline.
831 ///
832 /// Interceptors targeted at a certain stage are executed according to the pre-defined priority.
833 /// The SDK provides a default set of interceptors. An interceptor configured by this method
834 /// will run after those default interceptors.
835 ///
836 /// # Examples
837 /// ```no_run
838 /// # fn example() {
839 /// use aws_smithy_runtime_api::box_error::BoxError;
840 /// use aws_smithy_runtime_api::client::interceptors::context::BeforeTransmitInterceptorContextMut;
841 /// use aws_smithy_runtime_api::client::interceptors::Intercept;
842 /// use aws_smithy_runtime_api::client::runtime_components::RuntimeComponents;
843 /// use aws_smithy_types::config_bag::ConfigBag;
844 /// use aws_sdk_ssooidc::config::Config;
845 /// use ::http::uri::Uri;
846 ///
847 /// fn base_url() -> String {
848 /// // ...
849 /// # String::new()
850 /// }
851 ///
852 /// #[derive(Debug)]
853 /// pub struct UriModifierInterceptor;
854 /// impl Intercept for UriModifierInterceptor {
855 /// fn name(&self) -> &'static str {
856 /// "UriModifierInterceptor"
857 /// }
858 /// fn modify_before_signing(
859 /// &self,
860 /// context: &mut BeforeTransmitInterceptorContextMut<'_>,
861 /// _runtime_components: &RuntimeComponents,
862 /// _cfg: &mut ConfigBag,
863 /// ) -> Result<(), BoxError> {
864 /// let request = context.request_mut();
865 /// let uri = format!("{}{}", base_url(), request.uri());
866 /// *request.uri_mut() = uri.parse::<Uri>()?.into();
867 ///
868 /// Ok(())
869 /// }
870 /// }
871 ///
872 /// let config = Config::builder()
873 /// .interceptor(UriModifierInterceptor)
874 /// .build();
875 /// # }
876 /// ```
877 pub fn interceptor(mut self, interceptor: impl crate::config::Intercept + 'static) -> Self {
878 self.push_interceptor(crate::config::SharedInterceptor::new(interceptor));
879 self
880 }
881
882 /// Like [`Self::interceptor`], but takes a [`SharedInterceptor`](crate::config::SharedInterceptor).
883 pub fn push_interceptor(&mut self, interceptor: crate::config::SharedInterceptor) -> &mut Self {
884 self.runtime_components.push_interceptor(interceptor);
885 self
886 }
887
888 /// Set [`SharedInterceptor`](crate::config::SharedInterceptor)s for the builder.
889 pub fn set_interceptors(&mut self, interceptors: impl IntoIterator<Item = crate::config::SharedInterceptor>) -> &mut Self {
890 self.runtime_components.set_interceptors(interceptors.into_iter());
891 self
892 }
893 /// Sets the time source used for this service
894 pub fn time_source(
895 mut self,
896 time_source: impl ::aws_smithy_async::time::TimeSource + 'static,
897 ) -> Self {
898 self.set_time_source(::std::option::Option::Some(::aws_smithy_runtime_api::shared::IntoShared::into_shared(time_source)));
899 self
900 }
901 /// Sets the time source used for this service
902 pub fn set_time_source(
903 &mut self,
904 time_source: ::std::option::Option<::aws_smithy_async::time::SharedTimeSource>,
905 ) -> &mut Self {
906 self.runtime_components.set_time_source(time_source);
907 self
908 }
909 /// Add type implementing [`ClassifyRetry`](::aws_smithy_runtime_api::client::retries::classifiers::ClassifyRetry) that will be used by the
910 /// [`RetryStrategy`](::aws_smithy_runtime_api::client::retries::RetryStrategy) to determine what responses should be retried.
911 ///
912 /// A retry classifier configured by this method will run according to its [priority](::aws_smithy_runtime_api::client::retries::classifiers::RetryClassifierPriority).
913 ///
914 /// # Examples
915 /// ```no_run
916 /// # fn example() {
917 /// use aws_smithy_runtime_api::client::interceptors::context::InterceptorContext;
918 /// use aws_smithy_runtime_api::client::orchestrator::OrchestratorError;
919 /// use aws_smithy_runtime_api::client::retries::classifiers::{
920 /// ClassifyRetry, RetryAction, RetryClassifierPriority,
921 /// };
922 /// use aws_smithy_types::error::metadata::ProvideErrorMetadata;
923 /// use aws_smithy_types::retry::ErrorKind;
924 /// use std::error::Error as StdError;
925 /// use std::marker::PhantomData;
926 /// use std::fmt;
927 /// use aws_sdk_ssooidc::config::Config;
928 /// # #[derive(Debug)]
929 /// # struct SomeOperationError {}
930 /// # impl StdError for SomeOperationError {}
931 /// # impl fmt::Display for SomeOperationError {
932 /// # fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { todo!() }
933 /// # }
934 /// # impl ProvideErrorMetadata for SomeOperationError {
935 /// # fn meta(&self) -> &aws_sdk_ssooidc::error::ErrorMetadata { todo!() }
936 /// # }
937 ///
938 /// const RETRYABLE_ERROR_CODES: &[&str] = &[
939 /// // List error codes to be retried here...
940 /// ];
941 ///
942 /// // When classifying at an operation's error type, classifiers require a generic parameter.
943 /// // When classifying the HTTP response alone, no generic is needed.
944 /// #[derive(Debug, Default)]
945 /// pub struct ExampleErrorCodeClassifier<E> {
946 /// _inner: PhantomData<E>,
947 /// }
948 ///
949 /// impl<E> ExampleErrorCodeClassifier<E> {
950 /// pub fn new() -> Self {
951 /// Self {
952 /// _inner: PhantomData,
953 /// }
954 /// }
955 /// }
956 ///
957 /// impl<E> ClassifyRetry for ExampleErrorCodeClassifier<E>
958 /// where
959 /// // Adding a trait bound for ProvideErrorMetadata allows us to inspect the error code.
960 /// E: StdError + ProvideErrorMetadata + Send + Sync + 'static,
961 /// {
962 /// fn classify_retry(&self, ctx: &InterceptorContext) -> RetryAction {
963 /// // Check for a result
964 /// let output_or_error = ctx.output_or_error();
965 /// // Check for an error
966 /// let error = match output_or_error {
967 /// Some(Ok(_)) | None => return RetryAction::NoActionIndicated,
968 /// Some(Err(err)) => err,
969 /// };
970 ///
971 /// // Downcast the generic error and extract the code
972 /// let error_code = OrchestratorError::as_operation_error(error)
973 /// .and_then(|err| err.downcast_ref::<E>())
974 /// .and_then(|err| err.code());
975 ///
976 /// // If this error's code is in our list, return an action that tells the RetryStrategy to retry this request.
977 /// if let Some(error_code) = error_code {
978 /// if RETRYABLE_ERROR_CODES.contains(&error_code) {
979 /// return RetryAction::transient_error();
980 /// }
981 /// }
982 ///
983 /// // Otherwise, return that no action is indicated i.e. that this classifier doesn't require a retry.
984 /// // Another classifier may still classify this response as retryable.
985 /// RetryAction::NoActionIndicated
986 /// }
987 ///
988 /// fn name(&self) -> &'static str { "Example Error Code Classifier" }
989 /// }
990 ///
991 /// let config = Config::builder()
992 /// .retry_classifier(ExampleErrorCodeClassifier::<SomeOperationError>::new())
993 /// .build();
994 /// # }
995 /// ```
996 pub fn retry_classifier(mut self, retry_classifier: impl ::aws_smithy_runtime_api::client::retries::classifiers::ClassifyRetry + 'static) -> Self {
997 self.push_retry_classifier(::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier::new(retry_classifier));
998 self
999 }
1000
1001 /// Like [`Self::retry_classifier`], but takes a [`SharedRetryClassifier`](::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier).
1002 pub fn push_retry_classifier(&mut self, retry_classifier: ::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier) -> &mut Self {
1003 self.runtime_components.push_retry_classifier(retry_classifier);
1004 self
1005 }
1006
1007 /// Set [`SharedRetryClassifier`](::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier)s for the builder, replacing any that
1008 /// were previously set.
1009 pub fn set_retry_classifiers(&mut self, retry_classifiers: impl IntoIterator<Item = ::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier>) -> &mut Self {
1010 self.runtime_components.set_retry_classifiers(retry_classifiers.into_iter());
1011 self
1012 }
1013 /// Sets the name of the app that is using the client.
1014 ///
1015 /// This _optional_ name is used to identify the application in the user agent that
1016 /// gets sent along with requests.
1017 pub fn app_name(mut self, app_name: ::aws_types::app_name::AppName) -> Self {
1018 self.set_app_name(Some(app_name));
1019 self
1020 }
1021 /// Sets the name of the app that is using the client.
1022 ///
1023 /// This _optional_ name is used to identify the application in the user agent that
1024 /// gets sent along with requests.
1025 pub fn set_app_name(&mut self, app_name: ::std::option::Option<::aws_types::app_name::AppName>) -> &mut Self {
1026 self.config.store_or_unset(app_name);
1027 self
1028 }
1029 /// Overrides the default invocation ID generator.
1030 ///
1031 /// 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.
1032 pub fn invocation_id_generator(mut self, gen: impl ::aws_runtime::invocation_id::InvocationIdGenerator + 'static) -> Self {
1033 self.set_invocation_id_generator(::std::option::Option::Some(::aws_runtime::invocation_id::SharedInvocationIdGenerator::new(gen)));
1034 self
1035 }
1036 /// Overrides the default invocation ID generator.
1037 ///
1038 /// 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.
1039 pub fn set_invocation_id_generator(&mut self, gen: ::std::option::Option<::aws_runtime::invocation_id::SharedInvocationIdGenerator>) -> &mut Self {
1040 self.config.store_or_unset(gen);
1041 self
1042 }
1043 /// Sets the endpoint URL used to communicate with this service.
1044 ///
1045 /// Note: this is used in combination with other endpoint rules, e.g. an API that applies a host-label prefix
1046 /// will be prefixed onto this URL. To fully override the endpoint resolver, use
1047 /// [`Builder::endpoint_resolver`].
1048 pub fn endpoint_url(mut self, endpoint_url: impl Into<::std::string::String>) -> Self {
1049 self.set_endpoint_url(Some(endpoint_url.into()));
1050 self
1051 }
1052 /// Sets the endpoint URL used to communicate with this service.
1053 ///
1054 /// Note: this is used in combination with other endpoint rules, e.g. an API that applies a host-label prefix
1055 /// will be prefixed onto this URL. To fully override the endpoint resolver, use
1056 /// [`Builder::endpoint_resolver`].
1057 pub fn set_endpoint_url(&mut self, endpoint_url: Option<::std::string::String>) -> &mut Self {
1058 self.config.store_or_unset(endpoint_url.map(::aws_types::endpoint_config::EndpointUrl));
1059 self
1060 }
1061 /// When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
1062 pub fn use_dual_stack(mut self, use_dual_stack: impl Into<bool>) -> Self {
1063 self.set_use_dual_stack(Some(use_dual_stack.into()));
1064 self
1065 }
1066 /// When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
1067 pub fn set_use_dual_stack(&mut self, use_dual_stack: Option<bool>) -> &mut Self {
1068 self.config.store_or_unset(use_dual_stack.map(::aws_types::endpoint_config::UseDualStack));
1069 self
1070 }
1071 /// 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.
1072 pub fn use_fips(mut self, use_fips: impl Into<bool>) -> Self {
1073 self.set_use_fips(Some(use_fips.into()));
1074 self
1075 }
1076 /// 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.
1077 pub fn set_use_fips(&mut self, use_fips: Option<bool>) -> &mut Self {
1078 self.config.store_or_unset(use_fips.map(::aws_types::endpoint_config::UseFips));
1079 self
1080 }
1081 /// Sets the AWS region to use when making requests.
1082 ///
1083 /// # Examples
1084 /// ```no_run
1085 /// use aws_types::region::Region;
1086 /// use aws_sdk_ssooidc::config::{Builder, Config};
1087 ///
1088 /// let config = aws_sdk_ssooidc::Config::builder()
1089 /// .region(Region::new("us-east-1"))
1090 /// .build();
1091 /// ```
1092 pub fn region(mut self, region: impl ::std::convert::Into<::std::option::Option<crate::config::Region>>) -> Self {
1093 self.set_region(region.into());
1094 self
1095 }
1096 /// Sets the AWS region to use when making requests.
1097 pub fn set_region(&mut self, region: ::std::option::Option<crate::config::Region>) -> &mut Self {
1098 self.config.store_or_unset(region);
1099 self
1100 }
1101 /// Sets the credentials provider for this service
1102 pub fn credentials_provider(mut self, credentials_provider: impl crate::config::ProvideCredentials + 'static) -> Self {
1103 self.set_credentials_provider(::std::option::Option::Some(crate::config::SharedCredentialsProvider::new(credentials_provider)));
1104 self
1105 }
1106 /// Sets the credentials provider for this service
1107 pub fn set_credentials_provider(&mut self, credentials_provider: ::std::option::Option<crate::config::SharedCredentialsProvider>) -> &mut Self {
1108 if let Some(credentials_provider) = credentials_provider {
1109 self.runtime_components.set_identity_resolver(::aws_runtime::auth::sigv4::SCHEME_ID, credentials_provider);
1110 }
1111 self
1112 }
1113 /// Sets the [`behavior major version`](crate::config::BehaviorVersion).
1114 ///
1115 /// Over time, new best-practice behaviors are introduced. However, these behaviors might not be backwards
1116 /// compatible. For example, a change which introduces new default timeouts or a new retry-mode for
1117 /// all operations might be the ideal behavior but could break existing applications.
1118 ///
1119 /// # Examples
1120 ///
1121 /// Set the behavior major version to `latest`. This is equivalent to enabling the `behavior-version-latest` cargo feature.
1122 /// ```no_run
1123 /// use aws_sdk_ssooidc::config::BehaviorVersion;
1124 ///
1125 /// let config = aws_sdk_ssooidc::Config::builder()
1126 /// .behavior_version(BehaviorVersion::latest())
1127 /// // ...
1128 /// .build();
1129 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
1130 /// ```
1131 ///
1132 /// Customizing behavior major version:
1133 /// ```no_run
1134 /// use aws_sdk_ssooidc::config::BehaviorVersion;
1135 ///
1136 /// let config = aws_sdk_ssooidc::Config::builder()
1137 /// .behavior_version(BehaviorVersion::v2023_11_09())
1138 /// // ...
1139 /// .build();
1140 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
1141 /// ```
1142 ///
1143 pub fn behavior_version(mut self, behavior_version: crate::config::BehaviorVersion) -> Self {
1144 self.set_behavior_version(Some(behavior_version));
1145 self
1146 }
1147
1148
1149 /// Sets the [`behavior major version`](crate::config::BehaviorVersion).
1150 ///
1151 /// Over time, new best-practice behaviors are introduced. However, these behaviors might not be backwards
1152 /// compatible. For example, a change which introduces new default timeouts or a new retry-mode for
1153 /// all operations might be the ideal behavior but could break existing applications.
1154 ///
1155 /// # Examples
1156 ///
1157 /// Set the behavior major version to `latest`. This is equivalent to enabling the `behavior-version-latest` cargo feature.
1158 /// ```no_run
1159 /// use aws_sdk_ssooidc::config::BehaviorVersion;
1160 ///
1161 /// let config = aws_sdk_ssooidc::Config::builder()
1162 /// .behavior_version(BehaviorVersion::latest())
1163 /// // ...
1164 /// .build();
1165 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
1166 /// ```
1167 ///
1168 /// Customizing behavior major version:
1169 /// ```no_run
1170 /// use aws_sdk_ssooidc::config::BehaviorVersion;
1171 ///
1172 /// let config = aws_sdk_ssooidc::Config::builder()
1173 /// .behavior_version(BehaviorVersion::v2023_11_09())
1174 /// // ...
1175 /// .build();
1176 /// let client = aws_sdk_ssooidc::Client::from_conf(config);
1177 /// ```
1178 ///
1179 pub fn set_behavior_version(&mut self, behavior_version: Option<crate::config::BehaviorVersion>) -> &mut Self {
1180 self.behavior_version = behavior_version;
1181 self
1182 }
1183
1184 /// Convenience method to set the latest behavior major version
1185 ///
1186 /// This is equivalent to enabling the `behavior-version-latest` Cargo feature
1187 pub fn behavior_version_latest(mut self) -> Self {
1188 self.set_behavior_version(Some(crate::config::BehaviorVersion::latest()));
1189 self
1190 }
1191 /// Adds a runtime plugin to the config.
1192 #[allow(unused)]
1193 pub(crate) fn runtime_plugin(mut self, plugin: impl crate::config::RuntimePlugin + 'static) -> Self {
1194 self.push_runtime_plugin(crate::config::SharedRuntimePlugin::new(plugin));
1195 self
1196 }
1197 /// Adds a runtime plugin to the config.
1198 #[allow(unused)]
1199 pub(crate) fn push_runtime_plugin(&mut self, plugin: crate::config::SharedRuntimePlugin) -> &mut Self {
1200 self.runtime_plugins.push(plugin);
1201 self
1202 }
1203 #[cfg(any(feature = "test-util", test))]
1204 #[allow(unused_mut)]
1205 /// Apply test defaults to the builder. NOTE: Consider migrating to use `apply_test_defaults_v2` instead.
1206 pub fn apply_test_defaults(&mut self) -> &mut Self {
1207 self
1208 .set_time_source(::std::option::Option::Some(::aws_smithy_async::time::SharedTimeSource::new(
1209 ::aws_smithy_async::time::StaticTimeSource::new(::std::time::UNIX_EPOCH + ::std::time::Duration::from_secs(1234567890)))
1210 ));
1211 self.config.store_put(::aws_runtime::user_agent::AwsUserAgent::for_tests());
1212 self.set_credentials_provider(Some(crate::config::SharedCredentialsProvider::new(::aws_credential_types::Credentials::for_tests())));
1213 self.behavior_version = ::std::option::Option::Some(crate::config::BehaviorVersion::latest());
1214 self
1215 }
1216 #[cfg(any(feature = "test-util", test))]
1217 #[allow(unused_mut)]
1218 /// Apply test defaults to the builder. NOTE: Consider migrating to use `with_test_defaults_v2` instead.
1219 pub fn with_test_defaults(mut self) -> Self {
1220 self.apply_test_defaults(); self
1221 }
1222 #[cfg(any(feature = "test-util", test))]
1223 #[allow(unused_mut)]
1224 /// Apply test defaults to the builder. V2 of this function sets additional test defaults such as region configuration (if applicable).
1225 pub fn apply_test_defaults_v2(&mut self) -> &mut Self {
1226 self.apply_test_defaults();
1227 if self.config.load::<crate::config::Region>().is_none() {
1228 self.set_region(::std::option::Option::Some(crate::config::Region::new("us-east-1")));
1229 }
1230 self
1231 }
1232 #[cfg(any(feature = "test-util", test))]
1233 #[allow(unused_mut)]
1234 /// Apply test defaults to the builder. V2 of this function sets additional test defaults such as region configuration (if applicable).
1235 pub fn with_test_defaults_v2(mut self) -> Self {
1236 self.apply_test_defaults_v2(); self
1237 }
1238 /// Builds a [`Config`].
1239 #[allow(unused_mut)]
1240 pub fn build(mut self) -> Config {
1241 let mut layer = self.config;
1242 if self.runtime_components.time_source().is_none() {
1243 self.runtime_components.set_time_source(::std::option::Option::Some(::std::default::Default::default()));
1244 }
1245 layer.store_put(crate::meta::API_METADATA.clone());
1246 layer.store_put(::aws_types::SigningName::from_static("sso-oauth"));
1247 layer.load::<::aws_types::region::Region>().cloned().map(|r| layer.store_put(::aws_types::region::SigningRegion::from(r)));
1248 Config {
1249 config: crate::config::Layer::from(layer.clone()).with_name("aws_sdk_ssooidc::config::Config").freeze(),
1250 cloneable: layer,
1251 runtime_components: self.runtime_components,
1252 runtime_plugins: self.runtime_plugins,
1253 behavior_version: self.behavior_version,
1254 }
1255 }
1256}
1257#[derive(::std::fmt::Debug)]
1258 pub(crate) struct ServiceRuntimePlugin {
1259 config: ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer>,
1260 runtime_components: ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1261 }
1262
1263 impl ServiceRuntimePlugin {
1264 pub fn new(_service_config: crate::config::Config) -> Self {
1265 let config = { let mut cfg = ::aws_smithy_types::config_bag::Layer::new("AWSSSOOIDCService");
1266 cfg.store_put(::aws_smithy_runtime::client::orchestrator::AuthSchemeAndEndpointOrchestrationV2);
1267 ::std::option::Option::Some(cfg.freeze()) };
1268 let mut runtime_components = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ServiceRuntimePlugin");
1269 runtime_components.set_auth_scheme_option_resolver(::std::option::Option::Some({
1270 use crate::config::auth::ResolveAuthScheme;
1271 crate::config::auth::DefaultAuthSchemeResolver::default().into_shared_resolver()
1272 }));
1273runtime_components.set_endpoint_resolver(::std::option::Option::Some({
1274 use crate::config::endpoint::ResolveEndpoint;
1275 crate::config::endpoint::DefaultResolver::new().into_shared_resolver()
1276 }));
1277runtime_components.push_interceptor(::aws_smithy_runtime::client::http::connection_poisoning::ConnectionPoisoningInterceptor::new());
1278runtime_components.push_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::HttpStatusCodeClassifier::default());
1279runtime_components.push_interceptor(crate::sdk_feature_tracker::retry_mode::RetryModeFeatureTrackerInterceptor::new());
1280runtime_components.push_interceptor(::aws_runtime::service_clock_skew::ServiceClockSkewInterceptor::new());
1281runtime_components.push_interceptor(::aws_runtime::request_info::RequestInfoInterceptor::new());
1282runtime_components.push_interceptor(::aws_runtime::user_agent::UserAgentInterceptor::new());
1283runtime_components.push_interceptor(::aws_runtime::invocation_id::InvocationIdInterceptor::new());
1284runtime_components.push_interceptor(::aws_runtime::recursion_detection::RecursionDetectionInterceptor::new());
1285runtime_components.push_auth_scheme(::aws_smithy_runtime_api::client::auth::SharedAuthScheme::new(::aws_runtime::auth::sigv4::SigV4AuthScheme::new()));
1286runtime_components.push_interceptor(crate::config::endpoint::EndpointOverrideFeatureTrackerInterceptor);
1287 Self { config, runtime_components }
1288 }
1289 }
1290
1291 impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ServiceRuntimePlugin {
1292 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
1293 self.config.clone()
1294 }
1295
1296 fn order(&self) -> ::aws_smithy_runtime_api::client::runtime_plugin::Order {
1297 ::aws_smithy_runtime_api::client::runtime_plugin::Order::Defaults
1298 }
1299
1300 fn runtime_components(&self, _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
1301 ::std::borrow::Cow::Borrowed(&self.runtime_components)
1302 }
1303 }
1304
1305 // Cross-operation shared-state singletons
1306
1307/// A plugin that enables configuration for a single operation invocation
1308 ///
1309 /// The `config` method will return a `FrozenLayer` by storing values from `config_override`.
1310 /// In the case of default values requested, they will be obtained from `client_config`.
1311 #[derive(Debug)]
1312 pub(crate) struct ConfigOverrideRuntimePlugin {
1313 pub(crate) config: ::aws_smithy_types::config_bag::FrozenLayer,
1314 pub(crate) components: ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1315 }
1316
1317 impl ConfigOverrideRuntimePlugin {
1318 #[allow(dead_code)] // unused when a service does not provide any operations
1319 pub(crate) fn new(
1320 config_override: Builder,
1321 initial_config: ::aws_smithy_types::config_bag::FrozenLayer,
1322 initial_components: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder
1323 ) -> Self {
1324 let mut layer = config_override.config;
1325 let mut components = config_override.runtime_components;
1326 #[allow(unused_mut)]
1327 let mut resolver = ::aws_smithy_runtime::client::config_override::Resolver::overrid(initial_config, initial_components, &mut layer, &mut components);
1328
1329 resolver.config_mut()
1330 .load::<::aws_types::region::Region>()
1331 .cloned()
1332 .map(|r| resolver.config_mut().store_put(::aws_types::region::SigningRegion::from(r)));
1333
1334 let _ = resolver;
1335 Self {
1336 config: ::aws_smithy_types::config_bag::Layer::from(layer)
1337 .with_name("aws_sdk_ssooidc::config::ConfigOverrideRuntimePlugin").freeze(),
1338 components,
1339 }
1340 }
1341 }
1342
1343 impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ConfigOverrideRuntimePlugin {
1344 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
1345 Some(self.config.clone())
1346 }
1347
1348 fn runtime_components(&self, _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
1349 ::std::borrow::Cow::Borrowed(&self.components)
1350 }
1351 }
1352
1353pub use ::aws_smithy_types::config_bag::ConfigBag;
1354 pub use ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents;
1355 pub use ::aws_smithy_runtime::client::identity::IdentityCache;
1356
1357pub use ::aws_credential_types::Credentials;
1358
1359impl From<&::aws_types::sdk_config::SdkConfig> for Builder {
1360 fn from(input: &::aws_types::sdk_config::SdkConfig) -> Self {
1361 let mut builder = Builder::default();
1362 builder.set_credentials_provider(input.credentials_provider());
1363builder =
1364 builder.region(input.region().cloned());
1365builder.set_use_fips(input.use_fips());
1366builder.set_use_dual_stack(input.use_dual_stack());
1367if input.get_origin("endpoint_url").is_client_config() {
1368 builder.set_endpoint_url(input.endpoint_url().map(|s|s.to_string()));
1369 } else {
1370 builder.set_endpoint_url(
1371 input
1372 .service_config()
1373 .and_then(|conf| conf.load_config(service_config_key("SSO OIDC", "AWS_ENDPOINT_URL", "endpoint_url")).map(|it| it.parse().unwrap()))
1374 .or_else(|| input.endpoint_url().map(|s|s.to_string()))
1375 );
1376 }
1377// resiliency
1378 builder.set_retry_config(input.retry_config().cloned());
1379 builder.set_timeout_config(input.timeout_config().cloned());
1380 builder.set_sleep_impl(input.sleep_impl());
1381
1382 builder.set_http_client(input.http_client());
1383 builder.set_time_source(input.time_source());
1384 builder.set_behavior_version(input.behavior_version());
1385 builder.set_auth_scheme_preference(input.auth_scheme_preference().cloned());
1386 // setting `None` here removes the default
1387 if let Some(config) = input.stalled_stream_protection() {
1388 builder.set_stalled_stream_protection(Some(config));
1389 }
1390
1391 if let Some(cache) = input.identity_cache() {
1392 builder.set_identity_cache(cache);
1393 }
1394builder.set_app_name(input.app_name().cloned());
1395
1396 builder
1397 }
1398 }
1399
1400 impl From<&::aws_types::sdk_config::SdkConfig> for Config {
1401 fn from(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
1402 Builder::from(sdk_config).build()
1403 }
1404 }
1405
1406pub use ::aws_types::app_name::AppName;
1407
1408#[allow(dead_code)]
1409fn service_config_key<'a>(
1410 service_id: &'a str,
1411 env: &'a str,
1412 profile: &'a str,
1413 ) -> aws_types::service_config::ServiceConfigKey<'a> {
1414 ::aws_types::service_config::ServiceConfigKey::builder()
1415 .service_id(service_id)
1416 .env(env)
1417 .profile(profile)
1418 .build()
1419 .expect("all field sets explicitly, can't fail")
1420 }
1421
1422pub use ::aws_smithy_async::rt::sleep::{Sleep};
1423
1424pub(crate) fn base_client_runtime_plugins(
1425 mut config: crate::Config,
1426 ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
1427 let mut configured_plugins = ::std::vec::Vec::new();
1428 ::std::mem::swap(&mut config.runtime_plugins, &mut configured_plugins);
1429 #[cfg(feature = "behavior-version-latest")] {
1430 if config.behavior_version.is_none() {
1431 config.behavior_version = Some(::aws_smithy_runtime_api::client::behavior_version::BehaviorVersion::latest());
1432 }
1433}
1434
1435 let default_retry_partition = "ssooidc";
1436 let default_retry_partition = match config.region() {
1437 Some(region) => ::std::borrow::Cow::from(format!("{default_retry_partition}-{region}")),
1438 None => ::std::borrow::Cow::from(default_retry_partition),
1439 };
1440
1441 let scope = "aws-sdk-ssooidc";
1442
1443 #[allow(deprecated)]
1444 let mut plugins = ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins::new()
1445 // defaults
1446 .with_client_plugins(::aws_smithy_runtime::client::defaults::default_plugins(
1447 ::aws_smithy_runtime::client::defaults::DefaultPluginParams::new()
1448 .with_retry_partition_name(default_retry_partition)
1449 .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."))
1450 ))
1451 // user config
1452 .with_client_plugin(
1453 ::aws_smithy_runtime_api::client::runtime_plugin::StaticRuntimePlugin::new()
1454 .with_config(config.config.clone())
1455 .with_runtime_components(config.runtime_components.clone())
1456 )
1457 // codegen config
1458 .with_client_plugin(crate::config::ServiceRuntimePlugin::new(config.clone()))
1459 .with_client_plugin(::aws_smithy_runtime::client::auth::no_auth::NoAuthRuntimePlugin::new())
1460 .with_client_plugin(
1461 ::aws_smithy_runtime::client::metrics::MetricsRuntimePlugin::builder()
1462 .with_scope(scope)
1463 .with_time_source(config.runtime_components.time_source().unwrap_or_default())
1464 .build()
1465 .expect("All required fields have been set")
1466 );
1467
1468
1469
1470 for plugin in configured_plugins {
1471 plugins = plugins.with_client_plugin(plugin);
1472 }
1473 plugins
1474 }
1475
1476pub use ::aws_smithy_types::config_bag::FrozenLayer;
1477
1478pub use ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder;
1479
1480pub use ::aws_smithy_runtime_api::client::runtime_plugin::SharedRuntimePlugin;
1481
1482pub use ::aws_smithy_runtime_api::client::behavior_version::BehaviorVersion;
1483
1484pub use ::aws_smithy_runtime_api::client::stalled_stream_protection::StalledStreamProtectionConfig;
1485
1486pub use ::aws_smithy_runtime_api::client::http::SharedHttpClient;
1487
1488pub use ::aws_smithy_async::rt::sleep::SharedAsyncSleep;
1489
1490pub use ::aws_smithy_runtime_api::client::identity::SharedIdentityCache;
1491
1492pub use ::aws_smithy_runtime_api::client::interceptors::SharedInterceptor;
1493
1494pub use ::aws_types::region::Region;
1495
1496pub use ::aws_credential_types::provider::SharedCredentialsProvider;
1497
1498pub use ::aws_smithy_runtime_api::client::http::HttpClient;
1499
1500pub use ::aws_smithy_runtime_api::shared::IntoShared;
1501
1502pub use ::aws_smithy_async::rt::sleep::AsyncSleep;
1503
1504pub use ::aws_smithy_runtime_api::client::identity::ResolveCachedIdentity;
1505
1506pub use ::aws_smithy_runtime_api::client::interceptors::Intercept;
1507
1508pub use ::aws_credential_types::provider::ProvideCredentials;
1509
1510pub use ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin;
1511
1512pub use ::aws_smithy_types::config_bag::Layer;
1513
1514/// Types needed to configure endpoint resolution.
1515pub mod endpoint;
1516
1517/// HTTP request and response types.
1518pub mod http;
1519
1520/// Types needed to implement [`Intercept`](crate::config::Intercept).
1521pub mod interceptors;
1522
1523/// Retry configuration.
1524pub mod retry;
1525
1526/// Timeout configuration.
1527pub mod timeout;
1528
1529/// Types needed to configure auth scheme resolution.
1530pub mod auth;
1531