software.amazon.awscdk.services.cognito

Interface UserPoolIdentityProviderFacebookProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps

All Known Implementing Classes:

UserPoolIdentityProviderFacebookProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.641Z")
 @Stability(value=Stable)
public interface UserPoolIdentityProviderFacebookProps
extends software.amazon.jsii.JsiiSerializable, 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 String	getApiVersion() The Facebook API version to use.
String	getClientId() The client id recognized by Facebook APIs.
String	getClientSecret() The client secret to be accompanied with clientUd for Facebook to authenticate the client.
default List<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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClientId

@Stability(value=Stable)
 @NotNull
String getClientId()

The client id recognized by Facebook APIs.

getClientSecret

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @Nullable
default String getApiVersion()

The Facebook API version to use.

Default: - to the oldest version supported by Facebook

getScopes

@Stability(value=Stable)
 @Nullable
default List<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

@Stability(value=Stable)
static UserPoolIdentityProviderFacebookProps.Builder builder()

Specified by:

builder in interface UserPoolIdentityProviderProps

Returns:

a UserPoolIdentityProviderFacebookProps.Builder of UserPoolIdentityProviderFacebookProps