AWS::Cognito::UserPoolClient AnalyticsConfiguration

The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.

Note

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

Syntax

To declare this entity in your AWS 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

Not currently supported by AWS CloudFormation.

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

Update requires: No interruption

RoleArn

The ARN of an IAM 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 will include user data in the events it publishes to Amazon Pinpoint analytics.

Required: No

Type: Boolean

Update requires: No interruption