Container for the parameters to the UpdateUserPoolReplica operation. Updates replica-specific settings for a user pool replica. You can modify the status to activate or deactivate the replica. This request can be made in both primary and secondary regions of the user pool.
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.UpdateUserPoolReplicaRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class UpdateUserPoolReplicaRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The UpdateUserPoolReplicaRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UpdateUserPoolReplicaRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
RegionName | System.String |
Gets and sets the property RegionName. The Amazon Web Services Region of the replica to update. |
|
|
Status | Amazon.CognitoIdentityProvider.UpdateReplicaStatusType |
Gets and sets the property Status. The status to set for the replica. Valid values are ACTIVE and INACTIVE. |
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool that contains the replica to update. |
Examples
The following example sets the status of a user pool replica in the us-east-1 Region to ACTIVE.
Example update a user pool replica
var client = new AmazonCognitoIdentityProviderClient();
var response = client.UpdateUserPoolReplica(new UpdateUserPoolReplicaRequest
{
RegionName = "us-east-1",
Status = "ACTIVE",
UserPoolId = "ap-south-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