View a markdown version of this page

AWS::Cognito::UserPoolReplica - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Cognito::UserPoolReplica

Creates a replica of an existing user pool in a specified AWS 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.

Note

Amazon Cognito evaluates AWS 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

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Cognito::UserPoolReplica",
  "Properties" : {
      "RegionName" : String,
      "UserPoolId" : String,
      "UserPoolTagsAtCreate" : {Key: Value, ...}
    }
}

YAML

Type: AWS::Cognito::UserPoolReplica
Properties:
  RegionName: String
  UserPoolId: String
  UserPoolTagsAtCreate: 
    Key: Value

Properties

RegionName

The AWS Region where the replica is located.

Required: Yes

Type: String

Minimum: 5

Maximum: 32

Update requires: Replacement

UserPoolId

The ID of the user pool to replicate.

Required: Yes

Type: String

Pattern: [\w-]+_[0-9a-zA-Z]+

Minimum: 1

Maximum: 55

Update requires: Replacement

UserPoolTagsAtCreate

A map of tags to assign to the replica user pool at creation. Each tag consists of a key and an optional value. You cannot modify tags through this resource after creation. To update tags on the replica, use the UserPoolRegionalConfigurationAttachment resource in the secondary Region.

Required: No

Type: Object of String

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Update requires: Replacement

Return values

Ref