You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IAM::AccessKeyPair

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_name, id, secret, options = {}) ⇒ AccessKeyPair #initialize(options = {}) ⇒ AccessKeyPair

Returns a new instance of AccessKeyPair

Overloads:

  • #initialize(user_name, id, secret, options = {}) ⇒ AccessKeyPair

    Parameters:

    • user_name (String)
    • id (String)
    • secret (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ AccessKeyPair

    Options Hash (options):

    • :user_name (required, String)
    • :id (required, String)
    • :secret (required, String)
    • :client (Client)


23
24
25
26
27
28
29
30
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 23

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @user_name = extract_user_name(args, options)
  @id = extract_id(args, options)
  @secret = extract_secret(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#activate(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


access_key_pair.activate()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


196
197
198
199
200
201
202
203
204
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 196

def activate(options = {})
  options = options.merge(
    user_name: @user_name,
    access_key_id: @id,
    status: "Active"
  )
  resp = @client.update_access_key(options)
  resp.data
end

#clientClient

Returns:



67
68
69
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 67

def client
  @client
end

#create_dateTime

The date when the access key was created.

Returns:

  • (Time)


60
61
62
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 60

def create_date
  data[:create_date]
end

#dataTypes::AccessKey

Returns the data for this Aws::IAM::AccessKeyPair.

Returns:

Raises:



82
83
84
85
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 82

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



90
91
92
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 90

def data_loaded?
  !!@data
end

#deactivate(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


access_key_pair.deactivate()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


211
212
213
214
215
216
217
218
219
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 211

def deactivate(options = {})
  options = options.merge(
    user_name: @user_name,
    access_key_id: @id,
    status: "Inactive"
  )
  resp = @client.update_access_key(options)
  resp.data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


access_key_pair.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


226
227
228
229
230
231
232
233
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 226

def delete(options = {})
  options = options.merge(
    user_name: @user_name,
    access_key_id: @id
  )
  resp = @client.delete_access_key(options)
  resp.data
end

#idString Also known as: access_key_id

Returns:

  • (String)


40
41
42
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 40

def id
  @id
end

#secretString Also known as: secret_access_key

Returns:

  • (String)


46
47
48
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 46

def secret
  @secret
end

#statusString

The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

Returns:

  • (String)


54
55
56
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 54

def status
  data[:status]
end

#user_nameString

Returns:

  • (String)


35
36
37
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 35

def user_name
  @user_name
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::IAM::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key_pair.rb', line 172

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end