Struct rusoto_credential::EnvironmentProvider

pub struct EnvironmentProvider { /* private fields */ }

Provides AWS credentials from environment variables.

Available Environment Variables

• AWS_ACCESS_KEY_ID:

  Access key ID

• AWS_SECRET_ACCESS_KEY:

  Secret access key

• AWS_SESSION_TOKEN:

  Session token

• AWS_CREDENTIAL_EXPIRATION:

  Expiration time in RFC 3339 format (e.g. 1996-12-19T16:39:57-08:00). If unset, credentials won’t expire.

Example

use futures::future::Future;
use rusoto_credential::{EnvironmentProvider, ProvideAwsCredentials};
use std::env;

#[tokio::main]
async fn main() {
    env::set_var("AWS_ACCESS_KEY_ID", "ANTN35UAENTS5UIAEATD");
    env::set_var("AWS_SECRET_ACCESS_KEY", "TtnuieannGt2rGuie2t8Tt7urarg5nauedRndrur");
    env::set_var("AWS_SESSION_TOKEN", "DfnGs8Td4rT8r4srxAg6Td4rT8r4srxAg6GtkTir");

    let creds = EnvironmentProvider::default().credentials().await.unwrap();

    assert_eq!(creds.aws_access_key_id(), "ANTN35UAENTS5UIAEATD");
    assert_eq!(creds.aws_secret_access_key(), "TtnuieannGt2rGuie2t8Tt7urarg5nauedRndrur");
    assert_eq!(creds.token(), &Some("DfnGs8Td4rT8r4srxAg6Td4rT8r4srxAg6GtkTir".to_string()));
    assert!(creds.expires_at().is_none()); // doesn't expire

    env::set_var("AWS_CREDENTIAL_EXPIRATION", "2018-04-21T01:13:02Z");
    let creds = EnvironmentProvider::default().credentials().await.unwrap();
    assert_eq!(creds.expires_at().unwrap().to_rfc3339(), "2018-04-21T01:13:02+00:00");
}

Implementations

impl EnvironmentProvider

pub fn with_prefix(prefix: &str) -> Self

Create an EnvironmentProvider with a non-standard variable prefix.

use std::future::Future;
use rusoto_credential::{EnvironmentProvider, ProvideAwsCredentials};
use std::env;

#[tokio::main]
async fn main() -> () {
    env::set_var("MYAPP_ACCESS_KEY_ID", "ANTN35UAENTS5UIAEATD");
    env::set_var("MYAPP_SECRET_ACCESS_KEY", "TtnuieannGt2rGuie2t8Tt7urarg5nauedRndrur");
    env::set_var("MYAPP_SESSION_TOKEN", "DfnGs8Td4rT8r4srxAg6Td4rT8r4srxAg6GtkTir");

    let creds = EnvironmentProvider::with_prefix("MYAPP").credentials().await.unwrap();

    assert_eq!(creds.aws_access_key_id(), "ANTN35UAENTS5UIAEATD");
    assert_eq!(creds.aws_secret_access_key(), "TtnuieannGt2rGuie2t8Tt7urarg5nauedRndrur");
    assert_eq!(creds.token(), &Some("DfnGs8Td4rT8r4srxAg6Td4rT8r4srxAg6GtkTir".to_string()));
    assert!(creds.expires_at().is_none()); // doesn't expire

    env::set_var("MYAPP_CREDENTIAL_EXPIRATION", "2018-04-21T01:13:02Z");
    let creds = EnvironmentProvider::with_prefix("MYAPP").credentials().await.unwrap();
    assert_eq!(creds.expires_at().unwrap().to_rfc3339(), "2018-04-21T01:13:02+00:00");
}

Trait Implementations

impl Clone for EnvironmentProvider

fn clone(&self) -> EnvironmentProvider

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnvironmentProvider

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

Formats the value using the given formatter.

impl Default for EnvironmentProvider

fn default() -> Self

Returns the “default value” for a type.

impl ProvideAwsCredentials for EnvironmentProvider

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

Produce a new AwsCredentials future.