Struct aws_credential_types::Credentials

pub struct Credentials(/* private fields */);

AWS SDK Credentials

An opaque struct representing credentials that may be used in an AWS SDK, modeled on the CRT credentials implementation.

When Credentials is dropped, its contents are zeroed in memory. Credentials uses an interior Arc to ensure that even when cloned, credentials don’t exist in multiple memory locations.

Implementations

impl Credentials

pub fn new( access_key_id: impl Into<String>, secret_access_key: impl Into<String>, session_token: Option<String>, expires_after: Option<SystemTime>, provider_name: &'static str, ) -> Self

Creates Credentials.

This is intended to be used from a custom credentials provider implementation. It is NOT secure to hardcode credentials into your application.

pub fn from_keys( access_key_id: impl Into<String>, secret_access_key: impl Into<String>, session_token: Option<String>, ) -> Self

Available on crate feature hardcoded-credentials only.

Creates Credentials from hardcoded access key, secret key, and session token.

Note: In general, you should prefer to use the credential providers that come with the AWS SDK to get credentials. It is NOT secure to hardcode credentials into your application. If you’re writing a custom credentials provider, then use Credentials::new instead of this.

This function requires the hardcoded-credentials feature to be enabled.

Credentials implement ProvideCredentials directly, so no custom provider implementation is required when wiring these up to a client:

use aws_credential_types::Credentials;

let creds = Credentials::from_keys("akid", "secret_key", None);
let config = Config::builder()
    .credentials_provider(creds)
    .build();
let client = Client::from_conf(config);

pub fn access_key_id(&self) -> &str

Returns the access key ID.

pub fn secret_access_key(&self) -> &str

Returns the secret access key.

pub fn expiry(&self) -> Option<SystemTime>

Returns the time when the credentials will expire.

pub fn expiry_mut(&mut self) -> &mut Option<SystemTime>

Returns a mutable reference to the time when the credentials will expire.

pub fn session_token(&self) -> Option<&str>

Returns the session token.

impl Credentials

pub fn for_tests() -> Self

Available on crate feature test-util only.

Creates a test Credentials with no session token.

pub fn for_tests_with_session_token() -> Self

Available on crate feature test-util only.

Creates a test Credentials that include a session token.

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 From<Credentials> for Identity

fn from(val: Credentials) -> Self

Converts to this type from the input type.

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 ProvideCredentials for Credentials

fn provide_credentials<'a>(&'a self) -> ProvideCredentials<'a>

where Self: 'a,

Returns a future that provides credentials.

fn fallback_on_interrupt(&self) -> Option<Credentials>

Returns fallback credentials.

impl Eq for Credentials

impl StructuralPartialEq for Credentials