CfnUserProps

class aws_cdk.aws_connect.CfnUserProps(*, instance_arn, phone_config, routing_profile_arn, security_profile_arns, username, directory_user_id=None, hierarchy_group_arn=None, identity_info=None, password=None, tags=None)

Bases: object

Properties for defining a CfnUser.

Parameters
  • instance_arn (str) – The Amazon Resource Name (ARN) of the instance.

  • phone_config (Union[IResolvable, UserPhoneConfigProperty]) – Information about the phone configuration for the user.

  • routing_profile_arn (str) – The Amazon Resource Name (ARN) of the user’s routing profile.

  • security_profile_arns (Sequence[str]) – The Amazon Resource Name (ARN) of the user’s security profile.

  • username (str) – The user name assigned to the user account.

  • directory_user_id (Optional[str]) – The identifier of the user account in the directory used for identity management.

  • hierarchy_group_arn (Optional[str]) – The Amazon Resource Name (ARN) of the user’s hierarchy group.

  • identity_info (Union[IResolvable, UserIdentityInfoProperty, None]) – Information about the user identity.

  • password (Optional[str]) – The user’s password.

  • tags (Optional[Sequence[CfnTag]]) – The tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-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.
import aws_cdk.aws_connect as connect

cfn_user_props = connect.CfnUserProps(
    instance_arn="instanceArn",
    phone_config=connect.CfnUser.UserPhoneConfigProperty(
        phone_type="phoneType",

        # the properties below are optional
        after_contact_work_time_limit=123,
        auto_accept=False,
        desk_phone_number="deskPhoneNumber"
    ),
    routing_profile_arn="routingProfileArn",
    security_profile_arns=["securityProfileArns"],
    username="username",

    # the properties below are optional
    directory_user_id="directoryUserId",
    hierarchy_group_arn="hierarchyGroupArn",
    identity_info=connect.CfnUser.UserIdentityInfoProperty(
        email="email",
        first_name="firstName",
        last_name="lastName"
    ),
    password="password",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

directory_user_id

The identifier of the user account in the directory used for identity management.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html#cfn-connect-user-directoryuserid

Return type

Optional[str]

hierarchy_group_arn

The Amazon Resource Name (ARN) of the user’s hierarchy group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html#cfn-connect-user-hierarchygrouparn

Return type

Optional[str]

identity_info

Information about the user identity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html#cfn-connect-user-identityinfo

Return type

Union[IResolvable, UserIdentityInfoProperty, None]

instance_arn

The Amazon Resource Name (ARN) of the instance.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html#cfn-connect-user-instancearn

Return type

str

password

The user’s password.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html#cfn-connect-user-password

Return type

Optional[str]

phone_config

Information about the phone configuration for the user.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html#cfn-connect-user-phoneconfig

Return type

Union[IResolvable, UserPhoneConfigProperty]

routing_profile_arn

The Amazon Resource Name (ARN) of the user’s routing profile.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html#cfn-connect-user-routingprofilearn

Return type

str

security_profile_arns

The Amazon Resource Name (ARN) of the user’s security profile.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html#cfn-connect-user-securityprofilearns

Return type

List[str]

tags

The tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html#cfn-connect-user-tags

Return type

Optional[List[CfnTag]]

username

The user name assigned to the user account.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html#cfn-connect-user-username

Return type

str