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:



109
110
111
112
113
114
115
116
117
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 109

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)


124
125
126
127
128
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 124

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)


157
158
159
160
161
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 157

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

#userUser

Returns:



166
167
168
169
170
171
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/login_profile.rb', line 166

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