interface AnalyticsConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.CfnUserPoolClient.AnalyticsConfigurationProperty
Java	software.amazon.awscdk.services.cognito.CfnUserPoolClient.AnalyticsConfigurationProperty
Python	aws_cdk.aws_cognito.CfnUserPoolClient.AnalyticsConfigurationProperty
TypeScript	@aws-cdk/aws-cognito » CfnUserPoolClient » AnalyticsConfigurationProperty

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

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cognito from '@aws-cdk/aws-cognito';
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.
applicationId?	string	The application ID for an Amazon Pinpoint application.
externalId?	string	The external ID.
roleArn?	string	The ARN of an AWS Identity and Access Management role that authorizes 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.

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.

---

applicationId?

Type: string (optional)

The application ID for an Amazon Pinpoint application.

---

externalId?

Type: string (optional)

The external ID.

---

roleArn?

Type: string (optional)

The ARN of an AWS Identity and Access Management role that authorizes 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.