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

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The application ID for an Amazon Pinpoint application.

Returns:

  • (String) 


1754
1755
1756
1757
1758
1759
1760
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1754

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) 


1754
1755
1756
1757
1758
1759
1760
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1754

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) 


1754
1755
1756
1757
1758
1759
1760
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1754

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) 


1754
1755
1756
1757
1758
1759
1760
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1754

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