Module: AWS::Core::CredentialProviders::Provider

Included in:
DefaultProvider, EC2Provider, ENVProvider, SessionProvider
Defined in:
lib/aws/core/credential_providers.rb

Overview

This module is mixed into the various credential provider classes. It provides a unified interface for getting credentials and refreshing them.

Constant Summary collapse

KEYS =

The list of possible keys in the hash returned by #credentials.

Set[:access_key_id, :secret_access_key, :session_token]

Instance Method Summary collapse

Instance Method Details

#access_key_id ⇒ String

Returns the AWS access key id.

Returns:

  • (String) —

    Returns the AWS access key id.

Raises:



50
51
52
 
# File 'lib/aws/core/credential_providers.rb', line 50

def access_key_id
  credentials[:access_key_id]
end

#credentials ⇒ Hash

Returns a hash of credentials containg at least the :access_key_id and :secret_access_key. The hash may also contain a :session_token.

Returns:

  • (Hash) —

    Returns a hash of credentials containg at least the :access_key_id and :secret_access_key. The hash may also contain a :session_token.

Raises:



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/aws/core/credential_providers.rb', line 37

def credentials
  @cached_credentials ||= begin
    creds = get_credentials
    unless creds[:access_key_id] and creds[:secret_access_key]
      raise Errors::MissingCredentialsError
    end
    creds
  end
  @cached_credentials.dup
end

#refresh ⇒ nil

Clears out cached/memoized credentials. Causes the provider to refetch credentials from the source.

Returns:

  • (nil) 


70
71
72
 
# File 'lib/aws/core/credential_providers.rb', line 70

def refresh
  @cached_credentials = nil
end

#secret_access_key ⇒ String

Returns the AWS secret access key.

Returns:

  • (String) —

    Returns the AWS secret access key.

Raises:



56
57
58
 
# File 'lib/aws/core/credential_providers.rb', line 56

def secret_access_key
  credentials[:secret_access_key]
end

#session_token ⇒ String?

Returns the AWS session token or nil if these are not session credentials.

Returns:

  • (String, nil) —

    Returns the AWS session token or nil if these are not session credentials.

Raises:



63
64
65
 
# File 'lib/aws/core/credential_providers.rb', line 63

def session_token
  credentials[:session_token]
end