Class: Aws::IAM::LoginProfile

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations 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) 


22
23
24
25
26
27
28
 
# 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

Instance Method Details

#client ⇒ Client

Returns:



53
54
55
 
# File 'lib/aws-sdk-iam/login_profile.rb', line 53

def client
  @client
end

#create(options = {}) ⇒ LoginProfile

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :password (String) —

    The new password for the user.

    This parameter must be omitted when you make the request with an

    AssumeRoot][1

    session. It is required in all other cases.

    The [regex pattern] 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 Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

    [1]: docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html [2]: wikipedia.org/wiki/regex

  • :password_reset_required (Boolean) —

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

Returns:



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/aws-sdk-iam/login_profile.rb', line 219

def create(options = {})
  options = options.merge(user_name: @user_name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.(options)
  end
  LoginProfile.new(
    user_name: resp.data..user_name,
    data: resp.data.,
    client: @client
  )
end

#create_date ⇒ Time

The date when the password for the user was created.

Returns:

  • (Time) 


39
40
41
 
# File 'lib/aws-sdk-iam/login_profile.rb', line 39

def create_date
  data[:create_date]
end

#data ⇒ Types::LoginProfile

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

Returns:



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

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.



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

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


236
237
238
239
240
241
242
 
# File 'lib/aws-sdk-iam/login_profile.rb', line 236

def delete(options = {})
  options = options.merge(user_name: @user_name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.(options)
  end
  resp.data
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


297
298
299
 
# File 'lib/aws-sdk-iam/login_profile.rb', line 297

def identifiers
  { user_name: @user_name }
end

#load ⇒ self 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) 


63
64
65
66
67
68
69
 
# File 'lib/aws-sdk-iam/login_profile.rb', line 63

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.(user_name: @user_name)
  end
  @data = resp.
  self
end

#password_reset_required ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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 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 Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.

    [1]: wikipedia.org/wiki/regex

  • :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) 


277
278
279
280
281
282
283
 
# File 'lib/aws-sdk-iam/login_profile.rb', line 277

def update(options = {})
  options = options.merge(user_name: @user_name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.(options)
  end
  resp.data
end

#user ⇒ User

Returns:



288
289
290
291
292
293
 
# File 'lib/aws-sdk-iam/login_profile.rb', line 288

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

#user_name ⇒ String

Returns:

  • (String) 


33
34
35
 
# File 'lib/aws-sdk-iam/login_profile.rb', line 33

def user_name
  @user_name
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) 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

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/aws-sdk-iam/login_profile.rb', line 167

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end