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:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnUserPoolClient.AnalyticsConfigurationProperty
static final class
An implementation forCfnUserPoolClient.AnalyticsConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The Amazon Resource Name (ARN) of an Amazon Pinpoint project.default String
Your Amazon Pinpoint project ID.default String
The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.default String
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
IfUserDataShared
istrue
, 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
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.
- See Also:
-
getApplicationId
Your Amazon Pinpoint project ID.- See Also:
-
getExternalId
The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.- See Also:
-
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:
-
builder
-