You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::AnalyticsConfigurationType

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AnalyticsConfigurationType as input to an Aws::Client method, you can use a vanilla Hash:

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

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

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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_arn ⇒ String

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.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of an Amazon Pinpoint project.

#application_id ⇒ String

The application ID for an Amazon Pinpoint application.

Returns:

  • (String) —

    The application ID for an Amazon Pinpoint application.

#external_id ⇒ String

The external ID.

Returns:

  • (String) —

    The external ID.

#role_arn ⇒ String

The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

Returns:

  • (String) —

    The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

#user_data_shared ⇒ Boolean

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

Returns:

  • (Boolean) —

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