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