View a markdown version of this page

AWS::Cognito::UserPoolRegionalConfigurationAttachment - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::Cognito::UserPoolRegionalConfigurationAttachment

The Regional settings for a user pool replica, including email configuration, SMS configuration, Amazon Lambda triggers, tags, and replica status. Create this resource in the secondary (replica) Region. The replica must be in ACTIVE or INACTIVE status before you create this resource.

Syntax

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

JSON

{
  "Type" : "AWS::Cognito::UserPoolRegionalConfigurationAttachment",
  "Properties" : {
      "EmailConfiguration" : EmailConfiguration,
      "LambdaConfig" : LambdaConfig,
      "SmsConfiguration" : SmsConfiguration,
      "Status" : String,
      "UserPoolId" : String,
      "UserPoolTags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::Cognito::UserPoolRegionalConfigurationAttachment
Properties:
  EmailConfiguration: 
    EmailConfiguration
  LambdaConfig: 
    LambdaConfig
  SmsConfiguration: 
    SmsConfiguration
  Status: String
  UserPoolId: String
  UserPoolTags: 
    Key: Value

Properties

EmailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Region, and sender for email invitation and verification messages from your user pool.

Required: No

Type: EmailConfiguration

Update requires: No interruption

LambdaConfig

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.

Required: No

Type: LambdaConfig

Update requires: No interruption

SmsConfiguration

The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Region that you want, the Amazon Cognito user pool uses an Amazon Identity and Access Management (IAM) role in your Amazon Web Services account. For more information see SMS message settings.

Required: No

Type: SmsConfiguration

Update requires: No interruption

Status

The status of the replica. Valid values are ACTIVE and INACTIVE. If you don't specify a value, the default is INACTIVE.

Required: No

Type: String

Update requires: No interruption

UserPoolId

The ID of the user pool. The user pool must have a replica in the Region where you create this resource.

Required: Yes

Type: String

Update requires: Replacement

UserPoolTags

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Required: No

Type: Object of String

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

Update requires: No interruption

Return values

Ref