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

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

Overview

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,
}

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.

<note markdown=“1”> In Regions where Amazon Pinpointisn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

</note>

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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 to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.

Returns:

  • (String) 


2297
2298
2299
2300
2301
2302
2303
2304
2305
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2297

class AnalyticsConfigurationType < Struct.new(
  :application_id,
  :application_arn,
  :role_arn,
  :external_id,
  :user_data_shared)
  SENSITIVE = []
  include Aws::Structure
end

#application_id ⇒ String

The application ID for an Amazon Pinpoint application.

Returns:

  • (String) 


2297
2298
2299
2300
2301
2302
2303
2304
2305
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2297

class AnalyticsConfigurationType < Struct.new(
  :application_id,
  :application_arn,
  :role_arn,
  :external_id,
  :user_data_shared)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

The external ID.

Returns:

  • (String) 


2297
2298
2299
2300
2301
2302
2303
2304
2305
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2297

class AnalyticsConfigurationType < Struct.new(
  :application_id,
  :application_arn,
  :role_arn,
  :external_id,
  :user_data_shared)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

Returns:

  • (String) 


2297
2298
2299
2300
2301
2302
2303
2304
2305
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2297

class AnalyticsConfigurationType < Struct.new(
  :application_id,
  :application_arn,
  :role_arn,
  :external_id,
  :user_data_shared)
  SENSITIVE = []
  include Aws::Structure
end

#user_data_shared ⇒ Boolean

If `UserDataShared` is `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

Returns:

  • (Boolean) 


2297
2298
2299
2300
2301
2302
2303
2304
2305
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2297

class AnalyticsConfigurationType < Struct.new(
  :application_id,
  :application_arn,
  :role_arn,
  :external_id,
  :user_data_shared)
  SENSITIVE = []
  include Aws::Structure
end