StandardAttributes

class aws_cdk.aws_cognito.StandardAttributes(*, address=None, birthdate=None, email=None, family_name=None, fullname=None, gender=None, given_name=None, last_update_time=None, locale=None, middle_name=None, nickname=None, phone_number=None, preferred_username=None, profile_page=None, profile_picture=None, timezone=None, website=None)

Bases: object

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

Parameters:

address (Union[StandardAttribute, Dict[str, Any], None]) – The user’s postal address. Default: - see the defaults under StandardAttribute
birthdate (Union[StandardAttribute, Dict[str, Any], None]) – The user’s birthday, represented as an ISO 8601:2004 format. Default: - see the defaults under StandardAttribute
email (Union[StandardAttribute, Dict[str, Any], None]) – The user’s e-mail address, represented as an RFC 5322 [RFC5322] addr-spec. Default: - see the defaults under StandardAttribute
family_name (Union[StandardAttribute, Dict[str, Any], None]) – The surname or last name of the user. Default: - see the defaults under StandardAttribute
fullname (Union[StandardAttribute, Dict[str, Any], None]) – The user’s full name in displayable form, including all name parts, titles and suffixes. Default: - see the defaults under StandardAttribute
gender (Union[StandardAttribute, Dict[str, Any], None]) – The user’s gender. Default: - see the defaults under StandardAttribute
given_name (Union[StandardAttribute, Dict[str, Any], None]) – The user’s first name or give name. Default: - see the defaults under StandardAttribute
last_update_time (Union[StandardAttribute, Dict[str, Any], None]) – The time, the user’s information was last updated. Default: - see the defaults under StandardAttribute
locale (Union[StandardAttribute, Dict[str, Any], None]) – The user’s locale, represented as a BCP47 [RFC5646] language tag. Default: - see the defaults under StandardAttribute
middle_name (Union[StandardAttribute, Dict[str, Any], None]) – The user’s middle name. Default: - see the defaults under StandardAttribute
nickname (Union[StandardAttribute, Dict[str, Any], None]) – The user’s nickname or casual name. Default: - see the defaults under StandardAttribute
phone_number (Union[StandardAttribute, Dict[str, Any], None]) – The user’s telephone number. Default: - see the defaults under StandardAttribute
preferred_username (Union[StandardAttribute, Dict[str, Any], None]) – The user’s preffered username, different from the immutable user name. Default: - see the defaults under StandardAttribute
profile_page (Union[StandardAttribute, Dict[str, Any], None]) – The URL to the user’s profile page. Default: - see the defaults under StandardAttribute
profile_picture (Union[StandardAttribute, Dict[str, Any], None]) – The URL to the user’s profile picture. Default: - see the defaults under StandardAttribute
timezone (Union[StandardAttribute, Dict[str, Any], None]) – The user’s time zone. Default: - see the defaults under StandardAttribute
website (Union[StandardAttribute, Dict[str, Any], None]) – The URL to the user’s web page or blog. Default: - see the defaults under StandardAttribute

See:

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

ExampleMetadata:

infused

Example:

cognito.UserPool(self, "myuserpool",
    # ...
    standard_attributes=cognito.StandardAttributes(
        fullname=cognito.StandardAttribute(
            required=True,
            mutable=False
        ),
        address=cognito.StandardAttribute(
            required=False,
            mutable=True
        )
    ),
    custom_attributes={
        "myappid": cognito.StringAttribute(min_len=5, max_len=15, mutable=False),
        "callingcode": cognito.NumberAttribute(min=1, max=3, mutable=True),
        "isEmployee": cognito.BooleanAttribute(mutable=True),
        "joinedOn": cognito.DateTimeAttribute()
    }
)

Attributes

address

The user’s postal address.

Default:

see the defaults under StandardAttribute

birthdate

2004 format.

Default:

see the defaults under StandardAttribute

Type:

The user’s birthday, represented as an ISO 8601

email

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

Default:

see the defaults under StandardAttribute

family_name

The surname or last name of the user.

Default:

see the defaults under StandardAttribute

fullname

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

Default:

see the defaults under StandardAttribute

gender

The user’s gender.

Default:

see the defaults under StandardAttribute

given_name

The user’s first name or give name.

Default:

see the defaults under StandardAttribute

last_update_time

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

Default:

see the defaults under StandardAttribute

locale

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

Default:

see the defaults under StandardAttribute

middle_name

The user’s middle name.

Default:

see the defaults under StandardAttribute

nickname

The user’s nickname or casual name.

Default:

see the defaults under StandardAttribute

phone_number

The user’s telephone number.

Default:

see the defaults under StandardAttribute

preferred_username

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

Default:

see the defaults under StandardAttribute

profile_page

The URL to the user’s profile page.

Default:

see the defaults under StandardAttribute

profile_picture

The URL to the user’s profile picture.

Default:

see the defaults under StandardAttribute

timezone

The user’s time zone.

Default:

see the defaults under StandardAttribute

website

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

Default:

see the defaults under StandardAttribute