pub struct ProfileFileRegionProvider { /* private fields */ }
Expand description
Load a region from a profile file
This provider will attempt to load AWS shared configuration, then read the region
property
from the active profile.
§Location of Profile Files
- The location of the config file will be loaded from the
AWS_CONFIG_FILE
environment variable with a fallback to~/.aws/config
- The location of the credentials file will be loaded from the
AWS_SHARED_CREDENTIALS_FILE
environment variable with a fallback to~/.aws/credentials
The location of these files can also be customized programmatically using ProfileFiles
.
§Home directory resolution
Home directory resolution is implemented to match the behavior of the CLI & Python. ~
is only
used for home directory resolution when it:
- Starts the path
- Is followed immediately by
/
or a platform specific separator. (On windows,~/
and~\
both resolve to the home directory.
When determining the home directory, the following environment variables are checked:
HOME
on all platformsUSERPROFILE
on Windows- The concatenation of
HOMEDRIVE
andHOMEPATH
on Windows ($HOMEDRIVE$HOMEPATH
)
§Examples
Loads “us-west-2” as the region
[default]
region = us-west-2
Loads us-east-1
as the region if and only if the AWS_PROFILE
environment variable is set
to other
.
[profile other]
region = us-east-1
This provider is part of the default region provider chain.
Implementations§
Source§impl ProfileFileRegionProvider
impl ProfileFileRegionProvider
Sourcepub fn new() -> Self
pub fn new() -> Self
Create a new ProfileFileRegionProvider
To override the selected profile, set the AWS_PROFILE
environment variable or use the Builder
.
Sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Builder
to construct a ProfileFileRegionProvider
Trait Implementations§
Source§impl Debug for ProfileFileRegionProvider
impl Debug for ProfileFileRegionProvider
Source§impl Default for ProfileFileRegionProvider
impl Default for ProfileFileRegionProvider
Source§fn default() -> ProfileFileRegionProvider
fn default() -> ProfileFileRegionProvider
Source§impl ProvideRegion for ProfileFileRegionProvider
impl ProvideRegion for ProfileFileRegionProvider
Source§fn region(&self) -> ProvideRegion<'_> ⓘ
fn region(&self) -> ProvideRegion<'_> ⓘ
Auto Trait Implementations§
impl Freeze for ProfileFileRegionProvider
impl !RefUnwindSafe for ProfileFileRegionProvider
impl Send for ProfileFileRegionProvider
impl Sync for ProfileFileRegionProvider
impl Unpin for ProfileFileRegionProvider
impl !UnwindSafe for ProfileFileRegionProvider
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more