Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AnalyticsConfigurationType

java.lang.Object
software.amazon.awssdk.services.cognitoidentityprovider.model.AnalyticsConfigurationType
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AnalyticsConfigurationType.Builder,AnalyticsConfigurationType>
@Generated("software.amazon.awssdk:codegen") public final class AnalyticsConfigurationType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AnalyticsConfigurationType.Builder,AnalyticsConfigurationType>

The settings for Amazon Pinpoint analytics configuration. With an analytics configuration, your application can collect user-activity metrics for user notifications with a Amazon Pinpoint campaign.

Amazon Pinpoint isn't available in all Amazon Web Services Regions. For a list of available Regions, see Amazon Cognito and Amazon Pinpoint Region availability.

See Also:

  • Method Details

    • applicationId

      public final String applicationId()

      Your Amazon Pinpoint project ID.

      Returns:
      Your Amazon Pinpoint project ID.

    • applicationArn

      public final String applicationArn()

      The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications

      Returns:
      The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that ApplicationArn declares. You can also configure your application to pass an endpoint ID in the AnalyticsMetadata parameter of sign-in operations. The endpoint ID is information about the destination for push notifications

    • roleArn

      public final String roleArn()

      The ARN of an Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.

      Returns:
      The ARN of an Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.

    • externalId

      public final String externalId()

      The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.

      Returns:
      The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.

    • userDataShared

      public final Boolean userDataShared()

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

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

    • toBuilder

      public AnalyticsConfigurationType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<AnalyticsConfigurationType.Builder,AnalyticsConfigurationType>

    • builder

      public static AnalyticsConfigurationType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AnalyticsConfigurationType.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo