aws-cdk-lib.aws_connect.CfnUserProps

interface CfnUserProps

LanguageType name
.NETAmazon.CDK.AWS.Connect.CfnUserProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsconnect#CfnUserProps
Javasoftware.amazon.awscdk.services.connect.CfnUserProps
Pythonaws_cdk.aws_connect.CfnUserProps
TypeScript aws-cdk-lib » aws_connect » CfnUserProps

Properties for defining a CfnUser.

Example

// 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',
  phoneConfig: {
    phoneType: 'phoneType',

    // the properties below are optional
    afterContactWorkTimeLimit: 123,
    autoAccept: false,
    deskPhoneNumber: 'deskPhoneNumber',
  },
  routingProfileArn: 'routingProfileArn',
  securityProfileArns: ['securityProfileArns'],
  username: 'username',

  // the properties below are optional
  directoryUserId: 'directoryUserId',
  hierarchyGroupArn: 'hierarchyGroupArn',
  identityInfo: {
    email: 'email',
    firstName: 'firstName',
    lastName: 'lastName',
    mobile: 'mobile',
    secondaryEmail: 'secondaryEmail',
  },
  password: 'password',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
instanceArnstringThe Amazon Resource Name (ARN) of the instance.
phoneConfigIResolvable | UserPhoneConfigPropertyInformation about the phone configuration for the user.
routingProfileArnstringThe Amazon Resource Name (ARN) of the user's routing profile.
securityProfileArnsstring[]The Amazon Resource Name (ARN) of the user's security profile.
usernamestringThe user name assigned to the user account.
directoryUserId?stringThe identifier of the user account in the directory used for identity management.
hierarchyGroupArn?stringThe Amazon Resource Name (ARN) of the user's hierarchy group.
identityInfo?IResolvable | UserIdentityInfoPropertyInformation about the user identity.
password?stringThe user's password.
tags?CfnTag[]The tags.

instanceArn

Type: string

The Amazon Resource Name (ARN) of the instance.


phoneConfig

Type: IResolvable | UserPhoneConfigProperty

Information about the phone configuration for the user.


routingProfileArn

Type: string

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


securityProfileArns

Type: string[]

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


username

Type: string

The user name assigned to the user account.


directoryUserId?

Type: string (optional)

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


hierarchyGroupArn?

Type: string (optional)

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


identityInfo?

Type: IResolvable | UserIdentityInfoProperty (optional)

Information about the user identity.


password?

Type: string (optional)

The user's password.


tags?

Type: CfnTag[] (optional)

The tags.