cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider/updateUserPoolReplica

updateUserPoolReplica

inline suspend fun CognitoIdentityProviderClient.updateUserPoolReplica(crossinline block: UpdateUserPoolReplicaRequest.Builder.() -> Unit): UpdateUserPoolReplicaResponse

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

Samples

// The following example sets the status of a user pool replica in the us east 1 Region to ACTIVE.
val resp = cognitoIdentityProviderClient.updateUserPoolReplica {
    userPoolId = "ap-south-1_abcd12345"
    regionName = "us-east-1"
    status = UpdateReplicaStatusType.fromValue("ACTIVE")
}