aws-cdk-lib.aws_cognito.UserPoolIdentityProviderProps

UserPoolIdentityProviderProps Struct

Properties to create a new instance of UserPoolIdentityProvider.

Source

aws-cognito/lib/user-pool-idps/base.ts

Example

// 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 userPoolIdentityProviderProps: cognito.UserPoolIdentityProviderProps = {
  userPool: userPool,

  // the properties below are optional
  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,
  },
};

Properties

attributeMappingAttributeMappingattribute_mappingAttributeMappingattributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMapping= no attribute mapping#

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

userPoolIUserPooluser_poolIUserPooluserPoolIUserPoolUserPoolIUserPoolUserPoolIUserPoolrequired#

The user pool to which this construct provides identities.