AmazonCognitoIdentityProviderClient.CreateUserPoolReplica Method (CreateUserPoolReplicaRequest)

Creates a replica of an existing user pool in a specified Amazon Web Services Region. The replica enables multi-region replication for high availability and disaster recovery. To create a replica, you must have permissions to create user pools in the target Region.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateUserPoolReplicaAsync.

Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public virtual CreateUserPoolReplicaResponse CreateUserPoolReplica(
         CreateUserPoolReplicaRequest request
)

Parameters

request: Type: Amazon.CognitoIdentityProvider.Model.CreateUserPoolReplicaRequest

Container for the necessary parameters to execute the CreateUserPoolReplica service method.

Return Value

Type: CreateUserPoolReplicaResponse

The response from the CreateUserPoolReplica service method, as returned by CognitoIdentityProvider.

Exceptions

Exception	Condition
FeatureUnavailableInTierException	This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.
InternalErrorException	This exception is thrown when Amazon Cognito encounters an internal error.
InvalidParameterException	This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
LimitExceededException	This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
NotAuthorizedException	This exception is thrown when a user isn't authorized.
OperationNotEnabledException	This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.
ResourceNotFoundException	This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException	This exception is thrown when the user has made too many requests for a given operation.
UserPoolTaggingException	This exception is thrown when a user pool tag can't be set or updated.

Examples

The following example creates a replica of a user pool in the ap-south-1 Region.

Example create a replica of a user pool in a new Region


var client = new AmazonCognitoIdentityProviderClient();
var response = client.CreateUserPoolReplica(new CreateUserPoolReplicaRequest 
{
    RegionName = "ap-south-1",
    UserPoolId = "us-east-1_abcd12345"
});

UserPoolReplicaType userPoolReplica = response.UserPoolReplica;

Version Information

.NET Framework:
Supported in: 4.7.2 and newer

AmazonCognitoIdentityProviderClient.CreateUserPoolReplica (CreateUserPoolReplicaRequest)

Method