users

Creates, updates, deletes or gets a user resource or lists users in a region

Overview

Name	users
Type	Resource
Description	Resource Type definition for AWS::Connect::User
Id	aws.connect.users

Fields

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
directory_user_id	string	The identifier of the user account in the directory used for identity management.
hierarchy_group_arn	string	The identifier of the hierarchy group for the user.
username	string	The user name for the account.
password	string	The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
routing_profile_arn	string	The identifier of the routing profile for the user.
identity_info	object	The information about the identity of the user.
phone_config	object	The phone settings for the user.
security_profile_arns	array	One or more security profile arns for the user
user_arn	string	The Amazon Resource Name (ARN) for the user.
tags	array	One or more tags.
user_proficiencies	array	One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceArn, PhoneConfig, RoutingProfileArn, SecurityProfileArns, Username, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all users in a region.

SELECT
region,
instance_arn,
directory_user_id,
hierarchy_group_arn,
username,
password,
routing_profile_arn,
identity_info,
phone_config,
security_profile_arns,
user_arn,
tags,
user_proficiencies
FROM aws.connect.users
WHERE region = 'us-east-1';

Gets all properties from an individual user.

SELECT
region,
instance_arn,
directory_user_id,
hierarchy_group_arn,
username,
password,
routing_profile_arn,
identity_info,
phone_config,
security_profile_arns,
user_arn,
tags,
user_proficiencies
FROM aws.connect.users
WHERE region = 'us-east-1' AND data__Identifier = '<UserArn>';

INSERT example

Use the following StackQL query and manifest file to create a new user resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.connect.users (
 InstanceArn,
 Username,
 RoutingProfileArn,
 PhoneConfig,
 SecurityProfileArns,
 region
)
SELECT 
'{{ InstanceArn }}',
 '{{ Username }}',
 '{{ RoutingProfileArn }}',
 '{{ PhoneConfig }}',
 '{{ SecurityProfileArns }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.users (
 InstanceArn,
 DirectoryUserId,
 HierarchyGroupArn,
 Username,
 Password,
 RoutingProfileArn,
 IdentityInfo,
 PhoneConfig,
 SecurityProfileArns,
 Tags,
 UserProficiencies,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ DirectoryUserId }}',
 '{{ HierarchyGroupArn }}',
 '{{ Username }}',
 '{{ Password }}',
 '{{ RoutingProfileArn }}',
 '{{ IdentityInfo }}',
 '{{ PhoneConfig }}',
 '{{ SecurityProfileArns }}',
 '{{ Tags }}',
 '{{ UserProficiencies }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: DirectoryUserId
        value: '{{ DirectoryUserId }}'
      - name: HierarchyGroupArn
        value: '{{ HierarchyGroupArn }}'
      - name: Username
        value: '{{ Username }}'
      - name: Password
        value: '{{ Password }}'
      - name: RoutingProfileArn
        value: '{{ RoutingProfileArn }}'
      - name: IdentityInfo
        value:
          FirstName: '{{ FirstName }}'
          LastName: '{{ LastName }}'
          Email: '{{ Email }}'
          SecondaryEmail: '{{ SecondaryEmail }}'
          Mobile: '{{ Mobile }}'
      - name: PhoneConfig
        value:
          AfterContactWorkTimeLimit: '{{ AfterContactWorkTimeLimit }}'
          AutoAccept: '{{ AutoAccept }}'
          DeskPhoneNumber: '{{ DeskPhoneNumber }}'
          PhoneType: '{{ PhoneType }}'
      - name: SecurityProfileArns
        value:
          - '{{ SecurityProfileArns[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: UserProficiencies
        value:
          - AttributeName: '{{ AttributeName }}'
            AttributeValue: '{{ AttributeValue }}'
            Level: null

DELETE example

/*+ delete */
DELETE FROM aws.connect.users
WHERE data__Identifier = '<UserArn>'
AND region = 'us-east-1';

Permissions

To operate on the users resource, the following permissions are required:

Create

connect:CreateUser,
connect:TagResource,
connect:AssociateUserProficiencies

Read

connect:DescribeUser,
connect:ListUserProficiencies

Delete

connect:DeleteUser,
connect:UntagResource

Update

connect:UpdateUserIdentityInfo,
connect:UpdateUserPhoneConfig,
connect:UpdateUserRoutingProfile,
connect:UpdateUserSecurityProfiles,
connect:UpdateUserHierarchy,
connect:TagResource,
connect:UntagResource,
connect:AssociateUserProficiencies,
connect:DisassociateUserProficiencies,
connect:UpdateUserProficiencies

List

connect:ListUsers