Class: AWS::IAM::LoginProfile

Inherits:

Resource

• Object
• Resource
• Resource
• AWS::IAM::LoginProfile

Defined in:

lib/aws/iam/login_profile.rb

Overview

A login profile is a user name and password that enables a user to log in to the AWS Management Console. Without a login profile, a user cannot access the console. (For information about accessing and using the AWS Management Console, see Using the AWS Management Console.)

Examples:

Setting a password for a user’s login profile

user.login_profile.password = "TheNewPassword"

Deleting the login profile for a user

user.login_profile.delete

Instance Attribute Summary

• #user ⇒ Object readonly

Instance Method Summary

• #delete ⇒ Object

  Deletes the login profile for the specified user, which terminates the user’s ability to access AWS services through the IAM login page.

• #exists? ⇒ Boolean

  True if a login profile exists for the user.

• #password=(password) ⇒ Object

  Sets a new password for the login profile, creating the profile if no profile currently exists for the user.

Instance Attribute Details

#user ⇒ Object (readonly)

# File 'lib/aws/iam/login_profile.rb', line 42

def user
  @user
end

Instance Method Details

#delete ⇒ Object

Note:

Deleting a user’s login profile does not prevent a user from accessing IAM through the command line interface or the API. To prevent all user access you must also either make the access key inactive or delete it. For more information about making keys inactive or deleting them, see User#access_keys.

Deletes the login profile for the specified user, which terminates the user’s ability to access AWS services through the IAM login page.

# File 'lib/aws/iam/login_profile.rb', line 72

def delete
  client.delete_login_profile(resource_options)
end

#exists? ⇒ Boolean

Returns True if a login profile exists for the user.

Returns:

• (Boolean) —

  True if a login profile exists for the user.

# File 'lib/aws/iam/login_profile.rb', line 77

def exists?
  client.get_login_profile(resource_options)
rescue Errors::NoSuchEntity => e
  false
else
  true
end

#password=(password) ⇒ Object

Sets a new password for the login profile, creating the profile if no profile currently exists for the user.

Parameters:

• password (String) —

  The new password for the user.

# File 'lib/aws/iam/login_profile.rb', line 52

def password=(password)
  options = resource_options(:password => password)
  client.update_login_profile(options)
  password
rescue Errors::NoSuchEntity => e
  client.create_login_profile(options)
  password
end