Package software.amazon.awscdk.services.cognito

Class PasswordPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.PasswordPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PasswordPolicy>

Enclosing interface:

PasswordPolicy

@Stability(Stable)
public static final class PasswordPolicy.Builder
extends Object
implements software.amazon.jsii.Builder<PasswordPolicy>

A builder for PasswordPolicy

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PasswordPolicy	build()	Builds the configured instance.
PasswordPolicy.Builder	minLength(Number minLength)	Sets the value of PasswordPolicy.getMinLength()
PasswordPolicy.Builder	requireDigits(Boolean requireDigits)	Sets the value of PasswordPolicy.getRequireDigits()
PasswordPolicy.Builder	requireLowercase(Boolean requireLowercase)	Sets the value of PasswordPolicy.getRequireLowercase()
PasswordPolicy.Builder	requireSymbols(Boolean requireSymbols)	Sets the value of PasswordPolicy.getRequireSymbols()
PasswordPolicy.Builder	requireUppercase(Boolean requireUppercase)	Sets the value of PasswordPolicy.getRequireUppercase()
PasswordPolicy.Builder	tempPasswordValidity(Duration tempPasswordValidity)	Sets the value of PasswordPolicy.getTempPasswordValidity()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

minLength

@Stability(Stable)
public PasswordPolicy.Builder minLength(Number minLength)

Sets the value of PasswordPolicy.getMinLength()

Parameters:

minLength - Minimum length required for a user's password.

Returns:

this

requireDigits

@Stability(Stable)
public PasswordPolicy.Builder requireDigits(Boolean requireDigits)

Sets the value of PasswordPolicy.getRequireDigits()

Parameters:

requireDigits - Whether the user is required to have digits in their password.

Returns:

this

requireLowercase

@Stability(Stable)
public PasswordPolicy.Builder requireLowercase(Boolean requireLowercase)

Sets the value of PasswordPolicy.getRequireLowercase()

Parameters:

requireLowercase - Whether the user is required to have lowercase characters in their password.

Returns:

this

requireSymbols

@Stability(Stable)
public PasswordPolicy.Builder requireSymbols(Boolean requireSymbols)

Sets the value of PasswordPolicy.getRequireSymbols()

Parameters:

requireSymbols - Whether the user is required to have symbols in their password.

Returns:

this

requireUppercase

@Stability(Stable)
public PasswordPolicy.Builder requireUppercase(Boolean requireUppercase)

Sets the value of PasswordPolicy.getRequireUppercase()

Parameters:

requireUppercase - Whether the user is required to have uppercase characters in their password.

Returns:

this

tempPasswordValidity

@Stability(Stable)
public PasswordPolicy.Builder tempPasswordValidity(Duration tempPasswordValidity)

Sets the value of PasswordPolicy.getTempPasswordValidity()

Parameters:

tempPasswordValidity - 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.

Returns:

this

build

@Stability(Stable)
public PasswordPolicy build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<PasswordPolicy>

Returns:

a new instance of PasswordPolicy

Throws:

NullPointerException - if any required attribute was not provided