software.amazon.awscdk.services.cognito

Interface UserPoolIdentityProviderFacebookProps

All Superinterfaces:

UserPoolIdentityProviderProps

All Known Implementing Classes:

UserPoolIdentityProviderFacebookProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:58.909Z")
public interface UserPoolIdentityProviderFacebookProps
extends UserPoolIdentityProviderProps

Properties to initialize UserPoolFacebookIdentityProvider.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 ProviderAttribute providerAttribute;
 UserPool userPool;
 UserPoolIdentityProviderFacebookProps userPoolIdentityProviderFacebookProps = UserPoolIdentityProviderFacebookProps.builder()
         .clientId("clientId")
         .clientSecret("clientSecret")
         .userPool(userPool)
         // the properties below are optional
         .apiVersion("apiVersion")
         .attributeMapping(AttributeMapping.builder()
                 .address(providerAttribute)
                 .birthdate(providerAttribute)
                 .custom(Map.of(
                         "customKey", providerAttribute))
                 .email(providerAttribute)
                 .familyName(providerAttribute)
                 .fullname(providerAttribute)
                 .gender(providerAttribute)
                 .givenName(providerAttribute)
                 .lastUpdateTime(providerAttribute)
                 .locale(providerAttribute)
                 .middleName(providerAttribute)
                 .nickname(providerAttribute)
                 .phoneNumber(providerAttribute)
                 .preferredUsername(providerAttribute)
                 .profilePage(providerAttribute)
                 .profilePicture(providerAttribute)
                 .timezone(providerAttribute)
                 .website(providerAttribute)
                 .build())
         .scopes(List.of("scopes"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserPoolIdentityProviderFacebookProps.Builder A builder for UserPoolIdentityProviderFacebookProps
static class	UserPoolIdentityProviderFacebookProps.Jsii$Proxy An implementation for UserPoolIdentityProviderFacebookProps

Method Summary

Modifier and Type	Method and Description
static UserPoolIdentityProviderFacebookProps.Builder	builder()
default java.lang.String	getApiVersion() The Facebook API version to use.
java.lang.String	getClientId() The client id recognized by Facebook APIs.
java.lang.String	getClientSecret() The client secret to be accompanied with clientUd for Facebook to authenticate the client.
default java.util.List<java.lang.String>	getScopes() The list of facebook permissions to obtain for getting access to the Facebook profile.

Methods inherited from interface software.amazon.awscdk.services.cognito.UserPoolIdentityProviderProps

getAttributeMapping, getUserPool

Method Detail

getClientId

java.lang.String getClientId()

The client id recognized by Facebook APIs.

getClientSecret

java.lang.String getClientSecret()

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

See Also:

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

getApiVersion

default java.lang.String getApiVersion()

The Facebook API version to use.

Default: - to the oldest version supported by Facebook

getScopes

default java.util.List<java.lang.String> getScopes()

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

Default: [ public_profile ]

See Also:

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

builder

static UserPoolIdentityProviderFacebookProps.Builder builder()

Specified by:

builder in interface UserPoolIdentityProviderProps

Returns:

a UserPoolIdentityProviderFacebookProps.Builder of UserPoolIdentityProviderFacebookProps