Interface IAttributeMapping

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

The mapping of user pool attributes to the attributes provided by the identity providers.

public interface IAttributeMapping

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 }
                    }
                }
            });

Remarks

ExampleMetadata: infused

Properties

Address

The user's postal address is a required attribute.

ProviderAttribute? Address { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

Birthdate

The user's birthday.

ProviderAttribute? Birthdate { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

Custom

Specify custom attribute mapping here and mapping for any standard attributes not supported yet.

IDictionary<string, ProviderAttribute>? Custom { get; }

Property Value

IDictionary<string, ProviderAttribute>

Remarks

Default: - no custom attribute mapping

Email

The user's e-mail address.

ProviderAttribute? Email { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

FamilyName

The surname or last name of user.

ProviderAttribute? FamilyName { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

Fullname

The user's full name in displayable form.

ProviderAttribute? Fullname { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

Gender

The user's gender.

ProviderAttribute? Gender { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

GivenName

The user's first name or give name.

ProviderAttribute? GivenName { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

LastUpdateTime

Time, the user's information was last updated.

ProviderAttribute? LastUpdateTime { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

Locale

The user's locale.

ProviderAttribute? Locale { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

MiddleName

The user's middle name.

ProviderAttribute? MiddleName { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

Nickname

The user's nickname or casual name.

ProviderAttribute? Nickname { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

PhoneNumber

The user's telephone number.

ProviderAttribute? PhoneNumber { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

PreferredUsername

The user's preferred username.

ProviderAttribute? PreferredUsername { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

ProfilePage

The URL to the user's profile page.

ProviderAttribute? ProfilePage { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

ProfilePicture

The URL to the user's profile picture.

ProviderAttribute? ProfilePicture { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

Timezone

The user's time zone.

ProviderAttribute? Timezone { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped

Website

The URL to the user's web page or blog.

ProviderAttribute? Website { get; }

Property Value

ProviderAttribute

Remarks

Default: - not mapped