interface UserPoolIdentityProviderProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Cognito.UserPoolIdentityProviderProps |
![]() | software.amazon.awscdk.services.cognito.UserPoolIdentityProviderProps |
![]() | aws_cdk.aws_cognito.UserPoolIdentityProviderProps |
![]() | @aws-cdk/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 * as cognito from '@aws-cdk/aws-cognito';
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
Name | Type | Description |
---|---|---|
user | IUser | The user pool to which this construct provides identities. |
attribute | Attribute | Mapping attributes from the identity provider to standard and custom attributes of the user pool. |
userPool
Type:
IUser
The user pool to which this construct provides identities.
attributeMapping?
Type:
Attribute
(optional, default: no attribute mapping)
Mapping attributes from the identity provider to standard and custom attributes of the user pool.