AWS::Cognito::UserPoolClient AnalyticsConfiguration - AWS CloudFormation
SyntaxProperties

AWS::Cognito::UserPoolClient AnalyticsConfiguration

The settings for Amazon Pinpoint analytics configuration. With an analytics configuration, your application can collect user-activity metrics for user notifications with a Amazon Pinpoint campaign.

Amazon Pinpoint isn't available in all AWS Regions. For a list of available Regions, see Amazon Cognito and Amazon Pinpoint Region availability.

This data type is a request parameter of CreateUserPoolClient and UpdateUserPoolClient, and a response parameter of DescribeUserPoolClient.

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

The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications

Required: No

Type: String

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

Minimum: 20

Maximum: 2048

Update requires: No interruption

ApplicationId

Your Amazon Pinpoint project ID.

Required: No

Type: String

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

Update requires: No interruption

ExternalId

The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.

Required: No

Type: String

Minimum: 0

Maximum: 131072

Update requires: No interruption

RoleArn

The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.

Required: No

Type: String

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

Minimum: 20

Maximum: 2048

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