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

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

ExampleMetadata:

infused

Example:

userpool = cognito.UserPool(self, "Pool")

cognito.UserPoolIdentityProviderAmazon(self, "Amazon",
    client_id="amzn-client-id",
    client_secret="amzn-client-secret",
    user_pool=userpool,
    attribute_mapping=cognito.AttributeMapping(
        email=cognito.ProviderAttribute.AMAZON_EMAIL,
        website=cognito.ProviderAttribute.other("url"),  # use other() when an attribute is not pre-defined in the CDK
        custom={
            # custom user pool attributes go here
            "unique_id": cognito.ProviderAttribute.AMAZON_USER_ID
        }
    )
)

Attributes

address

The user’s postal address is a required attribute.

Default:
  • not mapped

birthdate

The user’s birthday.

Default:
  • not mapped

custom

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

Default:
  • no custom attribute mapping

email

The user’s e-mail address.

Default:
  • not mapped

family_name

The surname or last name of user.

Default:
  • not mapped

fullname

The user’s full name in displayable form.

Default:
  • not mapped

gender

The user’s gender.

Default:
  • not mapped

given_name

The user’s first name or give name.

Default:
  • not mapped

last_update_time

Time, the user’s information was last updated.

Default:
  • not mapped

locale

The user’s locale.

Default:
  • not mapped

middle_name

The user’s middle name.

Default:
  • not mapped

nickname

The user’s nickname or casual name.

Default:
  • not mapped

phone_number

The user’s telephone number.

Default:
  • not mapped

preferred_username

The user’s preferred username.

Default:
  • not mapped

profile_page

The URL to the user’s profile page.

Default:
  • not mapped

profile_picture

The URL to the user’s profile picture.

Default:
  • not mapped

timezone

The user’s time zone.

Default:
  • not mapped

website

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

Default:
  • not mapped