com.amazonaws.services.cognitoidentityprovider.model

Class AnalyticsConfigurationType

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.AnalyticsConfigurationType

All Implemented Interfaces:

Serializable

public class AnalyticsConfigurationType
extends Object
implements Serializable

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AnalyticsConfigurationType()

Method Summary

Modifier and Type	Method and Description
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	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; useful for testing and debugging.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AnalyticsConfigurationType

public AnalyticsConfigurationType()

Method Detail

getApplicationId

public String getApplicationId()

The application ID for an Amazon Pinpoint application.

Constraints:
Pattern: ^[0-9a-fA-F]+$

Returns:

The application ID for an Amazon Pinpoint application.

setApplicationId

public void setApplicationId(String applicationId)

The application ID for an Amazon Pinpoint application.

Constraints:
Pattern: ^[0-9a-fA-F]+$

Parameters:

applicationId -

The application ID for an Amazon Pinpoint application.

withApplicationId

public AnalyticsConfigurationType withApplicationId(String applicationId)

The application ID for an Amazon Pinpoint application.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: ^[0-9a-fA-F]+$

Parameters:

applicationId -

The application ID for an Amazon Pinpoint application.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleArn

public String getRoleArn()

The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Returns:

The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

setRoleArn

public void setRoleArn(String roleArn)

The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Parameters:

roleArn -

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Parameters:

roleArn -

The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

Returns:

A reference to this updated object so that method calls can be chained together.

getExternalId

public String getExternalId()

The external ID.

Returns:

The external ID.

setExternalId

public void setExternalId(String externalId)

The external ID.

Parameters:

externalId -

The external ID.

withExternalId

public AnalyticsConfigurationType withExternalId(String externalId)

The external ID.

Returns a reference to this object so that method calls can be chained together.

Parameters:

externalId -

The external ID.

Returns:

A reference to this updated 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.

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.

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.

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

userDataShared -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object