AnalyticsConfiguration Struct
The settings for Amazon Pinpoint analytics configuration.
With an analytics configuration, your application can collect user-activity metrics for user notifications with an 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: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings.
| Source | aws-cognito/lib/user-pool-client.ts |
|---|---|
| Type last changed |
Example
import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
declare const userPool: cognito.UserPool;
declare const pinpointApp: pinpoint.CfnApp;
declare const pinpointRole: iam.Role;
new cognito.UserPoolClient(this, 'Client', {
userPool,
analytics: {
// Your Pinpoint project
application: pinpointApp,
// Whether to include user data in analytics events
shareUserData: true,
},
});
import aws_cdk.aws_pinpoint as pinpoint
# user_pool: cognito.UserPool
# pinpoint_app: pinpoint.CfnApp
# pinpoint_role: iam.Role
cognito.UserPoolClient(self, "Client",
user_pool=user_pool,
analytics=cognito.AnalyticsConfiguration(
# Your Pinpoint project
application=pinpoint_app,
# Whether to include user data in analytics events
share_user_data=True
)
)
import software.amazon.awscdk.services.pinpoint.*;
UserPool userPool;
CfnApp pinpointApp;
Role pinpointRole;
UserPoolClient.Builder.create(this, "Client")
.userPool(userPool)
.analytics(AnalyticsConfiguration.builder()
// Your Pinpoint project
.application(pinpointApp)
// Whether to include user data in analytics events
.shareUserData(true)
.build())
.build();
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Pinpoint;
UserPool userPool;
CfnApp pinpointApp;
Role pinpointRole;
new UserPoolClient(this, "Client", new UserPoolClientProps {
UserPool = userPool,
Analytics = new AnalyticsConfiguration {
// Your Pinpoint project
Application = pinpointApp,
// Whether to include user data in analytics events
ShareUserData = true
}
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import pinpoint "github.com/aws/aws-cdk-go/awscdk"
var userPool UserPool
var pinpointApp CfnApp
var pinpointRole Role
cognito.NewUserPoolClient(this, jsii.String("Client"), &UserPoolClientProps{
UserPool: UserPool,
Analytics: &AnalyticsConfiguration{
// Your Pinpoint project
Application: pinpointApp,
// Whether to include user data in analytics events
ShareUserData: jsii.Boolean(true),
},
})
Properties
applicationoptionalCfnAppapplicationoptionalCfnAppapplicationoptionalCfnAppApplicationoptionalCfnAppApplicationoptionalCfnApp #Default: no configuration, you need to specify either application or all of applicationId, externalId, and role.
notes
Amazon Cognito publishes events to the Amazon Pinpoint project. 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.
applicationIdoptionalstringapplication_idoptionalstrapplicationIdoptionalStringApplicationIdoptionalstringApplicationIdoptional*string #Default: no configuration, you need to specify either this property along with externalId and role or application.
externalIdoptionalstringexternal_idoptionalstrexternalIdoptionalStringExternalIdoptionalstringExternalIdoptional*string #Default: no configuration, you need to specify either this property along with applicationId and role or application.
More info here: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
roleoptionalIRoleRefroleoptionalIRoleRefroleoptionalIRoleRefRoleoptionalIRoleRefRoleoptionalIRoleRef #Default: no configuration, you need to specify either this property along with applicationId and externalId or application.