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", # required
  role_arn: "ArnType", # required
  external_id: "StringType", # required
  user_data_shared: false,
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The application ID for an Amazon Pinpoint application.

Returns:

  • (String)

    The application ID for an Amazon Pinpoint application.

#external_idString

The external ID.

Returns:

  • (String)

    The external ID.

#role_arnString

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_sharedBoolean

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.