Table of Contents

Interface CfnUserPoolClient.IAnalyticsConfigurationProperty

Namespace
Amazon.CDK.AWS.Cognito
Assembly
Amazon.CDK.AWS.Cognito.dll

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

public interface CfnUserPoolClient.IAnalyticsConfigurationProperty

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
             };

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html

ExampleMetadata: fixture=_generated

Properties

ApplicationArn

The Amazon Resource Name (ARN) of an Amazon Pinpoint project.

string? ApplicationArn { get; }

Property Value

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html#cfn-cognito-userpoolclient-analyticsconfiguration-applicationarn

ApplicationId

The application ID for an Amazon Pinpoint application.

string? ApplicationId { get; }

Property Value

string

Remarks

ExternalId

The external ID.

string? ExternalId { get; }

Property Value

string

Remarks

RoleArn

The ARN of an AWS Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

string? RoleArn { get; }

Property Value

string

Remarks

UserDataShared

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

object? UserDataShared { get; }

Property Value

object

Remarks