class Aws::CognitoIdentityProvider::Types::AnalyticsConfigurationType

The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.

<note markdown=“1”> In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

</note>

@note When making an API call, you may pass AnalyticsConfigurationType

data as a hash:

    {
      application_id: "HexStringType",
      application_arn: "ArnType",
      role_arn: "ArnType",
      external_id: "StringType",
      user_data_shared: false,
    }

@!attribute [rw] application_id

The application ID for an Amazon Pinpoint application.
@return [String]

@!attribute [rw] application_arn

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You
can use the Amazon Pinpoint project for Pinpoint integration with
the chosen User Pool Client. Amazon Cognito publishes events to the
pinpoint project declared by the app ARN.
@return [String]

@!attribute [rw] role_arn

The ARN of an IAM role that authorizes Amazon Cognito to publish
events to Amazon Pinpoint analytics.
@return [String]

@!attribute [rw] external_id

The external ID.
@return [String]

@!attribute [rw] user_data_shared

If `UserDataShared` is `true`, Amazon Cognito will include user data
in the events it publishes to Amazon Pinpoint analytics.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AnalyticsConfigurationType AWS API Documentation

Constants

SENSITIVE