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

Class: Aws::CognitoIdentityProvider::Types::AdminSetUserPasswordRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AdminSetUserPasswordRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  password: "PasswordType", # required
  permanent: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#password ⇒ String

The password for the user.

Returns:

  • (String) —

    The password for the user.

#permanent ⇒ Boolean

True if the password is permanent, False if it is temporary.

Returns:

  • (Boolean) —

    True if the password is permanent, False if it is temporary.

#user_pool_id ⇒ String

The user pool ID for the user pool where you want to set the user\'s password.

Returns:

  • (String) —

    The user pool ID for the user pool where you want to set the user\'s password.

#username ⇒ String

The user name of the user whose password you wish to set.

Returns:

  • (String) —

    The user name of the user whose password you wish to set.