Package software.amazon.awscdk.services.cognito

Class AnalyticsConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.AnalyticsConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AnalyticsConfiguration>

Enclosing interface:

AnalyticsConfiguration

@Stability(Stable)
public static final class AnalyticsConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<AnalyticsConfiguration>

A builder for AnalyticsConfiguration

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AnalyticsConfiguration.Builder	application(CfnApp application)	Sets the value of AnalyticsConfiguration.getApplication()
AnalyticsConfiguration.Builder	applicationId(String applicationId)	Sets the value of AnalyticsConfiguration.getApplicationId()
AnalyticsConfiguration	build()	Builds the configured instance.
AnalyticsConfiguration.Builder	externalId(String externalId)	Sets the value of AnalyticsConfiguration.getExternalId()
AnalyticsConfiguration.Builder	role(IRole role)	Sets the value of AnalyticsConfiguration.getRole()
AnalyticsConfiguration.Builder	shareUserData(Boolean shareUserData)	Sets the value of AnalyticsConfiguration.getShareUserData()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

application

@Stability(Stable)
public AnalyticsConfiguration.Builder application(CfnApp application)

Sets the value of AnalyticsConfiguration.getApplication()

Parameters:

application - The Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project. 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:

this

applicationId

@Stability(Stable)
public AnalyticsConfiguration.Builder applicationId(String applicationId)

Sets the value of AnalyticsConfiguration.getApplicationId()

Parameters:

applicationId - Your Amazon Pinpoint project ID.

Returns:

this

externalId

@Stability(Stable)
public AnalyticsConfiguration.Builder externalId(String externalId)

Sets the value of AnalyticsConfiguration.getExternalId()

Parameters:

externalId - The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint. More info here: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

Returns:

this

role

@Stability(Stable)
public AnalyticsConfiguration.Builder role(IRole role)

Sets the value of AnalyticsConfiguration.getRole()

Parameters:

role - The IAM role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.

Returns:

this

shareUserData

@Stability(Stable)
public AnalyticsConfiguration.Builder shareUserData(Boolean shareUserData)

Sets the value of AnalyticsConfiguration.getShareUserData()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public AnalyticsConfiguration build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AnalyticsConfiguration>

Returns:

a new instance of AnalyticsConfiguration

Throws:

NullPointerException - if any required attribute was not provided