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

Class: Aws::IAM::Types::UpdateLoginProfileRequest

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

Overview

Note:

When making an API call, you may pass UpdateLoginProfileRequest data as a hash:

{
  user_name: "userNameType", # required
  password: "passwordType",
  password_reset_required: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#passwordString

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.

Returns:

  • (String)


8053
8054
8055
8056
8057
8058
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 8053

class UpdateLoginProfileRequest < Struct.new(
  :user_name,
  :password,
  :password_reset_required)
  include Aws::Structure
end

#password_reset_requiredBoolean

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:

  • (Boolean)


8053
8054
8055
8056
8057
8058
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 8053

class UpdateLoginProfileRequest < Struct.new(
  :user_name,
  :password,
  :password_reset_required)
  include Aws::Structure
end

#user_nameString

The name of the user whose password you want to update.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Returns:

  • (String)


8053
8054
8055
8056
8057
8058
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 8053

class UpdateLoginProfileRequest < Struct.new(
  :user_name,
  :password,
  :password_reset_required)
  include Aws::Structure
end