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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass AnalyticsConfigurationType data as a 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.

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The application ID for an Amazon Pinpoint application.

Returns:

  • (String) 


2143
2144
2145
2146
2147
2148
2149
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2143

class AnalyticsConfigurationType < Struct.new(
  :application_id,
  :role_arn,
  :external_id,
  :user_data_shared)
  include Aws::Structure
end

#external_id ⇒ String

The external ID.

Returns:

  • (String) 


2143
2144
2145
2146
2147
2148
2149
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2143

class AnalyticsConfigurationType < Struct.new(
  :application_id,
  :role_arn,
  :external_id,
  :user_data_shared)
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

  • (String) 


2143
2144
2145
2146
2147
2148
2149
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2143

class AnalyticsConfigurationType < Struct.new(
  :application_id,
  :role_arn,
  :external_id,
  :user_data_shared)
  include Aws::Structure
end

#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) 


2143
2144
2145
2146
2147
2148
2149
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2143

class AnalyticsConfigurationType < Struct.new(
  :application_id,
  :role_arn,
  :external_id,
  :user_data_shared)
  include Aws::Structure
end