Struct ProfileProvider

pub struct ProfileProvider { /* private fields */ }

Provides AWS credentials from a profile in a credentials file, or from a credential process.

Warning

This provider allows the credential_process option, a method of sourcing credentials from an external process. This can potentially be dangerous, so proceed with caution. Other credential providers should be preferred if at all possible. If using this option, you should make sure that the config file is as locked down as possible using security best practices for your operating system.

Implementations

impl ProfileProvider

pub fn new() -> Result<ProfileProvider, CredentialsError>

Create a new ProfileProvider for the default credentials file path and profile name.

pub fn with_configuration<F, P>(file_path: F, profile: P) -> ProfileProvider

where F: Into<PathBuf>, P: Into<String>,

Create a new ProfileProvider for the credentials file at the given path, using the given profile.

pub fn with_default_configuration<F>(file_path: F) -> ProfileProvider

where F: Into<PathBuf>,

Create a new ProfileProvider for the credentials file at the given path, using the profile name from environment variable AWS_PROFILE or fall-back to "default" if AWS_PROFILE is not set.

pub fn with_default_credentials<P>( profile: P, ) -> Result<ProfileProvider, CredentialsError>

where P: Into<String>,

Create a new ProfileProvider for the default credentials file path using the given profile.

pub fn region() -> Result<Option<String>, CredentialsError>

Attempts to resolve a region value associated with the current default profile from ~/.aws/config or the file associated with the AWS_CONFIG_FILE environment variable. As these fields do not require a region field to be defined, an Option type is returned

For a the ful region resolution chain, use the Default impl for rusoto_core::Region

pub fn region_from_profile(&self) -> Result<Option<String>, CredentialsError>

Attempts to resolve the region value associated with the current ProfileProviders config file path (ProfileProvider.file_path) and profile (ProfileProvider.profile). As these fields do not require a region field to be defined, an Option type is returned

pub fn file_path(&self) -> &Path

Get a reference to the credentials file path.

pub fn profile(&self) -> &str

Get a reference to the profile name.

pub fn set_file_path<F>(&mut self, file_path: F)

where F: Into<PathBuf>,

Set the credentials file path.

pub fn set_profile<P>(&mut self, profile: P)

where P: Into<String>,

Set the profile name.

Trait Implementations

impl Clone for ProfileProvider

fn clone(&self) -> ProfileProvider

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProfileProvider

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

Formats the value using the given formatter.

impl ProvideAwsCredentials for ProfileProvider

fn credentials<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<AwsCredentials, CredentialsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Produce a new AwsCredentials future.