Skip to content
v2.273.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 ​

afterContactWorkConfigsIResolvable | IResolvable | CfnUser.AfterContactWorkConfigPerChannelProperty[]after_contact_work_configstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AfterContactWorkConfigPerChannelProperty]]]afterContactWorkConfigsIResolvableAfterContactWorkConfigsIResolvableAfterContactWorkConfigsinterface{}#
After Contact Work configurations of a user.
autoAcceptConfigsIResolvable | IResolvable | CfnUser.AutoAcceptConfigProperty[]auto_accept_configstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AutoAcceptConfigProperty]]]autoAcceptConfigsIResolvableAutoAcceptConfigsIResolvableAutoAcceptConfigsinterface{}#
Auto-accept configurations of a user.
directoryUserIdstringdirectory_user_idstrdirectoryUserIdStringDirectoryUserIdstringDirectoryUserId*string#
The identifier of the user account in the directory used for identity management.
hierarchyGroupArnstringhierarchy_group_arnstrhierarchyGroupArnStringHierarchyGroupArnstringHierarchyGroupArn*string#
The Amazon Resource Name (ARN) of the user's hierarchy group.
identityInfoIResolvable | CfnUser.UserIdentityInfoPropertyidentity_infotyping.Union[IResolvable, UserIdentityInfoProperty]identityInfoIResolvableIdentityInfoIResolvableIdentityInfointerface{}#
Information about the user identity.
instanceArnstringinstance_arnstrinstanceArnStringInstanceArnstringInstanceArn*stringrequired#
The Amazon Resource Name (ARN) of the instance.
passwordstringpasswordstrpasswordStringPasswordstringPassword*string#
The user's password.
persistentConnectionConfigsIResolvable | IResolvable | CfnUser.PersistentConnectionConfigProperty[]persistent_connection_configstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PersistentConnectionConfigProperty]]]persistentConnectionConfigsIResolvablePersistentConnectionConfigsIResolvablePersistentConnectionConfigsinterface{}#
Persistent Connection configurations of a user.
phoneConfigIResolvable | CfnUser.UserPhoneConfigPropertyphone_configtyping.Union[IResolvable, UserPhoneConfigProperty]phoneConfigIResolvablePhoneConfigIResolvablePhoneConfiginterface{}#
Information about the phone configuration for the user.
phoneNumberConfigsIResolvable | IResolvable | CfnUser.PhoneNumberConfigProperty[]phone_number_configstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PhoneNumberConfigProperty]]]phoneNumberConfigsIResolvablePhoneNumberConfigsIResolvablePhoneNumberConfigsinterface{}#
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.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
The tags.
usernamestringusernamestrusernameStringUsernamestringUsername*stringrequired#
The user name assigned to the user account.
userProficienciesIResolvable | IResolvable | CfnUser.UserProficiencyProperty[]user_proficienciestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, UserProficiencyProperty]]]userProficienciesIResolvableUserProficienciesIResolvableUserProficienciesinterface{}#
One or more predefined attributes assigned to a user, with a numeric value that indicates how their level of skill in a specified area.
voiceEnhancementConfigsIResolvable | IResolvable | CfnUser.VoiceEnhancementConfigProperty[]voice_enhancement_configstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VoiceEnhancementConfigProperty]]]voiceEnhancementConfigsIResolvableVoiceEnhancementConfigsIResolvableVoiceEnhancementConfigsinterface{}#
Voice Enhancement configurations of a user.

Used as props by ​