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 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.

See Also:
  • Method Details

    • applicationId

      public final String applicationId()

      The application ID for an Amazon Pinpoint application.

      Returns:
      The application ID for an Amazon Pinpoint application.
    • applicationArn

      public final String applicationArn()

      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:
      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.
    • roleArn

      public final String roleArn()

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

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

      public final String externalId()

      The external ID.

      Returns:
      The external ID.
    • 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

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AnalyticsConfigurationType.Builder,AnalyticsConfigurationType>
      Returns:
      a builder for type T
    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.