CfnUserProps

class aws_cdk.aws_identitystore.CfnUserProps(*, identity_store_id, addresses=None, birthdate=None, display_name=None, emails=None, locale=None, name=None, nick_name=None, phone_numbers=None, photos=None, preferred_language=None, profile_url=None, roles=None, timezone=None, title=None, user_name=None, user_type=None, website=None)

Bases: object

Properties for defining a CfnUser.

Parameters:

identity_store_id (str) – The globally unique identifier for the identity store.
addresses (Union[IResolvable, Sequence[Union[IResolvable, AddressesItemsProperty, Dict[str, Any]]], None]) – A list of addresses associated with the user.
birthdate (Optional[str]) – The user’s birthdate in YYYY-MM-DD format.
display_name (Optional[str]) – A string containing the name of the user for display.
emails (Union[IResolvable, Sequence[Union[IResolvable, EmailsItemsProperty, Dict[str, Any]]], None]) – A list of email addresses associated with the user.
locale (Optional[str]) – The geographical region or location of the user.
name (Union[IResolvable, NameProperty, Dict[str, Any], None]) – The name of the user.
nick_name (Optional[str]) – An alternate name for the user.
phone_numbers (Union[IResolvable, Sequence[Union[IResolvable, PhoneNumbersItemsProperty, Dict[str, Any]]], None]) – A list of phone numbers associated with the user.
photos (Union[IResolvable, Sequence[Union[IResolvable, PhotosItemsProperty, Dict[str, Any]]], None]) – A list of photos associated with the user.
preferred_language (Optional[str]) – The preferred language of the user.
profile_url (Optional[str]) – A URL associated with the user.
roles (Union[IResolvable, Sequence[Union[IResolvable, RolesItemsProperty, Dict[str, Any]]], None]) – A list of roles associated with the user.
timezone (Optional[str]) – The time zone for the user.
title (Optional[str]) – The title of the user.
user_name (Optional[str]) – A unique string used to identify the user.
user_type (Optional[str]) – A string indicating the type of user.
website (Optional[str]) – The user’s personal website or blog URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-user.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_identitystore as identitystore

cfn_user_props = identitystore.CfnUserProps(
    identity_store_id="identityStoreId",

    # the properties below are optional
    addresses=[identitystore.CfnUser.AddressesItemsProperty(
        country="country",
        formatted="formatted",
        locality="locality",
        postal_code="postalCode",
        primary=False,
        region="region",
        street_address="streetAddress",
        type="type"
    )],
    birthdate="birthdate",
    display_name="displayName",
    emails=[identitystore.CfnUser.EmailsItemsProperty(
        primary=False,
        type="type",
        value="value"
    )],
    locale="locale",
    name=identitystore.CfnUser.NameProperty(
        family_name="familyName",
        formatted="formatted",
        given_name="givenName",
        honorific_prefix="honorificPrefix",
        honorific_suffix="honorificSuffix",
        middle_name="middleName"
    ),
    nick_name="nickName",
    phone_numbers=[identitystore.CfnUser.PhoneNumbersItemsProperty(
        primary=False,
        type="type",
        value="value"
    )],
    photos=[identitystore.CfnUser.PhotosItemsProperty(
        value="value",

        # the properties below are optional
        display="display",
        primary=False,
        type="type"
    )],
    preferred_language="preferredLanguage",
    profile_url="profileUrl",
    roles=[identitystore.CfnUser.RolesItemsProperty(
        primary=False,
        type="type",
        value="value"
    )],
    timezone="timezone",
    title="title",
    user_name="userName",
    user_type="userType",
    website="website"
)