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