Class UserPoolConfig

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

Describes an Amazon Cognito user pool configuration.

See Also:

  • Method Details

    • userPoolId

      public final String userPoolId()

      The user pool ID.

      Returns:
      The user pool ID.

    • awsRegion

      public final String awsRegion()

      The Amazon Web Services Region in which the user pool was created.

      Returns:
      The Amazon Web Services Region in which the user pool was created.

    • defaultAction

      public final DefaultAction defaultAction()

      The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

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

      Returns:
      The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.
      See Also:

    • defaultActionAsString

      public final String defaultActionAsString()

      The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

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

      Returns:
      The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.
      See Also:

    • appIdClientRegex

      public final String appIdClientRegex()

      A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

      Returns:
      A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

    • toBuilder

      public UserPoolConfig.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<UserPoolConfig.Builder,UserPoolConfig>
      Returns:
      a builder for type T

    • builder

      public static UserPoolConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UserPoolConfig.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.