Class: Aws::Credentials

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_key_id, secret_access_key, session_token = nil, **kwargs) ⇒ Credentials

Returns a new instance of Credentials.

Parameters:

  • access_key_id (String)
  • secret_access_key (String)
  • session_token (String) (defaults to: nil) —

    (nil)

  • kwargs (Hash)

Options Hash (**kwargs):

  • :credential_scope (String) — default: nil 


11
12
13
14
15
16
17
18
 
# File 'gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb', line 11

def initialize(access_key_id, secret_access_key, session_token = nil,
               **kwargs)
  @access_key_id = access_key_id
  @secret_access_key = secret_access_key
  @session_token = session_token
  @account_id = kwargs[:account_id]
  @metrics = ['CREDENTIALS_CODE']
end

Instance Attribute Details

#access_key_id ⇒ String (readonly)

Returns:

  • (String) 


21
22
23
 
# File 'gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb', line 21

def access_key_id
  @access_key_id
end

#account_id ⇒ String? (readonly)

Returns:

  • (String, nil) 


30
31
32
 
# File 'gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb', line 30

def 
  @account_id
end

#secret_access_key ⇒ String (readonly)

Returns:

  • (String) 


24
25
26
 
# File 'gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb', line 24

def secret_access_key
  @secret_access_key
end

#session_token ⇒ String? (readonly)

Returns:

  • (String, nil) 


27
28
29
 
# File 'gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb', line 27

def session_token
  @session_token
end

Instance Method Details

#credentials ⇒ Credentials

Returns:



38
39
40
 
# File 'gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb', line 38

def credentials
  self
end

#set? ⇒ Boolean

Returns true if the access key id and secret access key are both set.

Returns:

  • (Boolean) —

    Returns true if the access key id and secret access key are both set.



44
45
46
47
48
49
 
# File 'gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb', line 44

def set?
  !access_key_id.nil? &&
    !access_key_id.empty? &&
    !secret_access_key.nil? &&
    !secret_access_key.empty?
end