Interface UserPoolIdentityProviderFacebookProps
- All Superinterfaces:
- software.amazon.jsii.JsiiSerializable,- UserPoolIdentityProviderProps
- All Known Implementing Classes:
- UserPoolIdentityProviderFacebookProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:34.125Z")
@Stability(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)
                 .emailVerified(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 SummaryNested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forUserPoolIdentityProviderFacebookPropsstatic final classAn implementation forUserPoolIdentityProviderFacebookProps
- 
Method SummaryModifier and TypeMethodDescriptionbuilder()default StringThe Facebook API version to use.The client id recognized by Facebook APIs.The client secret to be accompanied with clientId for Facebook to authenticate the client.The list of Facebook permissions to obtain for getting access to the Facebook profile.Methods inherited from interface software.amazon.jsii.JsiiSerializable$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.cognito.UserPoolIdentityProviderPropsgetAttributeMapping, getUserPool
- 
Method Details- 
getClientIdThe client id recognized by Facebook APIs.
- 
getClientSecretThe client secret to be accompanied with clientId for Facebook to authenticate the client.- See Also:
 
- 
getApiVersionThe Facebook API version to use.Default: - to the oldest version supported by Facebook 
- 
getScopesThe list of Facebook permissions to obtain for getting access to the Facebook profile.Default: [ public_profile ] - See Also:
 
- 
builder
 
-