Skip to content

Commit dc4a3b0

Browse files
authored
Fix API document for Aws::InstanceProfileCredentials#initialize method (#3314)
1 parent b4fb775 commit dc4a3b0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

gems/aws-sdk-core/lib/aws-sdk-core/instance_profile_credentials.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ class TokenExpiredError < RuntimeError; end
5757

5858
# @param [Hash] options
5959
# @option options [Integer] :retries (1) Number of times to retry when retrieving credentials.
60+
# @option options [Numeric, Proc] :backoff By default, failures are retried with exponential back-off, i.e.
61+
# `lambda { |num_failures| sleep(1.2 ** num_failures) }`. You can pass a number of seconds to sleep
62+
# between failed attempts, or a Proc that accepts the number of failures.
6063
# @option options [String] :endpoint ('http://169.254.169.254') The IMDS endpoint. This option has precedence
6164
# over the `:endpoint_mode`.
6265
# @option options [String] :endpoint_mode ('IPv4') The endpoint mode for the instance metadata service. This is
@@ -67,14 +70,11 @@ class TokenExpiredError < RuntimeError; end
6770
# @option options [Integer] :port (80)
6871
# @option options [Float] :http_open_timeout (1)
6972
# @option options [Float] :http_read_timeout (1)
70-
# @option options [Numeric, Proc] :delay By default, failures are retried with exponential back-off, i.e.
71-
# `sleep(1.2 ** num_failures)`. You can pass a number of seconds to sleep between failed attempts, or a Proc
72-
# that accepts the number of failures.
7373
# @option options [IO] :http_debug_output (nil) HTTP wire traces are sent to this object.
7474
# You can specify something like `$stdout`.
75-
# @option options [Integer] :token_ttl Time-to-Live in seconds for EC2 Metadata Token used for fetching
76-
# Metadata Profile Credentials, defaults to 21600 seconds.
77-
# @option options [Callable] :before_refresh Proc called before credentials are refreshed. `before_refresh`
75+
# @option options [Integer] :token_ttl (21600) Time-to-Live in seconds for EC2 Metadata Token used for fetching
76+
# Metadata Profile Credentials.
77+
# @option options [Proc] :before_refresh A Proc called before credentials are refreshed. `:before_refresh`
7878
# is called with an instance of this object when AWS credentials are required and need to be refreshed.
7979
def initialize(options = {})
8080
@backoff = resolve_backoff(options[:backoff])

0 commit comments

Comments
 (0)