CfnUserPropsMixin

class aws_cdk.cfn_property_mixins.aws_identitystore.CfnUserPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a user within the specified identity store.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-user.html
CloudformationResource:: AWS::IdentityStore::User
Mixin:: true
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.cfn_property_mixins import aws_identitystore as identitystore
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_user_props_mixin = identitystore.CfnUserPropsMixin(identitystore.CfnUserMixinProps(
    addresses=[identitystore.CfnUserPropsMixin.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.CfnUserPropsMixin.EmailsItemsProperty(
        primary=False,
        type="type",
        value="value"
    )],
    identity_store_id="identityStoreId",
    locale="locale",
    name=identitystore.CfnUserPropsMixin.NameProperty(
        family_name="familyName",
        formatted="formatted",
        given_name="givenName",
        honorific_prefix="honorificPrefix",
        honorific_suffix="honorificSuffix",
        middle_name="middleName"
    ),
    nick_name="nickName",
    phone_numbers=[identitystore.CfnUserPropsMixin.PhoneNumbersItemsProperty(
        primary=False,
        type="type",
        value="value"
    )],
    photos=[identitystore.CfnUserPropsMixin.PhotosItemsProperty(
        display="display",
        primary=False,
        type="type",
        value="value"
    )],
    preferred_language="preferredLanguage",
    profile_url="profileUrl",
    roles=[identitystore.CfnUserPropsMixin.RolesItemsProperty(
        primary=False,
        type="type",
        value="value"
    )],
    timezone="timezone",
    title="title",
    user_name="userName",
    user_type="userType",
    website="website"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::IdentityStore::User.

Parameters:

props (Union[CfnUserMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['addresses', 'birthdate', 'displayName', 'emails', 'identityStoreId', 'locale', 'name', 'nickName', 'phoneNumbers', 'photos', 'preferredLanguage', 'profileUrl', 'roles', 'timezone', 'title', 'userName', 'userType', 'website']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

AddressesItemsProperty

class CfnUserPropsMixin.AddressesItemsProperty(*, country=None, formatted=None, locality=None, postal_code=None, primary=None, region=None, street_address=None, type=None)

Bases: object

Parameters:

country (Optional[str]) – The country of the address.
formatted (Optional[str]) – A formatted version of the address for display.
locality (Optional[str]) – A string of the address locality.
postal_code (Optional[str]) – The postal code of the address.
primary (Union[bool, IResolvable, None]) – Whether this is the primary address.
region (Optional[str]) – The region of the address.
street_address (Optional[str]) – The street of the address.
type (Optional[str]) – The type of address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.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.cfn_property_mixins import aws_identitystore as identitystore

addresses_items_property = identitystore.CfnUserPropsMixin.AddressesItemsProperty(
    country="country",
    formatted="formatted",
    locality="locality",
    postal_code="postalCode",
    primary=False,
    region="region",
    street_address="streetAddress",
    type="type"
)

Attributes

country

The country of the address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-country

formatted

A formatted version of the address for display.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-formatted

locality

A string of the address locality.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-locality

postal_code

The postal code of the address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-postalcode

primary

Whether this is the primary address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-primary

region

The region of the address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-region

street_address

The street of the address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-streetaddress

type

The type of address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-type

EmailsItemsProperty

class CfnUserPropsMixin.EmailsItemsProperty(*, primary=None, type=None, value=None)

Bases: object

Parameters:

primary (Union[bool, IResolvable, None]) – Whether this is the primary email address.
type (Optional[str]) – The type of email address.
value (Optional[str]) – The email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-emailsitems.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.cfn_property_mixins import aws_identitystore as identitystore

emails_items_property = identitystore.CfnUserPropsMixin.EmailsItemsProperty(
    primary=False,
    type="type",
    value="value"
)

Attributes

primary

Whether this is the primary email address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-emailsitems.html#cfn-identitystore-user-emailsitems-primary

type

The type of email address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-emailsitems.html#cfn-identitystore-user-emailsitems-type

value

The email address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-emailsitems.html#cfn-identitystore-user-emailsitems-value

NameProperty

class CfnUserPropsMixin.NameProperty(*, family_name=None, formatted=None, given_name=None, honorific_prefix=None, honorific_suffix=None, middle_name=None)

Bases: object

The name of the user.

Parameters:

family_name (Optional[str]) – The family name of the user.
formatted (Optional[str]) – A string containing a formatted version of the name for display.
given_name (Optional[str]) – The given name of the user.
honorific_prefix (Optional[str]) – The honorific prefix of the user.
honorific_suffix (Optional[str]) – The honorific suffix of the user.
middle_name (Optional[str]) – The middle name of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.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.cfn_property_mixins import aws_identitystore as identitystore

name_property = identitystore.CfnUserPropsMixin.NameProperty(
    family_name="familyName",
    formatted="formatted",
    given_name="givenName",
    honorific_prefix="honorificPrefix",
    honorific_suffix="honorificSuffix",
    middle_name="middleName"
)

Attributes

family_name

The family name of the user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-familyname

formatted

A string containing a formatted version of the name for display.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-formatted

given_name

The given name of the user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-givenname

honorific_prefix

The honorific prefix of the user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-honorificprefix

honorific_suffix

The honorific suffix of the user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-honorificsuffix

middle_name

The middle name of the user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-middlename

PhoneNumbersItemsProperty

class CfnUserPropsMixin.PhoneNumbersItemsProperty(*, primary=None, type=None, value=None)

Bases: object

Parameters:

primary (Union[bool, IResolvable, None]) – Whether this is the primary phone number.
type (Optional[str]) – The type of phone number.
value (Optional[str]) – The phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-phonenumbersitems.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.cfn_property_mixins import aws_identitystore as identitystore

phone_numbers_items_property = identitystore.CfnUserPropsMixin.PhoneNumbersItemsProperty(
    primary=False,
    type="type",
    value="value"
)

Attributes

primary

Whether this is the primary phone number.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-phonenumbersitems.html#cfn-identitystore-user-phonenumbersitems-primary

type

The type of phone number.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-phonenumbersitems.html#cfn-identitystore-user-phonenumbersitems-type

value

The phone number.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-phonenumbersitems.html#cfn-identitystore-user-phonenumbersitems-value

PhotosItemsProperty

class CfnUserPropsMixin.PhotosItemsProperty(*, display=None, primary=None, type=None, value=None)

Bases: object

Parameters:

display (Optional[str]) – A display name for the photo.
primary (Union[bool, IResolvable, None]) – Whether this is the primary photo.
type (Optional[str]) – The type of photo.
value (Optional[str]) – The photo data or URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-photositems.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.cfn_property_mixins import aws_identitystore as identitystore

photos_items_property = identitystore.CfnUserPropsMixin.PhotosItemsProperty(
    display="display",
    primary=False,
    type="type",
    value="value"
)

Attributes

display

A display name for the photo.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-photositems.html#cfn-identitystore-user-photositems-display

primary

Whether this is the primary photo.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-photositems.html#cfn-identitystore-user-photositems-primary

type

The type of photo.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-photositems.html#cfn-identitystore-user-photositems-type

value

The photo data or URL.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-photositems.html#cfn-identitystore-user-photositems-value

RolesItemsProperty

class CfnUserPropsMixin.RolesItemsProperty(*, primary=None, type=None, value=None)

Bases: object

Parameters:

primary (Union[bool, IResolvable, None]) – Whether this is the primary role.
type (Optional[str]) – The type of role.
value (Optional[str]) – The role name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-rolesitems.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.cfn_property_mixins import aws_identitystore as identitystore

roles_items_property = identitystore.CfnUserPropsMixin.RolesItemsProperty(
    primary=False,
    type="type",
    value="value"
)

Attributes

primary

Whether this is the primary role.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-rolesitems.html#cfn-identitystore-user-rolesitems-primary

type

The type of role.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-rolesitems.html#cfn-identitystore-user-rolesitems-type

value

The role name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-rolesitems.html#cfn-identitystore-user-rolesitems-value