Struct aws_sdk_cognitoidentityprovider::types::AnalyticsConfigurationType

#[non_exhaustive]
pub struct AnalyticsConfigurationType {
    pub application_id: Option<String>,
    pub application_arn: Option<String>,
    pub role_arn: Option<String>,
    pub external_id: Option<String>,
    pub user_data_shared: bool,
}

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

In Regions where Amazon Pinpoint isn'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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

application_id: Option<String>

The application ID for an Amazon Pinpoint application.

application_arn: Option<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.

role_arn: Option<String>

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

external_id: Option<String>

The external ID.

user_data_shared: bool

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

Implementations

impl AnalyticsConfigurationType

pub fn application_id(&self) -> Option<&str>

The application ID for an Amazon Pinpoint application.

pub fn application_arn(&self) -> Option<&str>

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.

pub fn role_arn(&self) -> Option<&str>

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

pub fn external_id(&self) -> Option<&str>

The external ID.

pub fn user_data_shared(&self) -> bool

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

impl AnalyticsConfigurationType

pub fn builder() -> AnalyticsConfigurationTypeBuilder

Creates a new builder-style object to manufacture AnalyticsConfigurationType.

Trait Implementations

impl Clone for AnalyticsConfigurationType

fn clone(&self) -> AnalyticsConfigurationType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AnalyticsConfigurationType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AnalyticsConfigurationType

fn eq(&self, other: &AnalyticsConfigurationType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AnalyticsConfigurationType