CfnUserPropsMixin

class aws_cdk.mixins_preview.aws_connect.mixins.CfnUserPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a user account for an Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html
CloudformationResource:: AWS::Connect::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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

cfn_user_props_mixin = connect_mixins.CfnUserPropsMixin(connect_mixins.CfnUserMixinProps(
    directory_user_id="directoryUserId",
    hierarchy_group_arn="hierarchyGroupArn",
    identity_info=connect_mixins.CfnUserPropsMixin.UserIdentityInfoProperty(
        email="email",
        first_name="firstName",
        last_name="lastName",
        mobile="mobile",
        secondary_email="secondaryEmail"
    ),
    instance_arn="instanceArn",
    password="password",
    phone_config=connect_mixins.CfnUserPropsMixin.UserPhoneConfigProperty(
        after_contact_work_time_limit=123,
        auto_accept=False,
        desk_phone_number="deskPhoneNumber",
        persistent_connection=False,
        phone_type="phoneType"
    ),
    routing_profile_arn="routingProfileArn",
    security_profile_arns=["securityProfileArns"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    username="username",
    user_proficiencies=[connect_mixins.CfnUserPropsMixin.UserProficiencyProperty(
        attribute_name="attributeName",
        attribute_value="attributeValue",
        level=123
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['directoryUserId', 'hierarchyGroupArn', 'identityInfo', 'instanceArn', 'password', 'phoneConfig', 'routingProfileArn', 'securityProfileArns', 'tags', 'username', 'userProficiencies']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

UserIdentityInfoProperty

class CfnUserPropsMixin.UserIdentityInfoProperty(*, email=None, first_name=None, last_name=None, mobile=None, secondary_email=None)

Bases: object

Contains information about the identity of a user.

For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName , LastName , and Email cannot be updated from within Amazon Connect because they are managed by the directory. > The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for FirstName , and 1-256 for LastName .

Parameters:

email (Optional[str]) – The email address. If you are using SAML for identity management and include this parameter, an error is returned.
first_name (Optional[str]) – The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.
last_name (Optional[str]) – The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.
mobile (Optional[str]) – The user’s mobile number.
secondary_email (Optional[str]) – The user’s secondary email address. If you provide a secondary email, the user receives email notifications – other than password reset notifications – to this email address instead of to their primary email address. Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.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.mixins_preview.aws_connect import mixins as connect_mixins

user_identity_info_property = connect_mixins.CfnUserPropsMixin.UserIdentityInfoProperty(
    email="email",
    first_name="firstName",
    last_name="lastName",
    mobile="mobile",
    secondary_email="secondaryEmail"
)

Attributes

email

The email address.

If you are using SAML for identity management and include this parameter, an error is returned.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html#cfn-connect-user-useridentityinfo-email

first_name

The first name.

This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html#cfn-connect-user-useridentityinfo-firstname

last_name

The last name.

This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html#cfn-connect-user-useridentityinfo-lastname

mobile

The user’s mobile number.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html#cfn-connect-user-useridentityinfo-mobile

secondary_email

The user’s secondary email address.

If you provide a secondary email, the user receives email notifications – other than password reset notifications – to this email address instead of to their primary email address.

Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html#cfn-connect-user-useridentityinfo-secondaryemail

UserPhoneConfigProperty

class CfnUserPropsMixin.UserPhoneConfigProperty(*, after_contact_work_time_limit=None, auto_accept=None, desk_phone_number=None, persistent_connection=None, phone_type=None)

Bases: object

Contains information about the phone configuration settings for a user.

Parameters:

after_contact_work_time_limit (Union[int, float, None]) – The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don’t want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW. .. epigraph:: When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
auto_accept (Union[bool, IResolvable, None]) – The Auto accept setting.
desk_phone_number (Optional[str]) – The phone number for the user’s desk phone.
persistent_connection (Union[bool, IResolvable, None]) – The persistent connection setting for the user.
phone_type (Optional[str]) – The phone type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-userphoneconfig.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.mixins_preview.aws_connect import mixins as connect_mixins

user_phone_config_property = connect_mixins.CfnUserPropsMixin.UserPhoneConfigProperty(
    after_contact_work_time_limit=123,
    auto_accept=False,
    desk_phone_number="deskPhoneNumber",
    persistent_connection=False,
    phone_type="phoneType"
)

Attributes

after_contact_work_time_limit

The After Call Work (ACW) timeout setting, in seconds.

This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don’t want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW. .. epigraph:

When returned by a ``SearchUsers`` call, ``AfterContactWorkTimeLimit`` is returned in milliseconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-userphoneconfig.html#cfn-connect-user-userphoneconfig-aftercontactworktimelimit

auto_accept

The Auto accept setting.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-userphoneconfig.html#cfn-connect-user-userphoneconfig-autoaccept

desk_phone_number

The phone number for the user’s desk phone.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-userphoneconfig.html#cfn-connect-user-userphoneconfig-deskphonenumber

persistent_connection

The persistent connection setting for the user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-userphoneconfig.html#cfn-connect-user-userphoneconfig-persistentconnection

phone_type

The phone type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-userphoneconfig.html#cfn-connect-user-userphoneconfig-phonetype

UserProficiencyProperty

class CfnUserPropsMixin.UserProficiencyProperty(*, attribute_name=None, attribute_value=None, level=None)

Bases: object

A predefined attribute must be created before using UserProficiencies in the Cloudformation User template.

For more information, see Predefined attributes .

Proficiency of a user.

Attributes

attribute_name

The name of user’s proficiency.

You must use a predefined attribute name that is present in the Amazon Connect instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-userproficiency.html#cfn-connect-user-userproficiency-attributename

attribute_value

The value of user’s proficiency.

You must use a predefined attribute value that is present in the Amazon Connect instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-userproficiency.html#cfn-connect-user-userproficiency-attributevalue

level

The level of the proficiency.

The valid values are 1, 2, 3, 4 and 5.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-userproficiency.html#cfn-connect-user-userproficiency-level