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