AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Contains information about a replica user pool, including Region, status, role, and ARN.

Inheritance Hierarchy

System.Object
  Amazon.CognitoIdentityProvider.Model.UserPoolReplicaType

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

Syntax

C#
public class UserPoolReplicaType

The UserPoolReplicaType type exposes the following members

Constructors

NameDescription
Public Method UserPoolReplicaType()

Properties

NameTypeDescription
Public Property RegionName System.String

Gets and sets the property RegionName.

The Amazon Web Services Region where the replica is located.

Public Property Role Amazon.CognitoIdentityProvider.ReplicaRoleType

Gets and sets the property Role.

The role of the user pool replica that determines which API operations are enabled.

PRIMARY

The primary replica supports all end user and administrator operations.

SECONDARY

The secondary replica supports a limited set of end user and administrator operations. Generally, only administrator operations that set configurations specific to the replica, and only end-user operations that do not create or change attributes of a user are supported.

Public Property Status Amazon.CognitoIdentityProvider.ReplicaStatusType

Gets and sets the property Status.

The current status of the replica.

CREATING

The replica is being created.

INACTIVE

The replica has been created, but is not accepting requests for end-users. Administrator configuration operations are supported.

ACTIVE

The replica is available for both end-user and administrator operations.

DELETING

The replica is being deleted.

Public Property UserPoolArn System.String

Gets and sets the property UserPoolArn.

The Amazon Resource Name (ARN) of the replica user pool.

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