Struct s3::credentials::Credentials

pub struct Credentials {
    pub access_key: String,
    pub secret_key: String,
    pub token: Option<String>,
    // some fields omitted
}

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 s3::credentials::Credentials;

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

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

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

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 s3::credentials::Credentials;

// Load credentials directly
let access_key = String::from("AKIAIOSFODNN7EXAMPLE");
let secret_key = String::from("wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY");
let credentials = Credentials::new(Some(access_key), Some(secret_key), 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);

Fields

access_key: String

AWS public access key.

secret_key: String

AWS secret key.

token: Option<String>

Temporary token issued by AWS service.

Methods

impl Credentials

pub fn new(
    access_key: Option<String>,
    secret_key: Option<String>,
    token: Option<String>,
    profile: Option<String>
) -> Credentials

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

pub fn from_profile(section: Option<String>) -> S3Result<Credentials>

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a copy 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 Default for Credentials

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Credentials

impl PartialEq<Credentials> for Credentials

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Credentials

impl StructuralPartialEq for Credentials