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

Interface UserPoolReplicaType.Builder

All Superinterfaces:
Buildable, CopyableBuilder<UserPoolReplicaType.Builder,UserPoolReplicaType>, SdkBuilder<UserPoolReplicaType.Builder,UserPoolReplicaType>, SdkPojo
Enclosing class:
UserPoolReplicaType
@Mutable @NotThreadSafe public static interface UserPoolReplicaType.Builder extends SdkPojo, CopyableBuilder<UserPoolReplicaType.Builder,UserPoolReplicaType>

  • Method Details

    • regionName

      UserPoolReplicaType.Builder regionName(String regionName)

      The Amazon Web Services Region where the replica is located.

      Parameters:
      regionName - The Amazon Web Services Region where the replica is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      UserPoolReplicaType.Builder status(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      UserPoolReplicaType.Builder status(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • role

      UserPoolReplicaType.Builder role(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • role

      UserPoolReplicaType.Builder role(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userPoolArn

      UserPoolReplicaType.Builder userPoolArn(String userPoolArn)

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

      Parameters:
      userPoolArn - The Amazon Resource Name (ARN) of the replica user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.