Class: Aws::ECSCredentials

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

Defined Under Namespace

Classes: Non200Response

Constant Summary collapse

NETWORK_ERRORS =

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.

These are the errors we trap when attempting to talk to the instance metadata service. Any of these imply the service is not present, no responding or some other non-recoverable error.

[
  Errno::EHOSTUNREACH,
  Errno::ECONNREFUSED,
  Errno::EHOSTDOWN,
  Errno::ENETUNREACH,
  SocketError,
  Timeout::Error,
  Non200Response,
]

Instance Attribute Summary collapse

Attributes included from CredentialProvider

#credentials

Instance Method Summary collapse

Methods included from RefreshingCredentials

#credentials, #expiration, #refresh!

Methods included from CredentialProvider

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

Methods included from Deprecations

#deprecated

Constructor Details

#initialize(options = {}) ⇒ ECSCredentials

Returns a new instance of ECSCredentials.

Parameters:

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

Options Hash (options):

  • :retries (Integer) — default: 5 —

    Number of times to retry when retrieving credentials.

  • :ip_address (String) — default: '169.254.170.2'
  • :port (Integer) — default: 80
  • :credential_path (String) —

    By default, the value of the AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable.

  • :http_open_timeout (Float) — default: 5
  • :http_read_timeout (Float) — default: 5
  • :delay (Numeric, Proc) —

    By default, failures are retried with exponential back-off, i.e. ‘sleep(1.2 ** num_failures)`. You can pass a number of seconds to sleep between failed attempts, or a Proc that accepts the number of failures.

  • :http_debug_output (IO) — default: nil —

    HTTP wire traces are sent to this object. You can specify something like $stdout.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/aws-sdk-core/ecs_credentials.rb', line 45

def initialize options = {}
  @retries = options[:retries] || 5
  @ip_address = options[:ip_address] || '169.254.170.2'
  @port = options[:port] || 80
  @credential_path = options[:credential_path]
  @credential_path ||= ENV['AWS_CONTAINER_CREDENTIALS_RELATIVE_URI']
  unless @credential_path
    raise ArgumentError.new(
      "Cannot instantiate an ECS Credential Provider without a credential path."
    )
  end
  @http_open_timeout = options[:http_open_timeout] || 5
  @http_read_timeout = options[:http_read_timeout] || 5
  @http_debug_output = options[:http_debug_output]
  @backoff = backoff(options[:backoff])
  super
end

Instance Attribute Details

#retries ⇒ Integer (readonly)

Returns The number of times to retry failed attempts to fetch credentials from the instance metadata service. Defaults to 0.

Returns:

  • (Integer) —

    The number of times to retry failed attempts to fetch credentials from the instance metadata service. Defaults to 0.



65
66
67
 
# File 'lib/aws-sdk-core/ecs_credentials.rb', line 65

def retries
  @retries
end