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

Class: Aws::IAM::LoginProfile

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_name, options = {}) ⇒ LoginProfile #initialize(options = {}) ⇒ LoginProfile

Returns a new instance of LoginProfile

Overloads:

  • #initialize(user_name, options = {}) ⇒ LoginProfile

    Parameters:

    • user_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ LoginProfile

    Options Hash (options):

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


19
20
21
22
23
24
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 19

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

Instance Method Details

#clientClient

Returns:



49
50
51
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 49

def client
  @client
end

#create(options = {}) ⇒ LoginProfile

Examples:

Request syntax with placeholder values


loginprofile = .create({
  password: "passwordType", # required
  password_reset_required: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :password (required, String)

    The new password for the user.

    The regex pattern used to validate this parameter is a string of characters consisting of almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Although any of these characters are valid in a password, note that many tools, such as the AWS Management Console, might restrict the ability to enter certain characters because they have special meaning within that tool.

  • :password_reset_required (Boolean)

    Specifies whether the user is required to set a new password on next sign-in.

Returns:



204
205
206
207
208
209
210
211
212
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 204

def create(options = {})
  options = options.merge(user_name: @user_name)
  resp = @client.(options)
  LoginProfile.new(
    user_name: resp.data..user_name,
    data: resp.data.,
    client: @client
  )
end

#create_dateTime

The date when the password for the user was created.

Returns:

  • (Time)


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

def create_date
  data[:create_date]
end

#dataTypes::LoginProfile

Returns the data for this Aws::IAM::LoginProfile. Calls Client#get_login_profile if #data_loaded? is false.

Returns:



69
70
71
72
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 69

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.



77
78
79
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 77

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


219
220
221
222
223
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 219

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

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::IAM::LoginProfile. Returns self making it possible to chain methods.

.reload.data

Returns:

  • (self)


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

def load
  resp = @client.(user_name: @user_name)
  @data = resp.
  self
end

#password_reset_requiredBoolean

Specifies whether the user is required to set a new password on next sign-in.

Returns:

  • (Boolean)


42
43
44
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 42

def password_reset_required
  data[:password_reset_required]
end

#update(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


.update({
  password: "passwordType",
  password_reset_required: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :password (String)

    The new password for the specified IAM user.

    The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF). It also includes the special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D). However, the format can be further restricted by the account administrator by setting a password policy on the AWS account. For more information, see UpdateAccountPasswordPolicy.

  • :password_reset_required (Boolean)

    Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.

Returns:

  • (EmptyStructure)


252
253
254
255
256
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 252

def update(options = {})
  options = options.merge(user_name: @user_name)
  resp = @client.(options)
  resp.data
end

#userUser

Returns:



261
262
263
264
265
266
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 261

def user
  User.new(
    name: @user_name,
    client: @client
  )
end

#user_nameString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 29

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 159

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