AWS Native is in preview. AWS Classic is fully supported.
aws-native.connect.User
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource Type definition for AWS::Connect::User
Create User Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
args: UserArgs,
opts: Optional[ResourceOptions] = None)
@overload
def User(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_arn: Optional[str] = None,
phone_config: Optional[UserPhoneConfigArgs] = None,
routing_profile_arn: Optional[str] = None,
security_profile_arns: Optional[Sequence[str]] = None,
directory_user_id: Optional[str] = None,
hierarchy_group_arn: Optional[str] = None,
identity_info: Optional[UserIdentityInfoArgs] = None,
password: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
user_proficiencies: Optional[Sequence[UserProficiencyArgs]] = None,
username: Optional[str] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
type: aws-native:connect:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const userResource = new aws_native.connect.User("userResource", {
instanceArn: "string",
phoneConfig: {
phoneType: aws_native.connect.UserPhoneType.SoftPhone,
afterContactWorkTimeLimit: 0,
autoAccept: false,
deskPhoneNumber: "string",
},
routingProfileArn: "string",
securityProfileArns: ["string"],
directoryUserId: "string",
hierarchyGroupArn: "string",
identityInfo: {
email: "string",
firstName: "string",
lastName: "string",
mobile: "string",
secondaryEmail: "string",
},
password: "string",
tags: [{
key: "string",
value: "string",
}],
userProficiencies: [{
attributeName: "string",
attributeValue: "string",
level: 0,
}],
username: "string",
});
Coming soon!
User Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The User resource accepts the following input properties:
- Instance
Arn string - The identifier of the Amazon Connect instance.
- Phone
Config Pulumi.Aws Native. Connect. Inputs. User Phone Config - The phone settings for the user.
- Routing
Profile stringArn - The identifier of the routing profile for the user.
- Security
Profile List<string>Arns - One or more security profile arns for the user
- Directory
User stringId - The identifier of the user account in the directory used for identity management.
- Hierarchy
Group stringArn - The identifier of the hierarchy group for the user.
- Identity
Info Pulumi.Aws Native. Connect. Inputs. User Identity Info - The information about the identity of the user.
- 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.
- List<Pulumi.
Aws Native. Inputs. Tag> - One or more tags.
- User
Proficiencies List<Pulumi.Aws Native. Connect. Inputs. User Proficiency> - One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
- Username string
- The user name for the account.
- Instance
Arn string - The identifier of the Amazon Connect instance.
- Phone
Config UserPhone Config Args - The phone settings for the user.
- Routing
Profile stringArn - The identifier of the routing profile for the user.
- Security
Profile []stringArns - One or more security profile arns for the user
- Directory
User stringId - The identifier of the user account in the directory used for identity management.
- Hierarchy
Group stringArn - The identifier of the hierarchy group for the user.
- Identity
Info UserIdentity Info Args - The information about the identity of the user.
- 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.
- Tag
Args - One or more tags.
- User
Proficiencies []UserProficiency Args - One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
- Username string
- The user name for the account.
- instance
Arn String - The identifier of the Amazon Connect instance.
- phone
Config UserPhone Config - The phone settings for the user.
- routing
Profile StringArn - The identifier of the routing profile for the user.
- security
Profile List<String>Arns - One or more security profile arns for the user
- directory
User StringId - The identifier of the user account in the directory used for identity management.
- hierarchy
Group StringArn - The identifier of the hierarchy group for the user.
- identity
Info UserIdentity Info - The information about the identity of the user.
- 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.
- List<Tag>
- One or more tags.
- user
Proficiencies List<UserProficiency> - One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
- username String
- The user name for the account.
- instance
Arn string - The identifier of the Amazon Connect instance.
- phone
Config UserPhone Config - The phone settings for the user.
- routing
Profile stringArn - The identifier of the routing profile for the user.
- security
Profile string[]Arns - One or more security profile arns for the user
- directory
User stringId - The identifier of the user account in the directory used for identity management.
- hierarchy
Group stringArn - The identifier of the hierarchy group for the user.
- identity
Info UserIdentity Info - The information about the identity of the user.
- 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.
- Tag[]
- One or more tags.
- user
Proficiencies UserProficiency[] - One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
- username string
- The user name for the account.
- instance_
arn str - The identifier of the Amazon Connect instance.
- phone_
config UserPhone Config Args - The phone settings for the user.
- routing_
profile_ strarn - The identifier of the routing profile for the user.
- security_
profile_ Sequence[str]arns - One or more security profile arns for the user
- directory_
user_ strid - The identifier of the user account in the directory used for identity management.
- hierarchy_
group_ strarn - The identifier of the hierarchy group for the user.
- identity_
info UserIdentity Info Args - The information about the identity of the user.
- password str
- 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.
- Sequence[Tag
Args] - One or more tags.
- user_
proficiencies Sequence[UserProficiency Args] - One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
- username str
- The user name for the account.
- instance
Arn String - The identifier of the Amazon Connect instance.
- phone
Config Property Map - The phone settings for the user.
- routing
Profile StringArn - The identifier of the routing profile for the user.
- security
Profile List<String>Arns - One or more security profile arns for the user
- directory
User StringId - The identifier of the user account in the directory used for identity management.
- hierarchy
Group StringArn - The identifier of the hierarchy group for the user.
- identity
Info Property Map - The information about the identity of the user.
- 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.
- List<Property Map>
- One or more tags.
- user
Proficiencies List<Property Map> - One or more predefined attributes assigned to a user, with a level that indicates how skilled they are.
- username String
- The user name for the account.
Outputs
All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:
Supporting Types
Tag, TagArgs
UserIdentityInfo, UserIdentityInfoArgs
- Email string
- First
Name string - Last
Name string - Mobile string
- Secondary
Email string
- Email string
- First
Name string - Last
Name string - Mobile string
- Secondary
Email string
- email String
- first
Name String - last
Name String - mobile String
- secondary
Email String
- email string
- first
Name string - last
Name string - mobile string
- secondary
Email string
- email str
- first_
name str - last_
name str - mobile str
- secondary_
email str
- email String
- first
Name String - last
Name String - mobile String
- secondary
Email String
UserPhoneConfig, UserPhoneConfigArgs
- phone
Type UserPhone Type - after
Contact IntegerWork Time Limit - auto
Accept Boolean - desk
Phone StringNumber
- phone
Type UserPhone Type - after
Contact numberWork Time Limit - auto
Accept boolean - desk
Phone stringNumber
- phone
Type "SOFT_PHONE" | "DESK_PHONE" - after
Contact NumberWork Time Limit - auto
Accept Boolean - desk
Phone StringNumber
UserPhoneType, UserPhoneTypeArgs
- Soft
Phone - SOFT_PHONE
- Desk
Phone - DESK_PHONE
- User
Phone Type Soft Phone - SOFT_PHONE
- User
Phone Type Desk Phone - DESK_PHONE
- Soft
Phone - SOFT_PHONE
- Desk
Phone - DESK_PHONE
- Soft
Phone - SOFT_PHONE
- Desk
Phone - DESK_PHONE
- SOFT_PHONE
- SOFT_PHONE
- DESK_PHONE
- DESK_PHONE
- "SOFT_PHONE"
- SOFT_PHONE
- "DESK_PHONE"
- DESK_PHONE
UserProficiency, UserProficiencyArgs
- Attribute
Name string - Attribute
Value string - Level double
- Attribute
Name string - Attribute
Value string - Level float64
- attribute
Name String - attribute
Value String - level Double
- attribute
Name string - attribute
Value string - level number
- attribute_
name str - attribute_
value str - level float
- attribute
Name String - attribute
Value String - level Number
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.