cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/AnalyticsConfigurationType

AnalyticsConfigurationType

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 Amazon Web Services Regions. For a list of available Regions, see Amazon Cognito and Amazon Pinpoint Region availability.

Types

Builder

class Builder

Companion

object Companion

Properties

applicationArn

val applicationArn: String?

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

val applicationId: String?

Your Amazon Pinpoint project ID.

externalId

val externalId: String?

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

roleArn

val roleArn: String?

The ARN of an Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.

userDataShared

val userDataShared: Boolean

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

Functions

copy

inline fun copy(block: AnalyticsConfigurationType.Builder.() -> Unit = {}): AnalyticsConfigurationType

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String