Interface IStandardAttributes

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

The set of standard attributes that can be marked as required or mutable.

public interface IStandardAttributes

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

Remarks

See: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#cognito-user-pools-standard-attributes

ExampleMetadata: infused

Properties

Address

The user's postal address.

IStandardAttribute? Address { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

Birthdate

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

IStandardAttribute? Birthdate { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

Email

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

IStandardAttribute? Email { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

EmailVerified

(deprecated) DEPRECATED.

[Obsolete("this is not a standard attribute and was incorrectly added to the CDK. It is a Cognito built-in attribute and cannot be controlled as part of user pool creation.")]
IStandardAttribute? EmailVerified { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

Stability: Deprecated

FamilyName

The surname or last name of the user.

IStandardAttribute? FamilyName { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

Fullname

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

IStandardAttribute? Fullname { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

Gender

The user's gender.

IStandardAttribute? Gender { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

GivenName

The user's first name or give name.

IStandardAttribute? GivenName { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

LastUpdateTime

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

IStandardAttribute? LastUpdateTime { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

Locale

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

IStandardAttribute? Locale { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

MiddleName

The user's middle name.

IStandardAttribute? MiddleName { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

Nickname

The user's nickname or casual name.

IStandardAttribute? Nickname { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

PhoneNumber

The user's telephone number.

IStandardAttribute? PhoneNumber { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

PhoneNumberVerified

(deprecated) DEPRECATED.

[Obsolete("this is not a standard attribute and was incorrectly added to the CDK. It is a Cognito built-in attribute and cannot be controlled as part of user pool creation.")]
IStandardAttribute? PhoneNumberVerified { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

Stability: Deprecated

PreferredUsername

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

IStandardAttribute? PreferredUsername { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

ProfilePage

The URL to the user's profile page.

IStandardAttribute? ProfilePage { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

ProfilePicture

The URL to the user's profile picture.

IStandardAttribute? ProfilePicture { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

Timezone

The user's time zone.

IStandardAttribute? Timezone { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute

Website

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

IStandardAttribute? Website { get; }

Property Value

IStandardAttribute

Remarks

Default: - see the defaults under StandardAttribute