Container for the parameters to the CreateUserPoolReplica operation. 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
In this article ▶
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
Amazon.CognitoIdentityProvider.Model.CreateUserPoolReplicaRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class CreateUserPoolReplicaRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The CreateUserPoolReplicaRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateUserPoolReplicaRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
RegionName | System.String |
Gets and sets the property RegionName. The Amazon Web Services Region where you want to create the replica user pool. |
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool to replicate. |
|
|
UserPoolTags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property UserPoolTags. A map of tags to assign to the replica user pool. Each tag consists of a key and an optional value, both of which you define. You can maintain tags independently on replica user pools. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
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:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer