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