AttributeMapping

class aws_cdk.aws_cognito.AttributeMapping(*, address=None, birthdate=None, custom=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

__init__(*, address=None, birthdate=None, custom=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)

The mapping of user pool attributes to the attributes provided by the identity providers.

Parameters
  • address (Optional[ProviderAttribute]) – The user’s postal address is a required attribute. Default: - not mapped

  • birthdate (Optional[ProviderAttribute]) – The user’s birthday. Default: - not mapped

  • custom (Optional[Mapping[str, ProviderAttribute]]) – Specify custom attribute mapping here and mapping for any standard attributes not supported yet. Default: - no custom attribute mapping

  • email (Optional[ProviderAttribute]) – The user’s e-mail address. Default: - not mapped

  • family_name (Optional[ProviderAttribute]) – The surname or last name of user. Default: - not mapped

  • fullname (Optional[ProviderAttribute]) – The user’s full name in displayable form. Default: - not mapped

  • gender (Optional[ProviderAttribute]) – The user’s gender. Default: - not mapped

  • given_name (Optional[ProviderAttribute]) – The user’s first name or give name. Default: - not mapped

  • last_update_time (Optional[ProviderAttribute]) – Time, the user’s information was last updated. Default: - not mapped

  • locale (Optional[ProviderAttribute]) – The user’s locale. Default: - not mapped

  • middle_name (Optional[ProviderAttribute]) – The user’s middle name. Default: - not mapped

  • nickname (Optional[ProviderAttribute]) – The user’s nickname or casual name. Default: - not mapped

  • phone_number (Optional[ProviderAttribute]) – The user’s telephone number. Default: - not mapped

  • preferred_username (Optional[ProviderAttribute]) – The user’s preferred username. Default: - not mapped

  • profile_page (Optional[ProviderAttribute]) – The URL to the user’s profile page. Default: - not mapped

  • profile_picture (Optional[ProviderAttribute]) – The URL to the user’s profile picture. Default: - not mapped

  • timezone (Optional[ProviderAttribute]) – The user’s time zone. Default: - not mapped

  • website (Optional[ProviderAttribute]) – The URL to the user’s web page or blog. Default: - not mapped

stability :stability: experimental

Return type

None

Attributes

address

The user’s postal address is a required attribute.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

birthdate

The user’s birthday.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

custom

Specify custom attribute mapping here and mapping for any standard attributes not supported yet.

default :default: - no custom attribute mapping

stability :stability: experimental

Return type

Optional[Mapping[str, ProviderAttribute]]

email

The user’s e-mail address.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

family_name

The surname or last name of user.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

fullname

The user’s full name in displayable form.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

gender

The user’s gender.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

given_name

The user’s first name or give name.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

last_update_time

Time, the user’s information was last updated.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

locale

The user’s locale.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

middle_name

The user’s middle name.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

nickname

The user’s nickname or casual name.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

phone_number

The user’s telephone number.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

preferred_username

The user’s preferred username.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

profile_page

The URL to the user’s profile page.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

profile_picture

The URL to the user’s profile picture.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

timezone

The user’s time zone.

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]

website

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

default :default: - not mapped

stability :stability: experimental

Return type

Optional[ProviderAttribute]