aws-cdk-lib.aws_cognito.UserPoolIdentityProviderProps

interface UserPoolIdentityProviderProps

LanguageType name
.NETAmazon.CDK.AWS.Cognito.UserPoolIdentityProviderProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolIdentityProviderProps
Javasoftware.amazon.awscdk.services.cognito.UserPoolIdentityProviderProps
Pythonaws_cdk.aws_cognito.UserPoolIdentityProviderProps
TypeScript (source)aws-cdk-lib » aws_cognito » UserPoolIdentityProviderProps

Properties to create a new instance of UserPoolIdentityProvider.

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,
    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

NameTypeDescription
userPoolIUserPoolThe user pool to which this construct provides identities.
attributeMapping?AttributeMappingMapping attributes from the identity provider to standard and custom attributes of the user pool.

userPool

Type: IUserPool

The user pool to which this construct provides identities.


attributeMapping?

Type: AttributeMapping (optional, default: no attribute mapping)

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