AWS::Connect::User - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Connect::User

Specifies a user account for an Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Connect::User",
  "Properties" : {
      "DirectoryUserId" : String,
      "HierarchyGroupArn" : String,
      "IdentityInfo" : UserIdentityInfo,
      "InstanceArn" : String,
      "Password" : String,
      "PhoneConfig" : UserPhoneConfig,
      "RoutingProfileArn" : String,
      "SecurityProfileArns" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "Username" : String
    }
}

YAML

Type: AWS::Connect::User
Properties: 
  DirectoryUserId: String
  HierarchyGroupArn: String
  IdentityInfo: 
    UserIdentityInfo
  InstanceArn: String
  Password: String
  PhoneConfig: 
    UserPhoneConfig
  RoutingProfileArn: String
  SecurityProfileArns: 
    - String
  Tags: 
    - Tag
  Username: String

Properties

DirectoryUserId

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

Required: No

Type: String

Update requires: No interruption

HierarchyGroupArn

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

Required: No

Type: String

Update requires: No interruption

IdentityInfo

Information about the user identity.

Required: No

Type: UserIdentityInfo

Update requires: No interruption

InstanceArn

The Amazon Resource Name (ARN) of the instance.

Required: Yes

Type: String

Update requires: No interruption

Password

The user's password.

Required: No

Type: String

Update requires: No interruption

PhoneConfig

Information about the phone configuration for the user.

Required: Yes

Type: UserPhoneConfig

Update requires: No interruption

RoutingProfileArn

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

Required: Yes

Type: String

Update requires: No interruption

SecurityProfileArns

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

Required: Yes

Type: List of String

Update requires: No interruption

Tags

The tags.

Required: No

Type: List of Tag

Update requires: No interruption

Username

The user name assigned to the user account.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the user. For example:

{ "Ref": "myUser" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

UserArn

The Amazon Resource Name (ARN) of the user.

Examples

Specify a user resource

The following example specifies a user resource for an Amazon Connect instance. This example specifies a user under an Amazon Connect instance. We recommend using a dynamic reference to specify a password value or mask the parameter with NoEcho.

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: Specifies a user for an Amazon Connect instance
Resources:
    User:
      Type: 'AWS::Connect::User'
      Properties:
        IdentityInfo:
          FirstName: 'firstname'
          LastName: 'lastname'
          Email: 'example@email.com'
        PhoneConfig:
          PhoneType: 'DESK_PHONE'
          AutoAccept: true
          DeskPhoneNumber: '+12345678902'
          AfterContactWorkTimeLimit: 10
        Username: 'exampleuser'
        InstanceArn: 'arn:aws:connect:region-name:aws-account-id:instance/instance-arn'
        RoutingProfileArn: 'arn:aws:connect:region-name:aws-account-id:instance/instance-arn/routing-profile/routing-arn'
        SecurityProfileArns: [arn:aws:connect:region-name:aws-account-id:instance/instance-arn/security-profile/security-arn]
        Password: !Ref password
        Tags:
          - Key: 'tagKey'
            Value: 'tagValue'