Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderFacebook.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderFacebook.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolIdentityProviderFacebook>

Enclosing class:

UserPoolIdentityProviderFacebook

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

A fluent builder for UserPoolIdentityProviderFacebook.

Method Summary

Modifier and Type	Method	Description
UserPoolIdentityProviderFacebook.Builder	apiVersion(String apiVersion)	The Facebook API version to use.
UserPoolIdentityProviderFacebook.Builder	attributeMapping(AttributeMapping attributeMapping)	Mapping attributes from the identity provider to standard and custom attributes of the user pool.
UserPoolIdentityProviderFacebook	build()
UserPoolIdentityProviderFacebook.Builder	clientId(String clientId)	The client id recognized by Facebook APIs.
UserPoolIdentityProviderFacebook.Builder	clientSecret(String clientSecret)	The client secret to be accompanied with clientId for Facebook to authenticate the client.
static UserPoolIdentityProviderFacebook.Builder	create(software.constructs.Construct scope, String id)
UserPoolIdentityProviderFacebook.Builder	scopes(List<String> scopes)	The list of Facebook permissions to obtain for getting access to the Facebook profile.
UserPoolIdentityProviderFacebook.Builder	userPool(IUserPool userPool)	The user pool to which this construct provides identities.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static UserPoolIdentityProviderFacebook.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of UserPoolIdentityProviderFacebook.Builder.

userPool

@Stability(Stable)
public UserPoolIdentityProviderFacebook.Builder userPool(IUserPool userPool)

The user pool to which this construct provides identities.

Parameters:

userPool - The user pool to which this construct provides identities. This parameter is required.

Returns:

this

attributeMapping

@Stability(Stable)
public UserPoolIdentityProviderFacebook.Builder attributeMapping(AttributeMapping attributeMapping)

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

Default: - no attribute mapping

Parameters:

attributeMapping - Mapping attributes from the identity provider to standard and custom attributes of the user pool. This parameter is required.

Returns:

this

clientId

@Stability(Stable)
public UserPoolIdentityProviderFacebook.Builder clientId(String clientId)

The client id recognized by Facebook APIs.

Parameters:

clientId - The client id recognized by Facebook APIs. This parameter is required.

Returns:

this

clientSecret

@Stability(Stable)
public UserPoolIdentityProviderFacebook.Builder clientSecret(String clientSecret)

The client secret to be accompanied with clientId for Facebook to authenticate the client.

Parameters:

clientSecret - The client secret to be accompanied with clientId for Facebook to authenticate the client. This parameter is required.

Returns:

this

See Also:

• https://developers.facebook.com/docs/facebook-login/security#appsecret

apiVersion

@Stability(Stable)
public UserPoolIdentityProviderFacebook.Builder apiVersion(String apiVersion)

The Facebook API version to use.

Default: - to the oldest version supported by Facebook

Parameters:

apiVersion - The Facebook API version to use. This parameter is required.

Returns:

this

scopes

@Stability(Stable)
public UserPoolIdentityProviderFacebook.Builder scopes(List<String> scopes)

The list of Facebook permissions to obtain for getting access to the Facebook profile.

Default: [ public_profile ]

Parameters:

scopes - The list of Facebook permissions to obtain for getting access to the Facebook profile. This parameter is required.

Returns:

this

See Also:

• https://developers.facebook.com/docs/facebook-login/permissions

build

@Stability(Stable)
public UserPoolIdentityProviderFacebook build()

Specified by:

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

Returns:

a newly built instance of UserPoolIdentityProviderFacebook.