Class: Aws::Sigv4::StaticCredentialsProvider Private

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sigv4/credentials.rb

Overview

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

Users that wish to configure static credentials can use the ‘:access_key_id` and `:secret_access_key` constructor options.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ StaticCredentialsProvider

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.

Returns a new instance of StaticCredentialsProvider.

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :credentials (Credentials)
  • :access_key_id (String)
  • :secret_access_key (String)
  • :session_token (String) — default: nil


52
53
54
55
56
# File 'lib/aws-sigv4/credentials.rb', line 52

def initialize(options = {})
  @credentials = options[:credentials] ?
    options[:credentials] :
    Credentials.new(options)
end

Instance Attribute Details

#credentialsCredentials (readonly)

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.

Returns:



59
60
61
# File 'lib/aws-sigv4/credentials.rb', line 59

def credentials
  @credentials
end

Instance Method Details

#set?Boolean

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.

Returns:

  • (Boolean)


62
63
64
# File 'lib/aws-sigv4/credentials.rb', line 62

def set?
  !!credentials && credentials.set?
end