Struct Credentials 

pub struct Credentials {
    pub access_key: Option<String>,
    pub secret_key: Option<String>,
    pub security_token: Option<String>,
    pub session_token: Option<String>,
    pub expiration: Option<Rfc3339OffsetDateTime>,
}

AWS access credentials: access key, secret key, and optional token.

Example

Loads from the standard AWS credentials file with the given profile name, defaults to “default”.

use awscreds::Credentials;

// Load credentials from `[default]` profile
let credentials = Credentials::default();

// Also loads credentials from `[default]` profile
let credentials = Credentials::new(None, None, None, None, None);

// Load credentials from `[my-profile]` profile
let credentials = Credentials::new(None, None, None, None, Some("my-profile".into()));

// Use anonymous credentials for public objects
let credentials = Credentials::anonymous();

Credentials may also be initialized directly or by the following environment variables:

• AWS_ACCESS_KEY_ID,
• AWS_SECRET_ACCESS_KEY
• AWS_SESSION_TOKEN

The order of preference is arguments, then environment, and finally AWS credentials file.

use awscreds::Credentials;

// Load credentials directly
let access_key = "AKIAIOSFODNN7EXAMPLE";
let secret_key = "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY";
let credentials = Credentials::new(Some(access_key), Some(secret_key), None, None, None);

// Load credentials from the environment
use std::env;
env::set_var("AWS_ACCESS_KEY_ID", "AKIAIOSFODNN7EXAMPLE");
env::set_var("AWS_SECRET_ACCESS_KEY", "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY");
let credentials = Credentials::new(None, None, None, None, None);

Fields

access_key: Option<String>

AWS public access key.

secret_key: Option<String>

AWS secret key.

security_token: Option<String>

Temporary token issued by AWS service.

session_token: Option<String>

expiration: Option<Rfc3339OffsetDateTime>

Implementations

impl Credentials

pub fn refresh(&mut self) -> Result<(), CredentialsError>

pub fn from_sts_env(session_name: &str) -> Result<Credentials, CredentialsError>

pub fn from_sts( role_arn: &str, session_name: &str, web_identity_token: &str, ) -> Result<Credentials, CredentialsError>

pub fn default() -> Result<Credentials, CredentialsError>

pub fn anonymous() -> Result<Credentials, CredentialsError>

pub fn new( access_key: Option<&str>, secret_key: Option<&str>, security_token: Option<&str>, session_token: Option<&str>, profile: Option<&str>, ) -> Result<Credentials, CredentialsError>

Initialize Credentials directly with key ID, secret key, and optional token.

pub fn from_env_specific( access_key_var: Option<&str>, secret_key_var: Option<&str>, security_token_var: Option<&str>, session_token_var: Option<&str>, ) -> Result<Credentials, CredentialsError>

pub fn from_env() -> Result<Credentials, CredentialsError>

pub fn from_container_credentials_provider() -> Result<Credentials, CredentialsError>

pub fn from_instance_metadata( not_ec2: bool, ) -> Result<Credentials, CredentialsError>

pub fn from_instance_metadata_v2( not_ec2: bool, ) -> Result<Credentials, CredentialsError>

pub fn from_credentials_file<P: AsRef<Path>>( file: P, section: Option<&str>, ) -> Result<Credentials, CredentialsError>

Load credentials from a specific credentials file.

This method allows loading AWS credentials from a custom file location, which is useful when credentials are stored in a non-standard location.

Arguments

• file - Path to the credentials file
• section - Optional profile name to load (defaults to “default”)

Example

use awscreds::Credentials;

let credentials = Credentials::from_credentials_file(
    "/custom/path/credentials",
    Some("production")
).unwrap();

pub fn from_profile( section: Option<&str>, ) -> Result<Credentials, CredentialsError>

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credentials

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Credentials

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Credentials

fn eq(&self, other: &Credentials) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Credentials

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Credentials

impl StructuralPartialEq for Credentials