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

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

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

Overview

Note:

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#passwordString

Returns:

  • (String)


1547
1548
1549
1550
1551
1552
1553
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1547

class AdminSetUserPasswordRequest < Struct.new(
  :user_pool_id,
  :username,
  :password,
  :permanent)
  include Aws::Structure
end

#permanentBoolean

Returns:

  • (Boolean)


1547
1548
1549
1550
1551
1552
1553
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1547

class AdminSetUserPasswordRequest < Struct.new(
  :user_pool_id,
  :username,
  :password,
  :permanent)
  include Aws::Structure
end

#user_pool_idString

Returns:

  • (String)


1547
1548
1549
1550
1551
1552
1553
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1547

class AdminSetUserPasswordRequest < Struct.new(
  :user_pool_id,
  :username,
  :password,
  :permanent)
  include Aws::Structure
end

#usernameString

Returns:

  • (String)


1547
1548
1549
1550
1551
1552
1553
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1547

class AdminSetUserPasswordRequest < Struct.new(
  :user_pool_id,
  :username,
  :password,
  :permanent)
  include Aws::Structure
end