Interface IStandardAttributes
The set of standard attributes that can be marked as required or mutable.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IStandardAttributes
Syntax (vb)
Public Interface IStandardAttributes
Remarks
ExampleMetadata: infused
Examples
new UserPool(this, "myuserpool", new UserPoolProps {
// ...
StandardAttributes = new StandardAttributes {
Fullname = new StandardAttribute {
Required = true,
Mutable = false
},
Address = new StandardAttribute {
Required = false,
Mutable = true
}
},
CustomAttributes = new Dictionary<string, ICustomAttribute> {
{ "myappid", new StringAttribute(new StringAttributeProps { MinLen = 5, MaxLen = 15, Mutable = false }) },
{ "callingcode", new NumberAttribute(new NumberAttributeProps { Min = 1, Max = 3, Mutable = true }) },
{ "isEmployee", new BooleanAttribute(new CustomAttributeProps { Mutable = true }) },
{ "joinedOn", new DateTimeAttribute() }
}
});
Synopsis
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. |
|
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. |
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. |
Properties
Address
The user's postal address.
virtual IStandardAttribute Address { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
Birthdate
The user's birthday, represented as an ISO 8601:2004 format.
virtual IStandardAttribute Birthdate { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.
virtual IStandardAttribute Email { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
FamilyName
The surname or last name of the user.
virtual IStandardAttribute FamilyName { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
Fullname
The user's full name in displayable form, including all name parts, titles and suffixes.
virtual IStandardAttribute Fullname { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
Gender
The user's gender.
virtual IStandardAttribute Gender { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
GivenName
The user's first name or give name.
virtual IStandardAttribute GivenName { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
LastUpdateTime
The time, the user's information was last updated.
virtual IStandardAttribute LastUpdateTime { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
Locale
The user's locale, represented as a BCP47 [RFC5646] language tag.
virtual IStandardAttribute Locale { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
MiddleName
The user's middle name.
virtual IStandardAttribute MiddleName { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
Nickname
The user's nickname or casual name.
virtual IStandardAttribute Nickname { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
PhoneNumber
The user's telephone number.
virtual IStandardAttribute PhoneNumber { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
PreferredUsername
The user's preffered username, different from the immutable user name.
virtual IStandardAttribute PreferredUsername { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
ProfilePage
The URL to the user's profile page.
virtual IStandardAttribute ProfilePage { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
ProfilePicture
The URL to the user's profile picture.
virtual IStandardAttribute ProfilePicture { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
Timezone
The user's time zone.
virtual IStandardAttribute Timezone { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute
Website
The URL to the user's web page or blog.
virtual IStandardAttribute Website { get; }
Property Value
Remarks
Default: - see the defaults under StandardAttribute