Class: Aws::SharedCredentials

Inherits:
Object
  • Object
show all
Includes:
CredentialProvider
Defined in:
lib/aws-sdk-core/shared_credentials.rb

Constant Summary collapse

KEY_MAP =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

{
  'aws_access_key_id' => 'access_key_id',
  'aws_secret_access_key' => 'secret_access_key',
  'aws_session_token' => 'session_token',
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from CredentialProvider

#set?

Constructor Details

#initialize(options = {}) ⇒ SharedCredentials

Constructs a new SharedCredentials object. This will load static (access_key_id, secret_access_key and session_token) AWS access credentials from an ini file, which supports profiles. The default profile name is ‘default’. You can specify the profile name with the ‘ENV` or with the :profile_name option.

To use credentials from the default credential resolution chain create a client without the credential option specified. You may access the resolved credentials through client.config.credentials.

Parameters:

  • [String] (Hash) —

    a customizable set of options



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/aws-sdk-core/shared_credentials.rb', line 34

def initialize(options = {})
  shared_config = Aws.shared_config
  @path = options[:path]
  @path ||= shared_config.credentials_path
  @profile_name = options[:profile_name]
  @profile_name ||= ENV['AWS_PROFILE']
  @profile_name ||= shared_config.profile_name
  if @path && @path == shared_config.credentials_path
    @credentials = shared_config.credentials(profile: @profile_name)
  else
    config = SharedConfig.new(
      credentials_path: @path,
      profile_name: @profile_name
    )
    @credentials = config.credentials(profile: @profile_name)
  end
end

Instance Attribute Details

#credentials ⇒ Credentials (readonly)

Returns:



59
60
61
 
# File 'lib/aws-sdk-core/shared_credentials.rb', line 59

def credentials
  @credentials
end

#path ⇒ String (readonly)

Returns:

  • (String) 


53
54
55
 
# File 'lib/aws-sdk-core/shared_credentials.rb', line 53

def path
  @path
end

#profile_name ⇒ String (readonly)

Returns:

  • (String) 


56
57
58
 
# File 'lib/aws-sdk-core/shared_credentials.rb', line 56

def profile_name
  @profile_name
end

Instance Method Details

#inspect ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



62
63
64
65
66
67
68
69
 
# File 'lib/aws-sdk-core/shared_credentials.rb', line 62

def inspect
  parts = [
    self.class.name,
    "profile_name=#{profile_name.inspect}",
    "path=#{path.inspect}",
  ]
  "#<#{parts.join(' ')}>"
end

#loadable? ⇒ Boolean

Deprecated.

This method is no longer used.

Note:

This method does not indicate if the file found at #path will be parsable, only if it can be read.

Returns true if a credential file exists and has appropriate read permissions at #path.

Returns:

  • (Boolean) —

    Returns true if a credential file exists and has appropriate read permissions at #path.



76
77
78
 
# File 'lib/aws-sdk-core/shared_credentials.rb', line 76

def loadable?
  !path.nil? && File.exist?(path) && File.readable?(path)
end