Class AttributeMapping
The mapping of user pool attributes to the attributes provided by the identity providers.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class AttributeMapping : Object, IAttributeMappingSyntax (vb)
Public Class AttributeMapping
Inherits Object
Implements IAttributeMappingRemarks
ExampleMetadata: infused
Examples
var userpool = new UserPool(this, "Pool");
new UserPoolIdentityProviderAmazon(this, "Amazon", new UserPoolIdentityProviderAmazonProps {
ClientId = "amzn-client-id",
ClientSecret = "amzn-client-secret",
UserPool = userpool,
AttributeMapping = new AttributeMapping {
Email = ProviderAttribute.AMAZON_EMAIL,
Website = ProviderAttribute.Other("url"), // use other() when an attribute is not pre-defined in the CDK
Custom = new Dictionary<string, ProviderAttribute> {
// custom user pool attributes go here
{ "uniqueId", ProviderAttribute.AMAZON_USER_ID }
}
}
});Synopsis
Constructors
| AttributeMapping() |
Properties
| Address | The user's postal address is a required attribute. |
| Birthdate | The user's birthday. |
| Custom | Specify custom attribute mapping here and mapping for any standard attributes not supported yet. |
The user's e-mail address. |
|
| FamilyName | The surname or last name of user. |
| Fullname | The user's full name in displayable form. |
| Gender | The user's gender. |
| GivenName | The user's first name or give name. |
| LastUpdateTime | Time, the user's information was last updated. |
| Locale | The user's locale. |
| MiddleName | The user's middle name. |
| Nickname | The user's nickname or casual name. |
| PhoneNumber | The user's telephone number. |
| PreferredUsername | The user's preferred username. |
| ProfilePage | The URL to the user's profile page. |
| ProfilePicture | The URL to the user's profile picture. |
| Timezone | The user's time zone. |
| Website | The URL to the user's web page or blog. |
Constructors
AttributeMapping()
public AttributeMapping()Properties
Address
The user's postal address is a required attribute.
public ProviderAttribute Address { get; set; }Property Value
Remarks
Default: - not mapped
Birthdate
The user's birthday.
public ProviderAttribute Birthdate { get; set; }Property Value
Remarks
Default: - not mapped
Custom
Specify custom attribute mapping here and mapping for any standard attributes not supported yet.
public IDictionary<string, ProviderAttribute> Custom { get; set; }Property Value
System.Collections.Generic.IDictionary<System.String, ProviderAttribute>
Remarks
Default: - no custom attribute mapping
The user's e-mail address.
public ProviderAttribute Email { get; set; }Property Value
Remarks
Default: - not mapped
FamilyName
The surname or last name of user.
public ProviderAttribute FamilyName { get; set; }Property Value
Remarks
Default: - not mapped
Fullname
The user's full name in displayable form.
public ProviderAttribute Fullname { get; set; }Property Value
Remarks
Default: - not mapped
Gender
The user's gender.
public ProviderAttribute Gender { get; set; }Property Value
Remarks
Default: - not mapped
GivenName
The user's first name or give name.
public ProviderAttribute GivenName { get; set; }Property Value
Remarks
Default: - not mapped
LastUpdateTime
Time, the user's information was last updated.
public ProviderAttribute LastUpdateTime { get; set; }Property Value
Remarks
Default: - not mapped
Locale
The user's locale.
public ProviderAttribute Locale { get; set; }Property Value
Remarks
Default: - not mapped
MiddleName
The user's middle name.
public ProviderAttribute MiddleName { get; set; }Property Value
Remarks
Default: - not mapped
Nickname
The user's nickname or casual name.
public ProviderAttribute Nickname { get; set; }Property Value
Remarks
Default: - not mapped
PhoneNumber
The user's telephone number.
public ProviderAttribute PhoneNumber { get; set; }Property Value
Remarks
Default: - not mapped
PreferredUsername
The user's preferred username.
public ProviderAttribute PreferredUsername { get; set; }Property Value
Remarks
Default: - not mapped
ProfilePage
The URL to the user's profile page.
public ProviderAttribute ProfilePage { get; set; }Property Value
Remarks
Default: - not mapped
ProfilePicture
The URL to the user's profile picture.
public ProviderAttribute ProfilePicture { get; set; }Property Value
Remarks
Default: - not mapped
Timezone
The user's time zone.
public ProviderAttribute Timezone { get; set; }Property Value
Remarks
Default: - not mapped
Website
The URL to the user's web page or blog.
public ProviderAttribute Website { get; set; }Property Value
Remarks
Default: - not mapped