Class: Aws::IAM::Types::CreateLoginProfileRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#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

Returns:

  • (String) 


850
851
852
853
854
855
856
 
# File 'lib/aws-sdk-iam/types.rb', line 850

class CreateLoginProfileRequest < Struct.new(
  :user_name,
  :password,
  :password_reset_required)
  SENSITIVE = [:password]
  include Aws::Structure
end

#password_reset_required ⇒ Boolean

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

Returns:

  • (Boolean) 


850
851
852
853
854
855
856
 
# File 'lib/aws-sdk-iam/types.rb', line 850

class CreateLoginProfileRequest < Struct.new(
  :user_name,
  :password,
  :password_reset_required)
  SENSITIVE = [:password]
  include Aws::Structure
end

#user_name ⇒ String

The name of the IAM user to create a password for. The user must already exist.

This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an [AssumeRoot] session to omit the user name.

This parameter allows (through 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: _+=,.@-

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

Returns:

  • (String) 


850
851
852
853
854
855
856
 
# File 'lib/aws-sdk-iam/types.rb', line 850

class CreateLoginProfileRequest < Struct.new(
  :user_name,
  :password,
  :password_reset_required)
  SENSITIVE = [:password]
  include Aws::Structure
end