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
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
/* Automatically managed default lints */
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
/* End of automatically managed default lints */
#![allow(clippy::derive_partial_eq_without_eq)]
#![warn(
missing_debug_implementations,
missing_docs,
rust_2018_idioms,
rustdoc::missing_crate_level_docs,
unreachable_pub
)]
// Allow disallowed methods in tests
#![cfg_attr(test, allow(clippy::disallowed_methods))]
//! `aws-config` provides implementations of region and credential resolution.
//!
//! These implementations can be used either via the default chain implementation
//! [`from_env`]/[`ConfigLoader`] or ad-hoc individual credential and region providers.
//!
//! [`ConfigLoader`] can combine different configuration sources into an AWS shared-config:
//! [`SdkConfig`]. `SdkConfig` can be used configure an AWS service client.
//!
//! # Examples
//!
//! Load default SDK configuration:
//! ```no_run
//! use aws_config::BehaviorVersion;
//! mod aws_sdk_dynamodb {
//! # pub struct Client;
//! # impl Client {
//! # pub fn new(config: &aws_types::SdkConfig) -> Self { Client }
//! # }
//! # }
//! # async fn docs() {
//! let config = aws_config::load_defaults(BehaviorVersion::v2023_11_09()).await;
//! let client = aws_sdk_dynamodb::Client::new(&config);
//! # }
//! ```
//!
//! Load SDK configuration with a region override:
//! ```no_run
//! # mod aws_sdk_dynamodb {
//! # pub struct Client;
//! # impl Client {
//! # pub fn new(config: &aws_types::SdkConfig) -> Self { Client }
//! # }
//! # }
//! # async fn docs() {
//! # use aws_config::meta::region::RegionProviderChain;
//! let region_provider = RegionProviderChain::default_provider().or_else("us-east-1");
//! // Note: requires the `behavior-version-latest` feature enabled
//! let config = aws_config::from_env().region(region_provider).load().await;
//! let client = aws_sdk_dynamodb::Client::new(&config);
//! # }
//! ```
//!
//! Override configuration after construction of `SdkConfig`:
//!
//! ```no_run
//! # use aws_credential_types::provider::ProvideCredentials;
//! # use aws_types::SdkConfig;
//! # mod aws_sdk_dynamodb {
//! # pub mod config {
//! # pub struct Builder;
//! # impl Builder {
//! # pub fn credentials_provider(
//! # self,
//! # credentials_provider: impl aws_credential_types::provider::ProvideCredentials + 'static) -> Self { self }
//! # pub fn build(self) -> Builder { self }
//! # }
//! # impl From<&aws_types::SdkConfig> for Builder {
//! # fn from(_: &aws_types::SdkConfig) -> Self {
//! # todo!()
//! # }
//! # }
//! # }
//! # pub struct Client;
//! # impl Client {
//! # pub fn from_conf(conf: config::Builder) -> Self { Client }
//! # pub fn new(config: &aws_types::SdkConfig) -> Self { Client }
//! # }
//! # }
//! # async fn docs() {
//! # use aws_config::meta::region::RegionProviderChain;
//! # fn custom_provider(base: &SdkConfig) -> impl ProvideCredentials {
//! # base.credentials_provider().unwrap().clone()
//! # }
//! let sdk_config = aws_config::load_defaults(aws_config::BehaviorVersion::latest()).await;
//! let custom_credentials_provider = custom_provider(&sdk_config);
//! let dynamo_config = aws_sdk_dynamodb::config::Builder::from(&sdk_config)
//! .credentials_provider(custom_credentials_provider)
//! .build();
//! let client = aws_sdk_dynamodb::Client::from_conf(dynamo_config);
//! # }
//! ```
pub use aws_smithy_runtime_api::client::behavior_version::BehaviorVersion;
// Re-export types from aws-types
pub use aws_types::{
app_name::{AppName, InvalidAppName},
region::Region,
SdkConfig,
};
/// Load default sources for all configuration with override support
pub use loader::ConfigLoader;
/// Types for configuring identity caching.
pub mod identity {
pub use aws_smithy_runtime::client::identity::IdentityCache;
pub use aws_smithy_runtime::client::identity::LazyCacheBuilder;
}
#[allow(dead_code)]
const PKG_VERSION: &str = env!("CARGO_PKG_VERSION");
mod http_credential_provider;
mod json_credentials;
#[cfg(test)]
mod test_case;
pub mod credential_process;
pub mod default_provider;
pub mod ecs;
mod env_service_config;
pub mod environment;
pub mod imds;
pub mod meta;
pub mod profile;
pub mod provider_config;
pub mod retry;
mod sensitive_command;
#[cfg(feature = "sso")]
pub mod sso;
pub mod stalled_stream_protection;
pub mod sts;
pub mod timeout;
pub mod web_identity_token;
/// Create a config loader with the _latest_ defaults.
///
/// This loader will always set [`BehaviorVersion::latest`].
///
/// # Examples
/// ```no_run
/// # async fn create_config() {
/// let config = aws_config::from_env().region("us-east-1").load().await;
/// # }
/// ```
#[cfg(feature = "behavior-version-latest")]
pub fn from_env() -> ConfigLoader {
ConfigLoader::default().behavior_version(BehaviorVersion::latest())
}
/// Load default configuration with the _latest_ defaults.
///
/// Convenience wrapper equivalent to `aws_config::load_defaults(BehaviorVersion::latest()).await`
#[cfg(feature = "behavior-version-latest")]
pub async fn load_from_env() -> SdkConfig {
from_env().load().await
}
/// Create a config loader with the _latest_ defaults.
#[cfg(not(feature = "behavior-version-latest"))]
#[deprecated(
note = "Use the `aws_config::defaults` function. If you don't care about future default behavior changes, you can continue to use this function by enabling the `behavior-version-latest` feature. Doing so will make this deprecation notice go away."
)]
pub fn from_env() -> ConfigLoader {
ConfigLoader::default().behavior_version(BehaviorVersion::latest())
}
/// Load default configuration with the _latest_ defaults.
#[cfg(not(feature = "behavior-version-latest"))]
#[deprecated(
note = "Use the `aws_config::load_defaults` function. If you don't care about future default behavior changes, you can continue to use this function by enabling the `behavior-version-latest` feature. Doing so will make this deprecation notice go away."
)]
pub async fn load_from_env() -> SdkConfig {
load_defaults(BehaviorVersion::latest()).await
}
/// Create a config loader with the defaults for the given behavior version.
///
/// # Examples
/// ```no_run
/// # async fn create_config() {
/// use aws_config::BehaviorVersion;
/// let config = aws_config::defaults(BehaviorVersion::v2023_11_09())
/// .region("us-east-1")
/// .load()
/// .await;
/// # }
/// ```
pub fn defaults(version: BehaviorVersion) -> ConfigLoader {
ConfigLoader::default().behavior_version(version)
}
/// Load default configuration with the given behavior version.
///
/// Convenience wrapper equivalent to `aws_config::defaults(behavior_version).load().await`
pub async fn load_defaults(version: BehaviorVersion) -> SdkConfig {
defaults(version).load().await
}
mod loader {
use crate::env_service_config::EnvServiceConfig;
use aws_credential_types::provider::{
token::{ProvideToken, SharedTokenProvider},
ProvideCredentials, SharedCredentialsProvider,
};
use aws_credential_types::Credentials;
use aws_smithy_async::rt::sleep::{default_async_sleep, AsyncSleep, SharedAsyncSleep};
use aws_smithy_async::time::{SharedTimeSource, TimeSource};
use aws_smithy_runtime_api::client::behavior_version::BehaviorVersion;
use aws_smithy_runtime_api::client::http::HttpClient;
use aws_smithy_runtime_api::client::identity::{ResolveCachedIdentity, SharedIdentityCache};
use aws_smithy_runtime_api::client::stalled_stream_protection::StalledStreamProtectionConfig;
use aws_smithy_runtime_api::shared::IntoShared;
use aws_smithy_types::retry::RetryConfig;
use aws_smithy_types::timeout::TimeoutConfig;
use aws_types::app_name::AppName;
use aws_types::docs_for;
use aws_types::origin::Origin;
use aws_types::os_shim_internal::{Env, Fs};
use aws_types::sdk_config::SharedHttpClient;
use aws_types::SdkConfig;
use crate::default_provider::{
app_name, credentials, endpoint_url, ignore_configured_endpoint_urls as ignore_ep, region,
retry_config, timeout_config, use_dual_stack, use_fips,
};
use crate::meta::region::ProvideRegion;
#[allow(deprecated)]
use crate::profile::profile_file::ProfileFiles;
use crate::provider_config::ProviderConfig;
#[derive(Default, Debug)]
enum CredentialsProviderOption {
/// No provider was set by the user. We can set up the default credentials provider chain.
#[default]
NotSet,
/// The credentials provider was explicitly unset. Do not set up a default chain.
ExplicitlyUnset,
/// Use the given credentials provider.
Set(SharedCredentialsProvider),
}
/// Load a cross-service [`SdkConfig`] from the environment
///
/// This builder supports overriding individual components of the generated config. Overriding a component
/// will skip the standard resolution chain from **for that component**. For example,
/// if you override the region provider, _even if that provider returns None_, the default region provider
/// chain will not be used.
#[derive(Default, Debug)]
pub struct ConfigLoader {
app_name: Option<AppName>,
identity_cache: Option<SharedIdentityCache>,
credentials_provider: CredentialsProviderOption,
token_provider: Option<SharedTokenProvider>,
endpoint_url: Option<String>,
region: Option<Box<dyn ProvideRegion>>,
retry_config: Option<RetryConfig>,
sleep: Option<SharedAsyncSleep>,
timeout_config: Option<TimeoutConfig>,
provider_config: Option<ProviderConfig>,
http_client: Option<SharedHttpClient>,
profile_name_override: Option<String>,
#[allow(deprecated)]
profile_files_override: Option<ProfileFiles>,
use_fips: Option<bool>,
use_dual_stack: Option<bool>,
time_source: Option<SharedTimeSource>,
stalled_stream_protection_config: Option<StalledStreamProtectionConfig>,
env: Option<Env>,
fs: Option<Fs>,
behavior_version: Option<BehaviorVersion>,
}
impl ConfigLoader {
/// Sets the [`BehaviorVersion`] used to build [`SdkConfig`].
pub fn behavior_version(mut self, behavior_version: BehaviorVersion) -> Self {
self.behavior_version = Some(behavior_version);
self
}
/// Override the region used to build [`SdkConfig`].
///
/// # Examples
/// ```no_run
/// # async fn create_config() {
/// use aws_types::region::Region;
/// let config = aws_config::from_env()
/// .region(Region::new("us-east-1"))
/// .load().await;
/// # }
/// ```
pub fn region(mut self, region: impl ProvideRegion + 'static) -> Self {
self.region = Some(Box::new(region));
self
}
/// Override the retry_config used to build [`SdkConfig`].
///
/// # Examples
/// ```no_run
/// # async fn create_config() {
/// use aws_config::retry::RetryConfig;
///
/// let config = aws_config::from_env()
/// .retry_config(RetryConfig::standard().with_max_attempts(2))
/// .load()
/// .await;
/// # }
/// ```
pub fn retry_config(mut self, retry_config: RetryConfig) -> Self {
self.retry_config = Some(retry_config);
self
}
/// Override the timeout config used to build [`SdkConfig`].
///
/// This will be merged with timeouts coming from the timeout information provider, which
/// currently includes a default `CONNECT` timeout of `3.1s`.
///
/// If you want to disable timeouts, use [`TimeoutConfig::disabled`]. If you want to disable
/// a specific timeout, use `TimeoutConfig::set_<type>(None)`.
///
/// **Note: This only sets timeouts for calls to AWS services.** Timeouts for the credentials
/// provider chain are configured separately.
///
/// # Examples
/// ```no_run
/// # use std::time::Duration;
/// # async fn create_config() {
/// use aws_config::timeout::TimeoutConfig;
///
/// let config = aws_config::from_env()
/// .timeout_config(
/// TimeoutConfig::builder()
/// .operation_timeout(Duration::from_secs(5))
/// .build()
/// )
/// .load()
/// .await;
/// # }
/// ```
pub fn timeout_config(mut self, timeout_config: TimeoutConfig) -> Self {
self.timeout_config = Some(timeout_config);
self
}
/// Override the sleep implementation for this [`ConfigLoader`].
///
/// The sleep implementation is used to create timeout futures.
/// You generally won't need to change this unless you're using an async runtime other
/// than Tokio.
pub fn sleep_impl(mut self, sleep: impl AsyncSleep + 'static) -> Self {
// it's possible that we could wrapping an `Arc in an `Arc` and that's OK
self.sleep = Some(sleep.into_shared());
self
}
/// Set the time source used for tasks like signing requests.
///
/// You generally won't need to change this unless you're compiling for a target
/// that can't provide a default, such as WASM, or unless you're writing a test against
/// the client that needs a fixed time.
pub fn time_source(mut self, time_source: impl TimeSource + 'static) -> Self {
self.time_source = Some(time_source.into_shared());
self
}
/// Override the [`HttpClient`] for this [`ConfigLoader`].
///
/// The HTTP client will be used for both AWS services and credentials providers.
///
/// If you wish to use a separate HTTP client for credentials providers when creating clients,
/// then override the HTTP client set with this function on the client-specific `Config`s.
///
/// ## Examples
///
/// ```no_run
/// # use aws_smithy_async::rt::sleep::SharedAsyncSleep;
/// #[cfg(feature = "client-hyper")]
/// # async fn create_config() {
/// use std::time::Duration;
/// use aws_smithy_runtime::client::http::hyper_014::HyperClientBuilder;
///
/// let tls_connector = hyper_rustls::HttpsConnectorBuilder::new()
/// .with_webpki_roots()
/// // NOTE: setting `https_only()` will not allow this connector to work with IMDS.
/// .https_only()
/// .enable_http1()
/// .enable_http2()
/// .build();
///
/// let hyper_client = HyperClientBuilder::new().build(tls_connector);
/// let sdk_config = aws_config::from_env()
/// .http_client(hyper_client)
/// .load()
/// .await;
/// # }
/// ```
pub fn http_client(mut self, http_client: impl HttpClient + 'static) -> Self {
self.http_client = Some(http_client.into_shared());
self
}
/// Override the identity cache used to build [`SdkConfig`].
///
/// The identity cache caches AWS credentials and SSO tokens. By default, a lazy cache is used
/// that will load credentials upon first request, cache them, and then reload them during
/// another request when they are close to expiring.
///
/// # Examples
///
/// Change a setting on the default lazy caching implementation:
/// ```no_run
/// use aws_config::identity::IdentityCache;
/// use std::time::Duration;
///
/// # async fn create_config() {
/// let config = aws_config::from_env()
/// .identity_cache(
/// IdentityCache::lazy()
/// // Change the load timeout to 10 seconds.
/// // Note: there are other timeouts that could trigger if the load timeout is too long.
/// .load_timeout(Duration::from_secs(10))
/// .build()
/// )
/// .load()
/// .await;
/// # }
/// ```
pub fn identity_cache(
mut self,
identity_cache: impl ResolveCachedIdentity + 'static,
) -> Self {
self.identity_cache = Some(identity_cache.into_shared());
self
}
/// Override the credentials provider used to build [`SdkConfig`].
///
/// # Examples
///
/// Override the credentials provider but load the default value for region:
/// ```no_run
/// # use aws_credential_types::Credentials;
/// # fn create_my_credential_provider() -> Credentials {
/// # Credentials::new("example", "example", None, None, "example")
/// # }
/// # async fn create_config() {
/// let config = aws_config::from_env()
/// .credentials_provider(create_my_credential_provider())
/// .load()
/// .await;
/// # }
/// ```
pub fn credentials_provider(
mut self,
credentials_provider: impl ProvideCredentials + 'static,
) -> Self {
self.credentials_provider = CredentialsProviderOption::Set(
SharedCredentialsProvider::new(credentials_provider),
);
self
}
/// Don't use credentials to sign requests.
///
/// Turning off signing with credentials is necessary in some cases, such as using
/// anonymous auth for S3, calling operations in STS that don't require a signature,
/// or using token-based auth.
///
/// **Note**: For tests, e.g. with a service like DynamoDB Local, this is **not** what you
/// want. If credentials are disabled, requests cannot be signed. For these use cases, use
/// [`test_credentials`](Self::test_credentials).
///
/// # Examples
///
/// Turn off credentials in order to call a service without signing:
/// ```no_run
/// # async fn create_config() {
/// let config = aws_config::from_env()
/// .no_credentials()
/// .load()
/// .await;
/// # }
/// ```
pub fn no_credentials(mut self) -> Self {
self.credentials_provider = CredentialsProviderOption::ExplicitlyUnset;
self
}
/// Set test credentials for use when signing requests
pub fn test_credentials(self) -> Self {
#[allow(unused_mut)]
let mut ret = self.credentials_provider(Credentials::for_tests());
#[cfg(all(feature = "sso", feature = "test-util"))]
{
use aws_smithy_runtime_api::client::identity::http::Token;
ret = ret.token_provider(Token::for_tests());
}
ret
}
/// Override the access token provider used to build [`SdkConfig`].
///
/// # Examples
///
/// Override the token provider but load the default value for region:
/// ```no_run
/// # use aws_credential_types::Token;
/// # fn create_my_token_provider() -> Token {
/// # Token::new("example", None)
/// # }
/// # async fn create_config() {
/// let config = aws_config::from_env()
/// .token_provider(create_my_token_provider())
/// .load()
/// .await;
/// # }
/// ```
pub fn token_provider(mut self, token_provider: impl ProvideToken + 'static) -> Self {
self.token_provider = Some(SharedTokenProvider::new(token_provider));
self
}
/// Override the name of the app used to build [`SdkConfig`].
///
/// This _optional_ name is used to identify the application in the user agent that
/// gets sent along with requests.
///
/// # Examples
/// ```no_run
/// # async fn create_config() {
/// use aws_config::AppName;
/// let config = aws_config::from_env()
/// .app_name(AppName::new("my-app-name").expect("valid app name"))
/// .load().await;
/// # }
/// ```
pub fn app_name(mut self, app_name: AppName) -> Self {
self.app_name = Some(app_name);
self
}
/// Provides the ability to programmatically override the profile files that get loaded by the SDK.
///
/// The [`Default`] for `ProfileFiles` includes the default SDK config and credential files located in
/// `~/.aws/config` and `~/.aws/credentials` respectively.
///
/// Any number of config and credential files may be added to the `ProfileFiles` file set, with the
/// only requirement being that there is at least one of each. Profile file locations will produce an
/// error if they don't exist, but the default config/credentials files paths are exempt from this validation.
///
/// # Example: Using a custom profile file path
///
/// ```no_run
/// use aws_config::profile::{ProfileFileCredentialsProvider, ProfileFileRegionProvider};
/// use aws_config::profile::profile_file::{ProfileFiles, ProfileFileKind};
///
/// # async fn example() {
/// let profile_files = ProfileFiles::builder()
/// .with_file(ProfileFileKind::Credentials, "some/path/to/credentials-file")
/// .build();
/// let sdk_config = aws_config::from_env()
/// .profile_files(profile_files)
/// .load()
/// .await;
/// # }
#[allow(deprecated)]
pub fn profile_files(mut self, profile_files: ProfileFiles) -> Self {
self.profile_files_override = Some(profile_files);
self
}
/// Override the profile name used by configuration providers
///
/// Profile name is selected from an ordered list of sources:
/// 1. This override.
/// 2. The value of the `AWS_PROFILE` environment variable.
/// 3. `default`
///
/// Each AWS profile has a name. For example, in the file below, the profiles are named
/// `dev`, `prod` and `staging`:
/// ```ini
/// [dev]
/// ec2_metadata_service_endpoint = http://my-custom-endpoint:444
///
/// [staging]
/// ec2_metadata_service_endpoint = http://my-custom-endpoint:444
///
/// [prod]
/// ec2_metadata_service_endpoint = http://my-custom-endpoint:444
/// ```
///
/// See [Named profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html)
/// for more information about naming profiles.
///
/// # Example: Using a custom profile name
///
/// ```no_run
/// use aws_config::profile::{ProfileFileCredentialsProvider, ProfileFileRegionProvider};
///
/// # async fn example() {
/// let sdk_config = aws_config::from_env()
/// .profile_name("prod")
/// .load()
/// .await;
/// # }
pub fn profile_name(mut self, profile_name: impl Into<String>) -> Self {
self.profile_name_override = Some(profile_name.into());
self
}
/// Override the endpoint URL used for **all** AWS services.
///
/// This method will override the endpoint URL used for **all** AWS services. This primarily
/// exists to set a static endpoint for tools like `LocalStack`. When sending requests to
/// production AWS services, this method should only be used for service-specific behavior.
///
/// When this method is used, the [`Region`](aws_types::region::Region) is only used for signing;
/// It is **not** used to route the request.
///
/// # Examples
///
/// Use a static endpoint for all services
/// ```no_run
/// # async fn create_config() {
/// let sdk_config = aws_config::from_env()
/// .endpoint_url("http://localhost:1234")
/// .load()
/// .await;
/// # }
pub fn endpoint_url(mut self, endpoint_url: impl Into<String>) -> Self {
self.endpoint_url = Some(endpoint_url.into());
self
}
#[doc = docs_for!(use_fips)]
pub fn use_fips(mut self, use_fips: bool) -> Self {
self.use_fips = Some(use_fips);
self
}
#[doc = docs_for!(use_dual_stack)]
pub fn use_dual_stack(mut self, use_dual_stack: bool) -> Self {
self.use_dual_stack = Some(use_dual_stack);
self
}
/// Override the [`StalledStreamProtectionConfig`] used to build [`SdkConfig`].
///
/// This configures stalled stream protection. When enabled, download streams
/// that stop (stream no data) for longer than a configured grace period will return an error.
///
/// By default, streams that transmit less than one byte per-second for five seconds will
/// be cancelled.
///
/// _Note_: When an override is provided, the default implementation is replaced.
///
/// # Examples
/// ```no_run
/// # async fn create_config() {
/// use aws_config::stalled_stream_protection::StalledStreamProtectionConfig;
/// use std::time::Duration;
/// let config = aws_config::from_env()
/// .stalled_stream_protection(
/// StalledStreamProtectionConfig::enabled()
/// .grace_period(Duration::from_secs(1))
/// .build()
/// )
/// .load()
/// .await;
/// # }
/// ```
pub fn stalled_stream_protection(
mut self,
stalled_stream_protection_config: StalledStreamProtectionConfig,
) -> Self {
self.stalled_stream_protection_config = Some(stalled_stream_protection_config);
self
}
/// Load the default configuration chain
///
/// If fields have been overridden during builder construction, the override values will be used.
///
/// Otherwise, the default values for each field will be provided.
///
/// NOTE: When an override is provided, the default implementation is **not** used as a fallback.
/// This means that if you provide a region provider that does not return a region, no region will
/// be set in the resulting [`SdkConfig`].
pub async fn load(self) -> SdkConfig {
let time_source = self.time_source.unwrap_or_default();
let sleep_impl = if self.sleep.is_some() {
self.sleep
} else {
if default_async_sleep().is_none() {
tracing::warn!(
"An implementation of AsyncSleep was requested by calling default_async_sleep \
but no default was set.
This happened when ConfigLoader::load was called during Config construction. \
You can fix this by setting a sleep_impl on the ConfigLoader before calling \
load or by enabling the rt-tokio feature"
);
}
default_async_sleep()
};
let conf = self
.provider_config
.unwrap_or_else(|| {
let mut config = ProviderConfig::init(time_source.clone(), sleep_impl.clone())
.with_fs(self.fs.unwrap_or_default())
.with_env(self.env.unwrap_or_default());
if let Some(http_client) = self.http_client.clone() {
config = config.with_http_client(http_client);
}
config
})
.with_profile_config(self.profile_files_override, self.profile_name_override);
let use_fips = if let Some(use_fips) = self.use_fips {
Some(use_fips)
} else {
use_fips::use_fips_provider(&conf).await
};
let use_dual_stack = if let Some(use_dual_stack) = self.use_dual_stack {
Some(use_dual_stack)
} else {
use_dual_stack::use_dual_stack_provider(&conf).await
};
let conf = conf
.with_use_fips(use_fips)
.with_use_dual_stack(use_dual_stack);
let region = if let Some(provider) = self.region {
provider.region().await
} else {
region::Builder::default()
.configure(&conf)
.build()
.region()
.await
};
let retry_config = if let Some(retry_config) = self.retry_config {
retry_config
} else {
retry_config::default_provider()
.configure(&conf)
.retry_config()
.await
};
let app_name = if self.app_name.is_some() {
self.app_name
} else {
app_name::default_provider()
.configure(&conf)
.app_name()
.await
};
let base_config = timeout_config::default_provider()
.configure(&conf)
.timeout_config()
.await;
let mut timeout_config = self
.timeout_config
.unwrap_or_else(|| TimeoutConfig::builder().build());
timeout_config.take_defaults_from(&base_config);
let credentials_provider = match self.credentials_provider {
CredentialsProviderOption::Set(provider) => Some(provider),
CredentialsProviderOption::NotSet => {
let mut builder =
credentials::DefaultCredentialsChain::builder().configure(conf.clone());
builder.set_region(region.clone());
Some(SharedCredentialsProvider::new(builder.build().await))
}
CredentialsProviderOption::ExplicitlyUnset => None,
};
let token_provider = match self.token_provider {
Some(provider) => Some(provider),
None => {
#[cfg(feature = "sso")]
{
let mut builder =
crate::default_provider::token::DefaultTokenChain::builder()
.configure(conf.clone());
builder.set_region(region.clone());
Some(SharedTokenProvider::new(builder.build().await))
}
#[cfg(not(feature = "sso"))]
{
None
}
}
};
let profiles = conf.profile().await;
let service_config = EnvServiceConfig {
env: conf.env(),
env_config_sections: profiles.cloned().unwrap_or_default(),
};
let mut builder = SdkConfig::builder()
.region(region)
.retry_config(retry_config)
.timeout_config(timeout_config)
.time_source(time_source)
.service_config(service_config);
// If an endpoint URL is set programmatically, then our work is done.
let endpoint_url = if self.endpoint_url.is_some() {
builder.insert_origin("endpoint_url", Origin::shared_config());
self.endpoint_url
} else {
// Otherwise, check to see if we should ignore EP URLs set in the environment.
let ignore_configured_endpoint_urls =
ignore_ep::ignore_configured_endpoint_urls_provider(&conf)
.await
.unwrap_or_default();
if ignore_configured_endpoint_urls {
// If yes, log a trace and return `None`.
tracing::trace!(
"`ignore_configured_endpoint_urls` is set, any endpoint URLs configured in the environment will be ignored. \
NOTE: Endpoint URLs set programmatically WILL still be respected"
);
None
} else {
// Otherwise, attempt to resolve one.
let (v, origin) = endpoint_url::endpoint_url_provider_with_origin(&conf).await;
builder.insert_origin("endpoint_url", origin);
v
}
};
builder.set_endpoint_url(endpoint_url);
builder.set_behavior_version(self.behavior_version);
builder.set_http_client(self.http_client);
builder.set_app_name(app_name);
builder.set_identity_cache(self.identity_cache);
builder.set_credentials_provider(credentials_provider);
builder.set_token_provider(token_provider);
builder.set_sleep_impl(sleep_impl);
builder.set_use_fips(use_fips);
builder.set_use_dual_stack(use_dual_stack);
builder.set_stalled_stream_protection(self.stalled_stream_protection_config);
builder.build()
}
}
#[cfg(test)]
impl ConfigLoader {
pub(crate) fn env(mut self, env: Env) -> Self {
self.env = Some(env);
self
}
pub(crate) fn fs(mut self, fs: Fs) -> Self {
self.fs = Some(fs);
self
}
}
#[cfg(test)]
mod test {
#[allow(deprecated)]
use crate::profile::profile_file::{ProfileFileKind, ProfileFiles};
use crate::test_case::{no_traffic_client, InstantSleep};
use crate::BehaviorVersion;
use crate::{defaults, ConfigLoader};
use aws_credential_types::provider::ProvideCredentials;
use aws_smithy_async::rt::sleep::TokioSleep;
use aws_smithy_runtime::client::http::test_util::{infallible_client_fn, NeverClient};
use aws_smithy_runtime::test_util::capture_test_logs::capture_test_logs;
use aws_types::app_name::AppName;
use aws_types::origin::Origin;
use aws_types::os_shim_internal::{Env, Fs};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
#[tokio::test]
async fn provider_config_used() {
let (_guard, logs_rx) = capture_test_logs();
let env = Env::from_slice(&[
("AWS_MAX_ATTEMPTS", "10"),
("AWS_REGION", "us-west-4"),
("AWS_ACCESS_KEY_ID", "akid"),
("AWS_SECRET_ACCESS_KEY", "secret"),
]);
let fs =
Fs::from_slice(&[("test_config", "[profile custom]\nsdk-ua-app-id = correct")]);
let loader = defaults(BehaviorVersion::latest())
.sleep_impl(TokioSleep::new())
.env(env)
.fs(fs)
.http_client(NeverClient::new())
.profile_name("custom")
.profile_files(
#[allow(deprecated)]
ProfileFiles::builder()
.with_file(
#[allow(deprecated)]
ProfileFileKind::Config,
"test_config",
)
.build(),
)
.load()
.await;
assert_eq!(10, loader.retry_config().unwrap().max_attempts());
assert_eq!("us-west-4", loader.region().unwrap().as_ref());
assert_eq!(
"akid",
loader
.credentials_provider()
.unwrap()
.provide_credentials()
.await
.unwrap()
.access_key_id(),
);
assert_eq!(Some(&AppName::new("correct").unwrap()), loader.app_name());
let num_config_loader_logs = logs_rx.contents()
.lines()
// The logger uses fancy formatting, so we have to account for that.
.filter(|l| l.contains("config file loaded \u{1b}[3mpath\u{1b}[0m\u{1b}[2m=\u{1b}[0mSome(\"test_config\") \u{1b}[3msize\u{1b}[0m\u{1b}[2m=\u{1b}"))
.count();
match num_config_loader_logs {
0 => panic!("no config file logs found!"),
1 => (),
more => panic!("the config file was parsed more than once! (parsed {more})",),
};
}
fn base_conf() -> ConfigLoader {
defaults(BehaviorVersion::latest())
.sleep_impl(InstantSleep)
.http_client(no_traffic_client())
}
#[tokio::test]
async fn test_origin_programmatic() {
let _ = tracing_subscriber::fmt::try_init();
let loader = base_conf()
.test_credentials()
.profile_name("custom")
.profile_files(
#[allow(deprecated)]
ProfileFiles::builder()
.with_contents(
#[allow(deprecated)]
ProfileFileKind::Config,
"[profile custom]\nendpoint_url = http://localhost:8989",
)
.build(),
)
.endpoint_url("http://localhost:1111")
.load()
.await;
assert_eq!(Origin::shared_config(), loader.get_origin("endpoint_url"));
}
#[tokio::test]
async fn test_origin_env() {
let _ = tracing_subscriber::fmt::try_init();
let env = Env::from_slice(&[("AWS_ENDPOINT_URL", "http://localhost:7878")]);
let loader = base_conf()
.test_credentials()
.env(env)
.profile_name("custom")
.profile_files(
#[allow(deprecated)]
ProfileFiles::builder()
.with_contents(
#[allow(deprecated)]
ProfileFileKind::Config,
"[profile custom]\nendpoint_url = http://localhost:8989",
)
.build(),
)
.load()
.await;
assert_eq!(
Origin::shared_environment_variable(),
loader.get_origin("endpoint_url")
);
}
#[tokio::test]
async fn test_origin_fs() {
let _ = tracing_subscriber::fmt::try_init();
let loader = base_conf()
.test_credentials()
.profile_name("custom")
.profile_files(
#[allow(deprecated)]
ProfileFiles::builder()
.with_contents(
#[allow(deprecated)]
ProfileFileKind::Config,
"[profile custom]\nendpoint_url = http://localhost:8989",
)
.build(),
)
.load()
.await;
assert_eq!(
Origin::shared_profile_file(),
loader.get_origin("endpoint_url")
);
}
#[tokio::test]
async fn load_fips() {
let conf = base_conf().use_fips(true).load().await;
assert_eq!(Some(true), conf.use_fips());
}
#[tokio::test]
async fn load_dual_stack() {
let conf = base_conf().use_dual_stack(false).load().await;
assert_eq!(Some(false), conf.use_dual_stack());
let conf = base_conf().load().await;
assert_eq!(None, conf.use_dual_stack());
}
#[tokio::test]
async fn app_name() {
let app_name = AppName::new("my-app-name").unwrap();
let conf = base_conf().app_name(app_name.clone()).load().await;
assert_eq!(Some(&app_name), conf.app_name());
}
#[cfg(feature = "rustls")]
#[tokio::test]
async fn disable_default_credentials() {
let config = defaults(BehaviorVersion::latest())
.no_credentials()
.load()
.await;
assert!(config.identity_cache().is_none());
assert!(config.credentials_provider().is_none());
}
#[tokio::test]
async fn connector_is_shared() {
let num_requests = Arc::new(AtomicUsize::new(0));
let movable = num_requests.clone();
let http_client = infallible_client_fn(move |_req| {
movable.fetch_add(1, Ordering::Relaxed);
http::Response::new("ok!")
});
let config = defaults(BehaviorVersion::latest())
.fs(Fs::from_slice(&[]))
.env(Env::from_slice(&[]))
.http_client(http_client.clone())
.load()
.await;
config
.credentials_provider()
.unwrap()
.provide_credentials()
.await
.expect_err("did not expect credentials to be loaded—no traffic is allowed");
let num_requests = num_requests.load(Ordering::Relaxed);
assert!(num_requests > 0, "{}", num_requests);
}
#[tokio::test]
async fn endpoint_urls_may_be_ignored_from_env() {
let fs = Fs::from_slice(&[(
"test_config",
"[profile custom]\nendpoint_url = http://profile",
)]);
let env = Env::from_slice(&[("AWS_IGNORE_CONFIGURED_ENDPOINT_URLS", "true")]);
let conf = base_conf().use_dual_stack(false).load().await;
assert_eq!(Some(false), conf.use_dual_stack());
let conf = base_conf().load().await;
assert_eq!(None, conf.use_dual_stack());
// Check that we get nothing back because the env said we should ignore endpoints
let config = base_conf()
.fs(fs.clone())
.env(env)
.profile_name("custom")
.profile_files(
#[allow(deprecated)]
ProfileFiles::builder()
.with_file(
#[allow(deprecated)]
ProfileFileKind::Config,
"test_config",
)
.build(),
)
.load()
.await;
assert_eq!(None, config.endpoint_url());
// Check that without the env, we DO get something back
let config = base_conf()
.fs(fs)
.profile_name("custom")
.profile_files(
#[allow(deprecated)]
ProfileFiles::builder()
.with_file(
#[allow(deprecated)]
ProfileFileKind::Config,
"test_config",
)
.build(),
)
.load()
.await;
assert_eq!(Some("http://profile"), config.endpoint_url());
}
#[tokio::test]
async fn endpoint_urls_may_be_ignored_from_profile() {
let fs = Fs::from_slice(&[(
"test_config",
"[profile custom]\nignore_configured_endpoint_urls = true",
)]);
let env = Env::from_slice(&[("AWS_ENDPOINT_URL", "http://environment")]);
// Check that we get nothing back because the profile said we should ignore endpoints
let config = base_conf()
.fs(fs)
.env(env.clone())
.profile_name("custom")
.profile_files(
#[allow(deprecated)]
ProfileFiles::builder()
.with_file(
#[allow(deprecated)]
ProfileFileKind::Config,
"test_config",
)
.build(),
)
.load()
.await;
assert_eq!(None, config.endpoint_url());
// Check that without the profile, we DO get something back
let config = base_conf().env(env).load().await;
assert_eq!(Some("http://environment"), config.endpoint_url());
}
#[tokio::test]
async fn programmatic_endpoint_urls_may_not_be_ignored() {
let fs = Fs::from_slice(&[(
"test_config",
"[profile custom]\nignore_configured_endpoint_urls = true",
)]);
let env = Env::from_slice(&[("AWS_IGNORE_CONFIGURED_ENDPOINT_URLS", "true")]);
// Check that we get something back because we explicitly set the loader's endpoint URL
let config = base_conf()
.fs(fs)
.env(env)
.endpoint_url("http://localhost")
.profile_name("custom")
.profile_files(
#[allow(deprecated)]
ProfileFiles::builder()
.with_file(
#[allow(deprecated)]
ProfileFileKind::Config,
"test_config",
)
.build(),
)
.load()
.await;
assert_eq!(Some("http://localhost"), config.endpoint_url());
}
}
}