AWS::Cognito::UserPoolClient AnalyticsConfiguration - Amazon CloudFormation
SyntaxProperties
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).

AWS::Cognito::UserPoolClient AnalyticsConfiguration

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.

Note

In Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

Syntax

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

JSON

{
  "ApplicationArn" : String,
  "ApplicationId" : String,
  "ExternalId" : String,
  "RoleArn" : String,
  "UserDataShared" : Boolean
}

YAML

  ApplicationArn: String
  ApplicationId: String
  ExternalId: String
  RoleArn: String
  UserDataShared: Boolean

Properties

ApplicationArn

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for integration with the chosen user pool client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.

Required: No

Type: String

Update requires: No interruption

ApplicationId

The application ID for an Amazon Pinpoint application.

Required: No

Type: String

Pattern: ^[0-9a-fA-F]+$

Update requires: No interruption

ExternalId

The external ID.

Required: No

Type: String

Minimum: 0

Maximum: 131072

Update requires: No interruption

RoleArn

The ARN of an Amazon Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

Required: No

Type: String

Minimum: 20

Maximum: 2048

Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Update requires: No interruption

UserDataShared

If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

Required: No

Type: Boolean

Update requires: No interruption