interface AnalyticsConfigurationProperty

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

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const analyticsConfigurationProperty: cognito.CfnUserPoolClient.AnalyticsConfigurationProperty = {
  applicationArn: 'applicationArn',
  applicationId: 'applicationId',
  externalId: 'externalId',
  roleArn: 'roleArn',
  userDataShared: false,
};

Properties

Name	Type	Description
applicationArn?	`string`	The Amazon Resource Name (ARN) of an 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.
roleArn?	`string`	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.
userDataShared?	`boolean \|` `IResolvable`	If `UserDataShared` is `true` , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

applicationArn?

Type: string (optional)

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

applicationId?

Type: string (optional)

Your Amazon Pinpoint project ID.

externalId?

Type: string (optional)

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

roleArn?

Type: string (optional)

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.

userDataShared?

Type: boolean | IResolvable (optional)

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