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

Class UserPoolReplicaType

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

Contains information about a replica user pool, including Region, status, role, and ARN.

See Also:

  • Method Details

    • regionName

      public final String regionName()

      The Amazon Web Services Region where the replica is located.

      Returns:
      The Amazon Web Services Region where the replica is located.

    • status

      public final ReplicaStatusType status()

      The current status of the replica.

      CREATING

      The replica is being created.

      INACTIVE

      The replica has been created, but is not accepting requests for end-users. Administrator configuration operations are supported.

      ACTIVE

      The replica is available for both end-user and administrator operations.

      DELETING

      The replica is being deleted.

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

      Returns:
      The current status of the replica.

      CREATING

      The replica is being created.

      INACTIVE

      The replica has been created, but is not accepting requests for end-users. Administrator configuration operations are supported.

      ACTIVE

      The replica is available for both end-user and administrator operations.

      DELETING

      The replica is being deleted.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the replica.

      CREATING

      The replica is being created.

      INACTIVE

      The replica has been created, but is not accepting requests for end-users. Administrator configuration operations are supported.

      ACTIVE

      The replica is available for both end-user and administrator operations.

      DELETING

      The replica is being deleted.

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

      Returns:
      The current status of the replica.

      CREATING

      The replica is being created.

      INACTIVE

      The replica has been created, but is not accepting requests for end-users. Administrator configuration operations are supported.

      ACTIVE

      The replica is available for both end-user and administrator operations.

      DELETING

      The replica is being deleted.

      See Also:

    • role

      public final ReplicaRoleType role()

      The role of the user pool replica that determines which API operations are enabled.

      PRIMARY

      The primary replica supports all end user and administrator operations.

      SECONDARY

      The secondary replica supports a limited set of end user and administrator operations. Generally, only administrator operations that set configurations specific to the replica, and only end-user operations that do not create or change attributes of a user are supported.

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

      Returns:
      The role of the user pool replica that determines which API operations are enabled.

      PRIMARY

      The primary replica supports all end user and administrator operations.

      SECONDARY

      The secondary replica supports a limited set of end user and administrator operations. Generally, only administrator operations that set configurations specific to the replica, and only end-user operations that do not create or change attributes of a user are supported.

      See Also:

    • roleAsString

      public final String roleAsString()

      The role of the user pool replica that determines which API operations are enabled.

      PRIMARY

      The primary replica supports all end user and administrator operations.

      SECONDARY

      The secondary replica supports a limited set of end user and administrator operations. Generally, only administrator operations that set configurations specific to the replica, and only end-user operations that do not create or change attributes of a user are supported.

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

      Returns:
      The role of the user pool replica that determines which API operations are enabled.

      PRIMARY

      The primary replica supports all end user and administrator operations.

      SECONDARY

      The secondary replica supports a limited set of end user and administrator operations. Generally, only administrator operations that set configurations specific to the replica, and only end-user operations that do not create or change attributes of a user are supported.

      See Also:

    • userPoolArn

      public final String userPoolArn()

      The Amazon Resource Name (ARN) of the replica user pool.

      Returns:
      The Amazon Resource Name (ARN) of the replica user pool.

    • toBuilder

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

    • builder

      public static UserPoolReplicaType.Builder builder()

    • serializableBuilderClass

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