interface AnalyticsConfiguration

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.AnalyticsConfiguration
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscognito#AnalyticsConfiguration
Java	software.amazon.awscdk.services.cognito.AnalyticsConfiguration
Python	aws_cdk.aws_cognito.AnalyticsConfiguration
TypeScript (source)	aws-cdk-lib » aws_cognito » AnalyticsConfiguration

The settings for Amazon Pinpoint analytics configuration.

With an analytics configuration, your application can collect user-activity metrics for user notifications with an 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: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings.

Example

import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';

declare const userPool: cognito.UserPool;
declare const pinpointApp: pinpoint.CfnApp;
declare const pinpointRole: iam.Role;

new cognito.UserPoolClient(this, 'Client', {
  userPool,
  analytics: {
    // Your Pinpoint project
    application: pinpointApp,

    // Whether to include user data in analytics events
    shareUserData: true,
  },
});

Properties

Name	Type	Description
application?	CfnApp	The Amazon Pinpoint project that you want to connect to your user pool app client.
applicationId?	string	Your Amazon Pinpoint project ID.
externalId?	string	The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
role?	IRoleRef	The IAM role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.
shareUserData?	boolean	If true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

---

application?

Type: CfnApp (optional, default: no configuration, you need to specify either application or all of applicationId, externalId, and role.)

The Amazon Pinpoint project that you want to connect to your user pool app client.

Amazon Cognito publishes events to the Amazon Pinpoint project. 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.

---

applicationId?

Type: string (optional, default: no configuration, you need to specify either this property along with externalId and role or application.)

Your Amazon Pinpoint project ID.

---

externalId?

Type: string (optional, default: no configuration, you need to specify either this property along with applicationId and role or application.)

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

More info here: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

---

role?

Type: IRoleRef (optional, default: no configuration, you need to specify either this property along with applicationId and externalId or application.)

The IAM role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.

---

shareUserData?

Type: boolean (optional, default: false)

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