Struct aws_config::profile::region::ProfileFileRegionProvider

pub struct ProfileFileRegionProvider { /* private fields */ }

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 platforms
• USERPROFILE on Windows
• The concatenation of HOMEDRIVE and HOMEPATH 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

impl ProfileFileRegionProvider

pub fn new() -> Self

Create a new ProfileFileRegionProvider

To override the selected profile, set the AWS_PROFILE environment variable or use the Builder.

pub fn builder() -> Builder

Builder to construct a ProfileFileRegionProvider

Trait Implementations

impl Debug for ProfileFileRegionProvider

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProfileFileRegionProvider

fn default() -> ProfileFileRegionProvider

Returns the “default value” for a type.

impl ProvideRegion for ProfileFileRegionProvider

fn region(&self) -> ProvideRegion<'_>

Load a region from this provider