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