Class: Aws::SharedCredentials
- Inherits:
-
Object
- Object
- Aws::SharedCredentials
- 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
- #credentials ⇒ Credentials readonly
- #path ⇒ String readonly
- #profile_name ⇒ String readonly
Instance Method Summary collapse
-
#initialize(options = {}) ⇒ SharedCredentials
constructor
Constructs a new SharedCredentials object.
- #inspect ⇒ Object private
-
#loadable? ⇒ Boolean
deprecated
Deprecated.
This method is no longer used.
Methods included from CredentialProvider
#access_key_id, #secret_access_key, #session_token, #set?
Methods included from Deprecations
Constructor Details
#initialize(options = {}) ⇒ SharedCredentials
Constructs a new SharedCredentials object. This will load 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.
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/aws-sdk-core/shared_credentials.rb', line 26 def initialize( = {}) shared_config = Aws.shared_config @path = [:path] @path ||= shared_config.credentials_path @profile_name = [: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)
51 52 53 |
# File 'lib/aws-sdk-core/shared_credentials.rb', line 51 def credentials @credentials end |
#path ⇒ String (readonly)
45 46 47 |
# File 'lib/aws-sdk-core/shared_credentials.rb', line 45 def path @path end |
#profile_name ⇒ String (readonly)
48 49 50 |
# File 'lib/aws-sdk-core/shared_credentials.rb', line 48 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.
54 55 56 57 58 59 60 61 |
# File 'lib/aws-sdk-core/shared_credentials.rb', line 54 def inspect parts = [ self.class.name, "profile_name=#{profile_name.inspect}", "path=#{path.inspect}", ] "#<#{parts.join(' ')}>" end |
#loadable? ⇒ Boolean
68 69 70 |
# File 'lib/aws-sdk-core/shared_credentials.rb', line 68 def loadable? !path.nil? && File.exist?(path) && File.readable?(path) end |