software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderFacebook

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderFacebook

All Implemented Interfaces:

IResource, IUserPoolIdentityProvider, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.690Z")
 @Stability(value=Stable)
public class UserPoolIdentityProviderFacebook
extends Resource
implements IUserPoolIdentityProvider

Represents a identity provider that integrates with 'Facebook Login'.

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;
 UserPoolIdentityProviderFacebook userPoolIdentityProviderFacebook = UserPoolIdentityProviderFacebook.Builder.create(this, "MyUserPoolIdentityProviderFacebook")
         .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	Class and Description
static class	UserPoolIdentityProviderFacebook.Builder A fluent builder for UserPoolIdentityProviderFacebook.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.IUserPoolIdentityProvider

IUserPoolIdentityProvider.Jsii$Default, IUserPoolIdentityProvider.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	UserPoolIdentityProviderFacebook(software.constructs.Construct scope, String id, UserPoolIdentityProviderFacebookProps props)
protected	UserPoolIdentityProviderFacebook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolIdentityProviderFacebook(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Object	configureAttributeMapping()
String	getProviderName() The primary identifier of this identity provider.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

UserPoolIdentityProviderFacebook

protected UserPoolIdentityProviderFacebook(software.amazon.jsii.JsiiObjectRef objRef)

UserPoolIdentityProviderFacebook

protected UserPoolIdentityProviderFacebook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

UserPoolIdentityProviderFacebook

@Stability(value=Stable)
public UserPoolIdentityProviderFacebook(@NotNull
                                                                 software.constructs.Construct scope,
                                                                 @NotNull
                                                                 String id,
                                                                 @NotNull
                                                                 UserPoolIdentityProviderFacebookProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

configureAttributeMapping

@Stability(value=Stable)
 @NotNull
protected Object configureAttributeMapping()

getProviderName

@Stability(value=Stable)
 @NotNull
public String getProviderName()

The primary identifier of this identity provider.

Specified by:

getProviderName in interface IUserPoolIdentityProvider