Container for the parameters to the DeleteUserPoolReplica operation. Deletes a secondary replica user pool. You can only delete replicas that are in the INACTIVE status. This operation must be called from the primary 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.DeleteUserPoolReplicaRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class DeleteUserPoolReplicaRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The DeleteUserPoolReplicaRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DeleteUserPoolReplicaRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
RegionName | System.String |
Gets and sets the property RegionName. The Amazon Web Services Region of the replica to delete. |
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool that contains the replica to delete. |
Examples
The following example deletes a user pool replica in the us-east-2 Region.
Example delete a user pool replica
var client = new AmazonCognitoIdentityProviderClient();
var response = client.DeleteUserPoolReplica(new DeleteUserPoolReplicaRequest
{
RegionName = "us-east-2",
UserPoolId = "us-west-2_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