Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class PasswordPolicyType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.PasswordPolicyType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PasswordPolicyType.Builder,PasswordPolicyType>

@Generated("software.amazon.awssdk:codegen")
public final class PasswordPolicyType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PasswordPolicyType.Builder,PasswordPolicyType>

The password policy type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PasswordPolicyType.Builder

Method Summary

Modifier and Type	Method	Description
static PasswordPolicyType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	minimumLength()	The minimum length of the password in the policy that you have set.
Boolean	requireLowercase()	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.
Boolean	requireNumbers()	In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
Boolean	requireSymbols()	In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
Boolean	requireUppercase()	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.
List<SdkField<?>>	sdkFields()
static Class<? extends PasswordPolicyType.Builder>	serializableBuilderClass()
Integer	temporaryPasswordValidityDays()	The number of days a temporary password is valid in the password policy.
PasswordPolicyType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

minimumLength

public final Integer minimumLength()

The minimum length of the password in the policy that you have set. This value can't be less than 6.

Returns:

The minimum length of the password in the policy that you have set. This value can't be less than 6.

requireUppercase

public final Boolean requireUppercase()

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:

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.

requireLowercase

public final Boolean requireLowercase()

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:

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.

requireNumbers

public final Boolean requireNumbers()

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:

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

requireSymbols

public final Boolean requireSymbols()

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:

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

temporaryPasswordValidityDays

public final Integer temporaryPasswordValidityDays()

The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to 7. If you submit a value of 0, Amazon Cognito treats it as a null value and sets TemporaryPasswordValidityDays to its default value.

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

Returns:

The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to 7. If you submit a value of 0, Amazon Cognito treats it as a null value and sets TemporaryPasswordValidityDays to its default value.

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

toBuilder

public PasswordPolicyType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PasswordPolicyType.Builder,PasswordPolicyType>

builder

public static PasswordPolicyType.Builder builder()

serializableBuilderClass

public static Class<? extends PasswordPolicyType.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo