software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderFacebook.Builder

java.lang.Object

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

Enclosing class:

UserPoolIdentityProviderFacebook

public static final class UserPoolIdentityProviderFacebook.Builder
extends java.lang.Object

A fluent builder for UserPoolIdentityProviderFacebook.

Method Summary

Modifier and Type	Method and Description
UserPoolIdentityProviderFacebook.Builder	apiVersion(java.lang.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(java.lang.String clientId) The client id recognized by Facebook APIs.
UserPoolIdentityProviderFacebook.Builder	clientSecret(java.lang.String clientSecret) The client secret to be accompanied with clientUd for Facebook to authenticate the client.
static UserPoolIdentityProviderFacebook.Builder	create(software.constructs.Construct scope, java.lang.String id)
UserPoolIdentityProviderFacebook.Builder	scopes(java.util.List<java.lang.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 Detail

create

public static UserPoolIdentityProviderFacebook.Builder create(software.constructs.Construct scope,
                                                              java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of UserPoolIdentityProviderFacebook.Builder.

userPool

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

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

public UserPoolIdentityProviderFacebook.Builder clientId(java.lang.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

public UserPoolIdentityProviderFacebook.Builder clientSecret(java.lang.String clientSecret)

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

Parameters:

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

Returns:

this

See Also:

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

apiVersion

public UserPoolIdentityProviderFacebook.Builder apiVersion(java.lang.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

public UserPoolIdentityProviderFacebook.Builder scopes(java.util.List<java.lang.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

public UserPoolIdentityProviderFacebook build()