Table of Contents

Class StandardAttributesMask

Namespace
Amazon.CDK.AWS.Cognito
Assembly
Amazon.CDK.AWS.Cognito.dll

This interface contains standard attributes recognized by Cognito from https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html including built-in attributes email_verified and phone_number_verified.

public class StandardAttributesMask : IStandardAttributesMask
Inheritance
StandardAttributesMask
Implements
Inherited Members

Examples

var pool = new UserPool(this, "Pool");

            var clientWriteAttributes = (new ClientAttributes()).WithStandardAttributes(new StandardAttributesMask { Fullname = true, Email = true }).WithCustomAttributes("favouritePizza", "favouriteBeverage");

            var clientReadAttributes = clientWriteAttributes.WithStandardAttributes(new StandardAttributesMask { EmailVerified = true }).WithCustomAttributes("pointsEarned");

            pool.AddClient("app-client", new UserPoolClientOptions {
                // ...
                ReadAttributes = clientReadAttributes,
                WriteAttributes = clientWriteAttributes
            });

Remarks

ExampleMetadata: infused

Constructors

StandardAttributesMask() 

public StandardAttributesMask()

Properties

Address

The user's postal address.

public bool? Address { get; set; }

Property Value

bool?

Remarks

Default: false

Birthdate

The user's birthday, represented as an ISO 8601:2004 format.

public bool? Birthdate { get; set; }

Property Value

bool?

Remarks

Default: false

Email

The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.

public bool? Email { get; set; }

Property Value

bool?

Remarks

Default: false

EmailVerified

Whether the email address has been verified.

public bool? EmailVerified { get; set; }

Property Value

bool?

Remarks

Default: false

FamilyName

The surname or last name of the user.

public bool? FamilyName { get; set; }

Property Value

bool?

Remarks

Default: false

Fullname

The user's full name in displayable form, including all name parts, titles and suffixes.

public bool? Fullname { get; set; }

Property Value

bool?

Remarks

Default: false

Gender

The user's gender.

public bool? Gender { get; set; }

Property Value

bool?

Remarks

Default: false

GivenName

The user's first name or give name.

public bool? GivenName { get; set; }

Property Value

bool?

Remarks

Default: false

LastUpdateTime

The time, the user's information was last updated.

public bool? LastUpdateTime { get; set; }

Property Value

bool?

Remarks

Default: false

Locale

The user's locale, represented as a BCP47 [RFC5646] language tag.

public bool? Locale { get; set; }

Property Value

bool?

Remarks

Default: false

MiddleName

The user's middle name.

public bool? MiddleName { get; set; }

Property Value

bool?

Remarks

Default: false

Nickname

The user's nickname or casual name.

public bool? Nickname { get; set; }

Property Value

bool?

Remarks

Default: false

PhoneNumber

The user's telephone number.

public bool? PhoneNumber { get; set; }

Property Value

bool?

Remarks

Default: false

PhoneNumberVerified

Whether the phone number has been verified.

public bool? PhoneNumberVerified { get; set; }

Property Value

bool?

Remarks

Default: false

PreferredUsername

The user's preffered username, different from the immutable user name.

public bool? PreferredUsername { get; set; }

Property Value

bool?

Remarks

Default: false

ProfilePage

The URL to the user's profile page.

public bool? ProfilePage { get; set; }

Property Value

bool?

Remarks

Default: false

ProfilePicture

The URL to the user's profile picture.

public bool? ProfilePicture { get; set; }

Property Value

bool?

Remarks

Default: false

Timezone

The user's time zone.

public bool? Timezone { get; set; }

Property Value

bool?

Remarks

Default: false

Website

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

public bool? Website { get; set; }

Property Value

bool?

Remarks

Default: false