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

Class: Aws::CognitoIdentityProvider::Types::PasswordPolicyType

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

{
  minimum_length: 1,
  require_uppercase: false,
  require_lowercase: false,
  require_numbers: false,
  require_symbols: false,
}

The password policy type.

Instance Attribute Summary collapse

Instance Attribute Details

#minimum_lengthInteger

The minimum length of the password policy that you have set. Cannot be less than 6.

Returns:

  • (Integer)


5203
5204
5205
5206
5207
5208
5209
5210
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5203

class PasswordPolicyType < Struct.new(
  :minimum_length,
  :require_uppercase,
  :require_lowercase,
  :require_numbers,
  :require_symbols)
  include Aws::Structure
end

#require_lowercaseBoolean

In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.

Returns:

  • (Boolean)


5203
5204
5205
5206
5207
5208
5209
5210
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5203

class PasswordPolicyType < Struct.new(
  :minimum_length,
  :require_uppercase,
  :require_lowercase,
  :require_numbers,
  :require_symbols)
  include Aws::Structure
end

#require_numbersBoolean

In the password policy that you have set, refers to whether you have required users to use at least one number in their password.

Returns:

  • (Boolean)


5203
5204
5205
5206
5207
5208
5209
5210
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5203

class PasswordPolicyType < Struct.new(
  :minimum_length,
  :require_uppercase,
  :require_lowercase,
  :require_numbers,
  :require_symbols)
  include Aws::Structure
end

#require_symbolsBoolean

In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.

Returns:

  • (Boolean)


5203
5204
5205
5206
5207
5208
5209
5210
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5203

class PasswordPolicyType < Struct.new(
  :minimum_length,
  :require_uppercase,
  :require_lowercase,
  :require_numbers,
  :require_symbols)
  include Aws::Structure
end

#require_uppercaseBoolean

In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.

Returns:

  • (Boolean)


5203
5204
5205
5206
5207
5208
5209
5210
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5203

class PasswordPolicyType < Struct.new(
  :minimum_length,
  :require_uppercase,
  :require_lowercase,
  :require_numbers,
  :require_symbols)
  include Aws::Structure
end