AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SharedCredentials

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from CredentialProvider

#access_key_id, #secret_access_key, #session_token, #set?

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['AWS_PROFILE'] or with the :profile_name option.

Parameters:

  • [String] (Hash)

    a customizable set of options



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'aws-sdk-core/lib/aws-sdk-core/shared_credentials.rb', line 24

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

#credentialsCredentials (readonly)

Returns:



49
50
51
# File 'aws-sdk-core/lib/aws-sdk-core/shared_credentials.rb', line 49

def credentials
  @credentials
end

#pathString (readonly)

Returns:

  • (String)


43
44
45
# File 'aws-sdk-core/lib/aws-sdk-core/shared_credentials.rb', line 43

def path
  @path
end

#profile_nameString (readonly)

Returns:

  • (String)


46
47
48
# File 'aws-sdk-core/lib/aws-sdk-core/shared_credentials.rb', line 46

def profile_name
  @profile_name
end

Instance Method Details

#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.



66
67
68
# File 'aws-sdk-core/lib/aws-sdk-core/shared_credentials.rb', line 66

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