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

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

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 CreateLoginProfileRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#passwordString

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.

Returns:

  • (String)


744
745
746
747
748
749
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 744

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

#password_reset_requiredBoolean

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

Returns:

  • (Boolean)


744
745
746
747
748
749
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 744

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

#user_nameString

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

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)


744
745
746
747
748
749
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 744

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