Class StandardAttributesMask
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
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class StandardAttributesMask : Object, IStandardAttributesMask
Syntax (vb)
Public Class StandardAttributesMask
Inherits Object
Implements IStandardAttributesMask
Remarks
ExampleMetadata: infused
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
});
Synopsis
Constructors
StandardAttributesMask() |
Properties
Address | The user's postal address. |
Birthdate | The user's birthday, represented as an ISO 8601:2004 format. |
The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec. |
|
EmailVerified | Whether the email address has been verified. |
FamilyName | The surname or last name of the user. |
Fullname | The user's full name in displayable form, including all name parts, titles and suffixes. |
Gender | The user's gender. |
GivenName | The user's first name or give name. |
LastUpdateTime | The time, the user's information was last updated. |
Locale | The user's locale, represented as a BCP47 [RFC5646] language tag. |
MiddleName | The user's middle name. |
Nickname | The user's nickname or casual name. |
PhoneNumber | The user's telephone number. |
PhoneNumberVerified | Whether the phone number has been verified. |
PreferredUsername | The user's preffered username, different from the immutable user name. |
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
StandardAttributesMask()
public StandardAttributesMask()
Properties
Address
The user's postal address.
public Nullable<bool> Address { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Birthdate
The user's birthday, represented as an ISO 8601:2004 format.
public Nullable<bool> Birthdate { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.
public Nullable<bool> Email { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
EmailVerified
Whether the email address has been verified.
public Nullable<bool> EmailVerified { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
FamilyName
The surname or last name of the user.
public Nullable<bool> FamilyName { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Fullname
The user's full name in displayable form, including all name parts, titles and suffixes.
public Nullable<bool> Fullname { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Gender
The user's gender.
public Nullable<bool> Gender { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
GivenName
The user's first name or give name.
public Nullable<bool> GivenName { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
LastUpdateTime
The time, the user's information was last updated.
public Nullable<bool> LastUpdateTime { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Locale
The user's locale, represented as a BCP47 [RFC5646] language tag.
public Nullable<bool> Locale { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
MiddleName
The user's middle name.
public Nullable<bool> MiddleName { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Nickname
The user's nickname or casual name.
public Nullable<bool> Nickname { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
PhoneNumber
The user's telephone number.
public Nullable<bool> PhoneNumber { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
PhoneNumberVerified
Whether the phone number has been verified.
public Nullable<bool> PhoneNumberVerified { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
PreferredUsername
The user's preffered username, different from the immutable user name.
public Nullable<bool> PreferredUsername { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
ProfilePage
The URL to the user's profile page.
public Nullable<bool> ProfilePage { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
ProfilePicture
The URL to the user's profile picture.
public Nullable<bool> ProfilePicture { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Timezone
The user's time zone.
public Nullable<bool> Timezone { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Website
The URL to the user's web page or blog.
public Nullable<bool> Website { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false