AnalyticsConfigurationType (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidp.model.AnalyticsConfigurationType

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AnalyticsConfigurationType
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AnalyticsConfigurationType()

Constructors
Constructor and Description
`AnalyticsConfigurationType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalyticsConfigurationType`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApplicationId()` The application ID for an Amazon Pinpoint application.
`String`	`getExternalId()` The external ID.
`String`	`getRoleArn()` The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
`Boolean`	`getUserDataShared()` If `UserDataShared` is `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
`int`	`hashCode()`
`Boolean`	`isUserDataShared()` If `UserDataShared` is `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApplicationId(String applicationId)` The application ID for an Amazon Pinpoint application.
`void`	`setExternalId(String externalId)` The external ID.
`void`	`setRoleArn(String roleArn)` The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
`void`	`setUserDataShared(Boolean userDataShared)` If `UserDataShared` is `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
`String`	`toString()` Returns a string representation of this object.
`AnalyticsConfigurationType`	`withApplicationId(String applicationId)` The application ID for an Amazon Pinpoint application.
`AnalyticsConfigurationType`	`withExternalId(String externalId)` The external ID.
`AnalyticsConfigurationType`	`withRoleArn(String roleArn)` The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
`AnalyticsConfigurationType`	`withUserDataShared(Boolean userDataShared)` If `UserDataShared` is `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AnalyticsConfigurationType
```
public AnalyticsConfigurationType()
```
- Method Detail
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
    The application ID for an Amazon Pinpoint application.
    
    Parameters:
    
    applicationId - The application ID for an Amazon Pinpoint application.
  - getApplicationId
```
public String getApplicationId()
```
    The application ID for an Amazon Pinpoint application.
    
    Returns:
    
    The application ID for an Amazon Pinpoint application.
  - withApplicationId
```
public AnalyticsConfigurationType withApplicationId(String applicationId)
```
    The application ID for an Amazon Pinpoint application.
    
    Parameters:
    
    applicationId - The application ID for an Amazon Pinpoint application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
    
    Parameters:
    
    roleArn - The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
  - getRoleArn
```
public String getRoleArn()
```
    The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
    
    Returns:
    
    The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
  - withRoleArn
```
public AnalyticsConfigurationType withRoleArn(String roleArn)
```
    The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
    
    Parameters:
    
    roleArn - The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExternalId
```
public void setExternalId(String externalId)
```
    The external ID.
    
    Parameters:
    
    externalId - The external ID.
  - getExternalId
```
public String getExternalId()
```
    The external ID.
    
    Returns:
    
    The external ID.
  - withExternalId
```
public AnalyticsConfigurationType withExternalId(String externalId)
```
    The external ID.
    
    Parameters:
    
    externalId - The external ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserDataShared
```
public void setUserDataShared(Boolean userDataShared)
```
    If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
    
    Parameters:
    
    userDataShared - If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
  - getUserDataShared
```
public Boolean getUserDataShared()
```
    If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
    
    Returns:
    
    If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
  - withUserDataShared
```
public AnalyticsConfigurationType withUserDataShared(Boolean userDataShared)
```
    If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
    
    Parameters:
    
    userDataShared - If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUserDataShared
```
public Boolean isUserDataShared()
```
    If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
    
    Returns:
    
    If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AnalyticsConfigurationType clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AnalyticsConfigurationType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalyticsConfigurationType

Method Detail

setApplicationId

getApplicationId

withApplicationId

setRoleArn

getRoleArn

withRoleArn

setExternalId

getExternalId

withExternalId

setUserDataShared

getUserDataShared

withUserDataShared

isUserDataShared

toString

equals

hashCode

clone

marshall