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.

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) ⇒ Credentials

Returns a new instance of Credentials.

Parameters:

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

    (nil)



9
10
11
12
13
 
# File 'gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb', line 9

def initialize(access_key_id, secret_access_key, session_token = nil)
  @access_key_id = access_key_id
  @secret_access_key = secret_access_key
  @session_token = session_token
end

Instance Attribute Details

#access_key_id ⇒ String? (readonly)

Returns:

  • (String, nil) 


16
17
18
 
# File 'gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb', line 16

def access_key_id
  @access_key_id
end

#secret_access_key ⇒ String? (readonly)

Returns:

  • (String, nil) 


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

def secret_access_key
  @secret_access_key
end

#session_token ⇒ String? (readonly)

Returns:

  • (String, nil) 


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

def session_token
  @session_token
end

Instance Method Details

#credentials ⇒ Credentials

Returns:



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

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.



31
32
33
34
35
36
 
# File 'gems/aws-sdk-core/lib/aws-sdk-core/credentials.rb', line 31

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