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

Class UserPoolDescriptionType

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

A short description of a user pool.

See Also:

  • Method Details

    • id

      public final String id()

      The user pool ID.

      Returns:
      The user pool ID.

    • name

      public final String name()

      The user pool name.

      Returns:
      The user pool name.

    • lambdaConfig

      public final LambdaConfigType lambdaConfig()

      A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

      Returns:
      A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

    • status

      @Deprecated public final StatusType status()
      Deprecated.
      This property is no longer available.

      The user pool status.

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

      Returns:
      The user pool status.
      See Also:

    • statusAsString

      @Deprecated public final String statusAsString()
      Deprecated.
      This property is no longer available.

      The user pool status.

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

      Returns:
      The user pool status.
      See Also:

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      Returns:
      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

    • creationDate

      public final Instant creationDate()

      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      Returns:
      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

    • hasReplicaRegions

      public final boolean hasReplicaRegions()
      For responses, this returns true if the service returned a value for the ReplicaRegions 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.

    • replicaRegions

      public final List<String> replicaRegions()

      A list of Amazon Web Services Regions where replicas of this user pool exist.

      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 hasReplicaRegions() method.

      Returns:
      A list of Amazon Web Services Regions where replicas of this user pool exist.

    • toBuilder

      public UserPoolDescriptionType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UserPoolDescriptionType.Builder,UserPoolDescriptionType>

    • builder

      public static UserPoolDescriptionType.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo