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

Interface PasswordPolicyType.Builder

    • Method Detail

      • minimumLength

        PasswordPolicyType.Builder minimumLength​(Integer minimumLength)

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

        Parameters:
        minimumLength - The minimum length of the password in the policy that you have set. This value can't be less than 6.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requireUppercase

        PasswordPolicyType.Builder requireUppercase​(Boolean requireUppercase)

        The requirement in a password policy that users must include at least one uppercase letter in their password.

        Parameters:
        requireUppercase - The requirement in a password policy that users must include at least one uppercase letter in their password.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requireLowercase

        PasswordPolicyType.Builder requireLowercase​(Boolean requireLowercase)

        The requirement in a password policy that users must include at least one lowercase letter in their password.

        Parameters:
        requireLowercase - The requirement in a password policy that users must include at least one lowercase letter in their password.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requireNumbers

        PasswordPolicyType.Builder requireNumbers​(Boolean requireNumbers)

        The requirement in a password policy that users must include at least one number in their password.

        Parameters:
        requireNumbers - The requirement in a password policy that users must include at least one number in their password.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requireSymbols

        PasswordPolicyType.Builder requireSymbols​(Boolean requireSymbols)

        The requirement in a password policy that users must include at least one symbol in their password.

        Parameters:
        requireSymbols - The requirement in a password policy that users must include at least one symbol in their password.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • passwordHistorySize

        PasswordPolicyType.Builder passwordHistorySize​(Integer passwordHistorySize)

        The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of n previous passwords, where n is the value of PasswordHistorySize.

        Password history isn't enforced and isn't displayed in DescribeUserPool responses when you set this value to 0 or don't provide it. To activate this setting, advanced security features must be active in your user pool.

        Parameters:
        passwordHistorySize - The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of n previous passwords, where n is the value of PasswordHistorySize.

        Password history isn't enforced and isn't displayed in DescribeUserPool responses when you set this value to 0 or don't provide it. To activate this setting, advanced security features must be active in your user pool.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • temporaryPasswordValidityDays

        PasswordPolicyType.Builder temporaryPasswordValidityDays​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.