class Aws::IAM::LoginProfile
Public Class Methods
@overload def initialize(user_name
, options = {})
@param [String] user_name @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :user_name @option options [Client] :client
# File lib/aws-sdk-iam/login_profile.rb, line 22 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) @waiter_block_warned = false end
Public Instance Methods
@return [Client]
# File lib/aws-sdk-iam/login_profile.rb, line 53 def client @client end
@example Request syntax with placeholder values
loginprofile = login_profile.create({ password: "passwordType", # required password_reset_required: false, })
@param [Hash] options ({}) @option options [required, String] :password
The new password for the user. The [regex pattern][1] that is used to validate this parameter is a string of characters. That string can include 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. Any of these characters are valid in a password. However, many tools, such as the Management Console, might restrict the ability to type certain characters because they have special meaning within that tool. [1]: http://wikipedia.org/wiki/regex
@option options [Boolean] :password_reset_required
Specifies whether the user is required to set a new password on next sign-in.
@return [LoginProfile]
# File lib/aws-sdk-iam/login_profile.rb, line 210 def create(options = {}) options = options.merge(user_name: @user_name) resp = @client.create_login_profile(options) LoginProfile.new( user_name: resp.data.login_profile.user_name, data: resp.data.login_profile, client: @client ) end
The date when the password for the user was created. @return [Time]
# File lib/aws-sdk-iam/login_profile.rb, line 39 def create_date data[:create_date] end
@return [Types::LoginProfile]
Returns the data for this {LoginProfile}. Calls {Client#get_login_profile} if {#data_loaded?} is `false`.
# File lib/aws-sdk-iam/login_profile.rb, line 73 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-iam/login_profile.rb, line 81 def data_loaded? !!@data end
@example Request syntax with placeholder values
login_profile.delete()
@param [Hash] options ({}) @return [EmptyStructure]
# File lib/aws-sdk-iam/login_profile.rb, line 225 def delete(options = {}) options = options.merge(user_name: @user_name) resp = @client.delete_login_profile(options) resp.data end
@deprecated @api private
# File lib/aws-sdk-iam/login_profile.rb, line 282 def identifiers { user_name: @user_name } end
Loads, or reloads {#data} for the current {LoginProfile}. Returns `self` making it possible to chain methods.
login_profile.reload.data
@return [self]
# File lib/aws-sdk-iam/login_profile.rb, line 63 def load resp = @client.get_login_profile(user_name: @user_name) @data = resp.login_profile self end
Specifies whether the user is required to set a new password on next sign-in. @return [Boolean]
# File lib/aws-sdk-iam/login_profile.rb, line 46 def password_reset_required data[:password_reset_required] end
@example Request syntax with placeholder values
login_profile.update({ password: "passwordType", password_reset_required: false, })
@param [Hash] options ({}) @option options [String] :password
The new password for the specified IAM user. The [regex pattern][1] used to validate this parameter is a string of characters consisting of the following: * Any printable ASCII character ranging from the space character (`\u0020`) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through `\u00FF`) * 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 account. For more information, see UpdateAccountPasswordPolicy. [1]: http://wikipedia.org/wiki/regex
@option options [Boolean] :password_reset_required
Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.
@return [EmptyStructure]
# File lib/aws-sdk-iam/login_profile.rb, line 264 def update(options = {}) options = options.merge(user_name: @user_name) resp = @client.update_login_profile(options) resp.data end
@return [User]
# File lib/aws-sdk-iam/login_profile.rb, line 273 def user User.new( name: @user_name, client: @client ) end
@return [String]
# File lib/aws-sdk-iam/login_profile.rb, line 33 def user_name @user_name end
@deprecated Use [Aws::IAM::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## 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) do |instance| instance.state.name == 'running' end
## 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
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [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.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-iam/login_profile.rb, line 165 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
Private Instance Methods
# File lib/aws-sdk-iam/login_profile.rb, line 289 def extract_user_name(args, options) value = args[0] || options.delete(:user_name) case value when String then value when nil then raise ArgumentError, "missing required option :user_name" else msg = "expected :user_name to be a String, got #{value.class}" raise ArgumentError, msg end end