Package software.amazon.awssdk.services.amplifybackend.model

Class CreateBackendAuthUserPoolConfig

    • Method Detail

      • forgotPassword

        public final CreateBackendAuthForgotPasswordConfig forgotPassword()

        (DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

        Returns:
        (DEPRECATED)

      • mfa

        public final CreateBackendAuthMFAConfig mfa()

        Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

        Returns:
        Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

      • oAuth

        public final CreateBackendAuthOAuthConfig oAuth()

        Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

        Returns:
        Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

      • passwordPolicy

        public final CreateBackendAuthPasswordPolicyConfig passwordPolicy()

        Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

        Returns:
        Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

      • requiredSignUpAttributes

        public final List<RequiredSignUpAttributesElement> requiredSignUpAttributes()

        The required attributes to sign up new users in the user pool.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiredSignUpAttributes() method.

        Returns:
        The required attributes to sign up new users in the user pool.

      • hasRequiredSignUpAttributes

        public final boolean hasRequiredSignUpAttributes()
        For responses, this returns true if the service returned a value for the RequiredSignUpAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • requiredSignUpAttributesAsStrings

        public final List<String> requiredSignUpAttributesAsStrings()

        The required attributes to sign up new users in the user pool.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiredSignUpAttributes() method.

        Returns:
        The required attributes to sign up new users in the user pool.

      • signInMethod

        public final SignInMethod signInMethod()

        Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

        If the service returns an enum value that is not available in the current SDK version, signInMethod will return SignInMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signInMethodAsString().

        Returns:
        Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.
        See Also:
        SignInMethod

      • signInMethodAsString

        public final String signInMethodAsString()

        Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

        If the service returns an enum value that is not available in the current SDK version, signInMethod will return SignInMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signInMethodAsString().

        Returns:
        Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.
        See Also:
        SignInMethod

      • userPoolName

        public final String userPoolName()

        The Amazon Cognito user pool name.

        Returns:
        The Amazon Cognito user pool name.

      • verificationMessage

        public final CreateBackendAuthVerificationMessageConfig verificationMessage()

        Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

        Returns:
        Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)