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