Class CfnUserPoolClient.AnalyticsConfigurationProperty
The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
Inheritance
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AnalyticsConfigurationProperty : Object, CfnUserPoolClient.IAnalyticsConfigurationProperty
Syntax (vb)
Public Class AnalyticsConfigurationProperty
Inherits Object
Implements CfnUserPoolClient.IAnalyticsConfigurationProperty
Remarks
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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var analyticsConfigurationProperty = new AnalyticsConfigurationProperty {
ApplicationArn = "applicationArn",
ApplicationId = "applicationId",
ExternalId = "externalId",
RoleArn = "roleArn",
UserDataShared = false
};
Synopsis
Constructors
AnalyticsConfigurationProperty() |
Properties
ApplicationArn | The Amazon Resource Name (ARN) of an Amazon Pinpoint project. |
ApplicationId | The application ID for an Amazon Pinpoint application. |
ExternalId | The external ID. |
RoleArn | The ARN of an AWS Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. |
UserDataShared | If |
Constructors
AnalyticsConfigurationProperty()
public AnalyticsConfigurationProperty()
Properties
ApplicationArn
The Amazon Resource Name (ARN) of an Amazon Pinpoint project.
public string ApplicationArn { get; set; }
Property Value
System.String
Remarks
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
The application ID for an Amazon Pinpoint application.
public string ApplicationId { get; set; }
Property Value
System.String
Remarks
ExternalId
The external ID.
public string ExternalId { get; set; }
Property Value
System.String
Remarks
RoleArn
The ARN of an AWS Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
UserDataShared
If UserDataShared
is true
, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
public object UserDataShared { get; set; }
Property Value
System.Object