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