Class CreateBackendAuthUserPoolConfig

java.lang.Object
software.amazon.awssdk.services.amplifybackend.model.CreateBackendAuthUserPoolConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CreateBackendAuthUserPoolConfig.Builder,CreateBackendAuthUserPoolConfig>
@Generated("software.amazon.awssdk:codegen") public final class CreateBackendAuthUserPoolConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CreateBackendAuthUserPoolConfig.Builder,CreateBackendAuthUserPoolConfig>

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

See Also:

  • Method Details

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

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

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

    • toBuilder

      public CreateBackendAuthUserPoolConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateBackendAuthUserPoolConfig.Builder,CreateBackendAuthUserPoolConfig>
      Returns:
      a builder for type T

    • builder

      public static CreateBackendAuthUserPoolConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateBackendAuthUserPoolConfig.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.