PasswordPolicy

All Known Implementing Classes:: PasswordPolicy.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.377Z")
public interface PasswordPolicy

Password policy for User Pools.

Example:

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .passwordPolicy(PasswordPolicy.builder()
                 .minLength(12)
                 .requireLowercase(true)
                 .requireUppercase(true)
                 .requireDigits(true)
                 .requireSymbols(true)
                 .tempPasswordValidity(Duration.days(3))
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`PasswordPolicy.Builder` A builder for `PasswordPolicy`
`static class`	`PasswordPolicy.Jsii$Proxy` An implementation for `PasswordPolicy`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static PasswordPolicy.Builder`	`builder()`
`default java.lang.Number`	`getMinLength()` Minimum length required for a user's password.
`default java.lang.Boolean`	`getRequireDigits()` Whether the user is required to have digits in their password.
`default java.lang.Boolean`	`getRequireLowercase()` Whether the user is required to have lowercase characters in their password.
`default java.lang.Boolean`	`getRequireSymbols()` Whether the user is required to have symbols in their password.
`default java.lang.Boolean`	`getRequireUppercase()` Whether the user is required to have uppercase characters in their password.
`default Duration`	`getTempPasswordValidity()` The length of time the temporary password generated by an admin is valid.

- Method Detail
  - getMinLength
```
default java.lang.Number getMinLength()
```
    Minimum length required for a user's password.
    Default: 8
  - getRequireDigits
```
default java.lang.Boolean getRequireDigits()
```
    Whether the user is required to have digits in their password.
    Default: true
  - getRequireLowercase
```
default java.lang.Boolean getRequireLowercase()
```
    Whether the user is required to have lowercase characters in their password.
    Default: true
  - getRequireSymbols
```
default java.lang.Boolean getRequireSymbols()
```
    Whether the user is required to have symbols in their password.
    Default: true
  - getRequireUppercase
```
default java.lang.Boolean getRequireUppercase()
```
    Whether the user is required to have uppercase characters in their password.
    Default: true
  - getTempPasswordValidity
```
default Duration getTempPasswordValidity()
```
    The length of time the temporary password generated by an admin is valid.
    This must be provided as whole days, like Duration.days(3) or Duration.hours(48). Fractional days, such as Duration.hours(20), will generate an error.
    Default: Duration.days(7)
  - builder
```
static PasswordPolicy.Builder builder()
```
    Returns:
    
    a PasswordPolicy.Builder of PasswordPolicy

Interface PasswordPolicy

Nested Class Summary

Method Summary

Method Detail

getMinLength

getRequireDigits

getRequireLowercase

getRequireSymbols

getRequireUppercase

getTempPasswordValidity

builder