Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolClient.AnalyticsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolClient.AnalyticsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnUserPoolClient

@Stability(Stable)
public static interface CfnUserPoolClient.AnalyticsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 .

This data type is a request parameter of CreateUserPoolClient and UpdateUserPoolClient , and a response parameter of DescribeUserPoolClient .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 AnalyticsConfigurationProperty analyticsConfigurationProperty = AnalyticsConfigurationProperty.builder()
         .applicationArn("applicationArn")
         .applicationId("applicationId")
         .externalId("externalId")
         .roleArn("roleArn")
         .userDataShared(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolClient.AnalyticsConfigurationProperty.Builder	A builder for CfnUserPoolClient.AnalyticsConfigurationProperty
static final class	CfnUserPoolClient.AnalyticsConfigurationProperty.Jsii$Proxy	An implementation for CfnUserPoolClient.AnalyticsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolClient.AnalyticsConfigurationProperty.Builder	builder()
default String	getApplicationArn()	The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client.
default String	getApplicationId()	Your Amazon Pinpoint project ID.
default String	getExternalId()	The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.
default String	getRoleArn()	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.
default Object	getUserDataShared()	If UserDataShared is true , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationArn

@Stability(Stable)
@Nullable
default String getApplicationArn()

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

See Also:

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

getApplicationId

@Stability(Stable)
@Nullable
default String getApplicationId()

Your Amazon Pinpoint project ID.

See Also:

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

getExternalId

@Stability(Stable)
@Nullable
default String getExternalId()

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

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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.

See Also:

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

getUserDataShared

@Stability(Stable)
@Nullable
default Object getUserDataShared()

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

See Also:

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

builder

@Stability(Stable)
static CfnUserPoolClient.AnalyticsConfigurationProperty.Builder builder()

Returns:

a CfnUserPoolClient.AnalyticsConfigurationProperty.Builder of CfnUserPoolClient.AnalyticsConfigurationProperty