Skip to content
v2.278.0

UserPoolIdentityProviderFacebookProps Struct ​

Properties to initialize UserPoolFacebookIdentityProvider.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';

declare const providerAttribute: cognito.ProviderAttribute;
declare const userPool: cognito.UserPool;
const userPoolIdentityProviderFacebookProps: cognito.UserPoolIdentityProviderFacebookProps = {
  clientId: 'clientId',
  clientSecret: 'clientSecret',
  userPool: userPool,

  // the properties below are optional
  apiVersion: 'apiVersion',
  attributeMapping: {
    address: providerAttribute,
    birthdate: providerAttribute,
    custom: {
      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,
  },
  scopes: ['scopes'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

# provider_attribute: cognito.ProviderAttribute
# user_pool: cognito.UserPool

user_pool_identity_provider_facebook_props = cognito.UserPoolIdentityProviderFacebookProps(
    client_id="clientId",
    client_secret="clientSecret",
    user_pool=user_pool,

    # the properties below are optional
    api_version="apiVersion",
    attribute_mapping=cognito.AttributeMapping(
        address=provider_attribute,
        birthdate=provider_attribute,
        custom={
            "custom_key": provider_attribute
        },
        email=provider_attribute,
        email_verified=provider_attribute,
        family_name=provider_attribute,
        fullname=provider_attribute,
        gender=provider_attribute,
        given_name=provider_attribute,
        last_update_time=provider_attribute,
        locale=provider_attribute,
        middle_name=provider_attribute,
        nickname=provider_attribute,
        phone_number=provider_attribute,
        preferred_username=provider_attribute,
        profile_page=provider_attribute,
        profile_picture=provider_attribute,
        timezone=provider_attribute,
        website=provider_attribute
    ),
    scopes=["scopes"]
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;

ProviderAttribute providerAttribute;
UserPool userPool;

var userPoolIdentityProviderFacebookProps = new UserPoolIdentityProviderFacebookProps {
    ClientId = "clientId",
    ClientSecret = "clientSecret",
    UserPool = userPool,

    // the properties below are optional
    ApiVersion = "apiVersion",
    AttributeMapping = new AttributeMapping {
        Address = providerAttribute,
        Birthdate = providerAttribute,
        Custom = new Dictionary<string, ProviderAttribute> {
            { "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
    },
    Scopes = new [] { "scopes" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var providerAttribute ProviderAttribute
var userPool UserPool

userPoolIdentityProviderFacebookProps := &UserPoolIdentityProviderFacebookProps{
	ClientId: jsii.String("clientId"),
	ClientSecret: jsii.String("clientSecret"),
	UserPool: userPool,

	// the properties below are optional
	ApiVersion: jsii.String("apiVersion"),
	AttributeMapping: &AttributeMapping{
		Address: providerAttribute,
		Birthdate: providerAttribute,
		Custom: map[string]ProviderAttribute{
			"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,
	},
	Scopes: []*string{
		jsii.String("scopes"),
	},
}

Properties ​

apiVersionoptionalstringapi_versionoptionalstrapiVersionoptionalStringApiVersionoptionalstringApiVersionoptional*string #
The Facebook API version to use.

Default: to the oldest version supported by Facebook

attributeMappingoptionalAttributeMappingattribute_mappingoptionalAttributeMappingattributeMappingoptionalAttributeMappingAttributeMappingoptionalAttributeMappingAttributeMappingoptionalAttributeMapping #
Mapping attributes from the identity provider to standard and custom attributes of the user pool.

Default: no attribute mapping

clientIdstringclient_idstrclientIdStringClientIdstringClientId*string required #
The client id recognized by Facebook APIs.
clientSecretstringclient_secretstrclientSecretStringClientSecretstringClientSecret*string required #
The client secret to be accompanied with clientId for Facebook to authenticate the client.
scopesoptionalstring[]scopesoptionaltyping.List[str]scopesoptionalList<String>Scopesoptionalstring[]Scopesoptional*[]*string #
The list of Facebook permissions to obtain for getting access to the Facebook profile.

Default: [ public_profile ]

userPoolIUserPooluser_poolIUserPooluserPoolIUserPoolUserPoolIUserPoolUserPoolIUserPool required #
The user pool to which this construct provides identities.