Skip to content
v2.275.0

CfnUserProps Struct ​

Properties for defining a CfnUser.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_connect as connect } from 'aws-cdk-lib';
const cfnUserProps: connect.CfnUserProps = {
  instanceArn: 'instanceArn',
  routingProfileArn: 'routingProfileArn',
  securityProfileArns: ['securityProfileArns'],
  username: 'username',

  // the properties below are optional
  afterContactWorkConfigs: [{
    afterContactWorkConfig: {
      afterContactWorkMode: 'afterContactWorkMode',
      afterContactWorkTimeLimit: 123,
    },
    channel: 'channel',

    // the properties below are optional
    agentFirstCallbackAfterContactWorkConfig: {
      afterContactWorkMode: 'afterContactWorkMode',
      afterContactWorkTimeLimit: 123,
    },
  }],
  autoAcceptConfigs: [{
    autoAccept: false,
    channel: 'channel',

    // the properties below are optional
    agentFirstCallbackAutoAccept: false,
  }],
  directoryUserId: 'directoryUserId',
  hierarchyGroupArn: 'hierarchyGroupArn',
  identityInfo: {
    email: 'email',
    firstName: 'firstName',
    lastName: 'lastName',
    mobile: 'mobile',
    secondaryEmail: 'secondaryEmail',
  },
  password: 'password',
  persistentConnectionConfigs: [{
    channel: 'channel',
    persistentConnection: false,
  }],
  phoneConfig: {
    afterContactWorkTimeLimit: 123,
    autoAccept: false,
    deskPhoneNumber: 'deskPhoneNumber',
    persistentConnection: false,
    phoneType: 'phoneType',
  },
  phoneNumberConfigs: [{
    channel: 'channel',
    phoneType: 'phoneType',

    // the properties below are optional
    phoneNumber: 'phoneNumber',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userProficiencies: [{
    attributeName: 'attributeName',
    attributeValue: 'attributeValue',
    level: 123,
  }],
  voiceEnhancementConfigs: [{
    channel: 'channel',
    voiceEnhancementMode: 'voiceEnhancementMode',
  }],
};

Properties ​

afterContactWorkConfigsoptionalIResolvable | IResolvable | CfnUser.AfterContactWorkConfigPerChannelProperty[]after_contact_work_configsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AfterContactWorkConfigPerChannelProperty]]]afterContactWorkConfigsoptionalIResolvableAfterContactWorkConfigsoptionalIResolvableAfterContactWorkConfigsoptionalinterface{}#
After Contact Work configurations of a user.
autoAcceptConfigsoptionalIResolvable | IResolvable | CfnUser.AutoAcceptConfigProperty[]auto_accept_configsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AutoAcceptConfigProperty]]]autoAcceptConfigsoptionalIResolvableAutoAcceptConfigsoptionalIResolvableAutoAcceptConfigsoptionalinterface{}#
Auto-accept configurations of a user.
directoryUserIdoptionalstringdirectory_user_idoptionalstrdirectoryUserIdoptionalStringDirectoryUserIdoptionalstringDirectoryUserIdoptional*string#
The identifier of the user account in the directory used for identity management.
hierarchyGroupArnoptionalstringhierarchy_group_arnoptionalstrhierarchyGroupArnoptionalStringHierarchyGroupArnoptionalstringHierarchyGroupArnoptional*string#
The Amazon Resource Name (ARN) of the user's hierarchy group.
identityInfooptionalIResolvable | CfnUser.UserIdentityInfoPropertyidentity_infooptionaltyping.Union[IResolvable, UserIdentityInfoProperty]identityInfooptionalIResolvableIdentityInfooptionalIResolvableIdentityInfooptionalinterface{}#
Information about the user identity.
instanceArnstringinstance_arnstrinstanceArnStringInstanceArnstringInstanceArn*stringrequired#
The Amazon Resource Name (ARN) of the instance.
passwordoptionalstringpasswordoptionalstrpasswordoptionalStringPasswordoptionalstringPasswordoptional*string#
The user's password.
persistentConnectionConfigsoptionalIResolvable | IResolvable | CfnUser.PersistentConnectionConfigProperty[]persistent_connection_configsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PersistentConnectionConfigProperty]]]persistentConnectionConfigsoptionalIResolvablePersistentConnectionConfigsoptionalIResolvablePersistentConnectionConfigsoptionalinterface{}#
Persistent Connection configurations of a user.
phoneConfigoptionalIResolvable | CfnUser.UserPhoneConfigPropertyphone_configoptionaltyping.Union[IResolvable, UserPhoneConfigProperty]phoneConfigoptionalIResolvablePhoneConfigoptionalIResolvablePhoneConfigoptionalinterface{}#
Information about the phone configuration for the user.
phoneNumberConfigsoptionalIResolvable | IResolvable | CfnUser.PhoneNumberConfigProperty[]phone_number_configsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PhoneNumberConfigProperty]]]phoneNumberConfigsoptionalIResolvablePhoneNumberConfigsoptionalIResolvablePhoneNumberConfigsoptionalinterface{}#
Phone Number configurations of a user.
routingProfileArnstringrouting_profile_arnstrroutingProfileArnStringRoutingProfileArnstringRoutingProfileArn*stringrequired#
The Amazon Resource Name (ARN) of the user's routing profile.
securityProfileArnsstring[]security_profile_arnstyping.List[str]securityProfileArnsList<String>SecurityProfileArnsstring[]SecurityProfileArns*[]*stringrequired#
The Amazon Resource Name (ARN) of the user's security profile.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags.
usernamestringusernamestrusernameStringUsernamestringUsername*stringrequired#
The user name assigned to the user account.
userProficienciesoptionalIResolvable | IResolvable | CfnUser.UserProficiencyProperty[]user_proficienciesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, UserProficiencyProperty]]]userProficienciesoptionalIResolvableUserProficienciesoptionalIResolvableUserProficienciesoptionalinterface{}#
One or more predefined attributes assigned to a user, with a numeric value that indicates how their level of skill in a specified area.
voiceEnhancementConfigsoptionalIResolvable | IResolvable | CfnUser.VoiceEnhancementConfigProperty[]voice_enhancement_configsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VoiceEnhancementConfigProperty]]]voiceEnhancementConfigsoptionalIResolvableVoiceEnhancementConfigsoptionalIResolvableVoiceEnhancementConfigsoptionalinterface{}#
Voice Enhancement configurations of a user.