Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. connect
  5. User

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.User

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    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)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    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.

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The User resource accepts the following input properties:

    InstanceArn string
    The identifier of the Amazon Connect instance.
    PhoneConfig Pulumi.AwsNative.Connect.Inputs.UserPhoneConfig
    The phone settings for the user.
    RoutingProfileArn string
    The identifier of the routing profile for the user.
    SecurityProfileArns List<string>
    One or more security profile arns for the user
    DirectoryUserId string
    The identifier of the user account in the directory used for identity management.
    HierarchyGroupArn string
    The identifier of the hierarchy group for the user.
    IdentityInfo Pulumi.AwsNative.Connect.Inputs.UserIdentityInfo
    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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    One or more tags.
    UserProficiencies List<Pulumi.AwsNative.Connect.Inputs.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.
    InstanceArn string
    The identifier of the Amazon Connect instance.
    PhoneConfig UserPhoneConfigArgs
    The phone settings for the user.
    RoutingProfileArn string
    The identifier of the routing profile for the user.
    SecurityProfileArns []string
    One or more security profile arns for the user
    DirectoryUserId string
    The identifier of the user account in the directory used for identity management.
    HierarchyGroupArn string
    The identifier of the hierarchy group for the user.
    IdentityInfo UserIdentityInfoArgs
    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.
    Tags TagArgs
    One or more tags.
    UserProficiencies []UserProficiencyArgs
    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.
    instanceArn String
    The identifier of the Amazon Connect instance.
    phoneConfig UserPhoneConfig
    The phone settings for the user.
    routingProfileArn String
    The identifier of the routing profile for the user.
    securityProfileArns List<String>
    One or more security profile arns for the user
    directoryUserId String
    The identifier of the user account in the directory used for identity management.
    hierarchyGroupArn String
    The identifier of the hierarchy group for the user.
    identityInfo UserIdentityInfo
    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.
    tags List<Tag>
    One or more tags.
    userProficiencies 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.
    instanceArn string
    The identifier of the Amazon Connect instance.
    phoneConfig UserPhoneConfig
    The phone settings for the user.
    routingProfileArn string
    The identifier of the routing profile for the user.
    securityProfileArns string[]
    One or more security profile arns for the user
    directoryUserId string
    The identifier of the user account in the directory used for identity management.
    hierarchyGroupArn string
    The identifier of the hierarchy group for the user.
    identityInfo UserIdentityInfo
    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.
    tags Tag[]
    One or more tags.
    userProficiencies 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 UserPhoneConfigArgs
    The phone settings for the user.
    routing_profile_arn str
    The identifier of the routing profile for the user.
    security_profile_arns Sequence[str]
    One or more security profile arns for the user
    directory_user_id str
    The identifier of the user account in the directory used for identity management.
    hierarchy_group_arn str
    The identifier of the hierarchy group for the user.
    identity_info UserIdentityInfoArgs
    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.
    tags Sequence[TagArgs]
    One or more tags.
    user_proficiencies Sequence[UserProficiencyArgs]
    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.
    instanceArn String
    The identifier of the Amazon Connect instance.
    phoneConfig Property Map
    The phone settings for the user.
    routingProfileArn String
    The identifier of the routing profile for the user.
    securityProfileArns List<String>
    One or more security profile arns for the user
    directoryUserId String
    The identifier of the user account in the directory used for identity management.
    hierarchyGroupArn String
    The identifier of the hierarchy group for the user.
    identityInfo 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.
    tags List<Property Map>
    One or more tags.
    userProficiencies 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:

    Id string
    The provider-assigned unique ID for this managed resource.
    UserArn string
    The Amazon Resource Name (ARN) for the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserArn string
    The Amazon Resource Name (ARN) for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    userArn String
    The Amazon Resource Name (ARN) for the user.
    id string
    The provider-assigned unique ID for this managed resource.
    userArn string
    The Amazon Resource Name (ARN) for the user.
    id str
    The provider-assigned unique ID for this managed resource.
    user_arn str
    The Amazon Resource Name (ARN) for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    userArn String
    The Amazon Resource Name (ARN) for the user.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    UserIdentityInfo, UserIdentityInfoArgs

    Email string
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    FirstName string
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    LastName string
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    Mobile string
    The user's mobile number.
    SecondaryEmail string

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    Email string
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    FirstName string
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    LastName string
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    Mobile string
    The user's mobile number.
    SecondaryEmail string

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    email String
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    firstName String
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    lastName String
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    mobile String
    The user's mobile number.
    secondaryEmail String

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    email string
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    firstName string
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    lastName string
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    mobile string
    The user's mobile number.
    secondaryEmail string

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    email str
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    first_name str
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    last_name str
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    mobile str
    The user's mobile number.
    secondary_email str

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    email String
    The email address. If you are using SAML for identity management and include this parameter, an error is returned.
    firstName String
    The first name. This is required if you are using Amazon Connect or SAML for identity management.
    lastName String
    The last name. This is required if you are using Amazon Connect or SAML for identity management.
    mobile String
    The user's mobile number.
    secondaryEmail String

    The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

    Pattern : (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    UserPhoneConfig, UserPhoneConfigArgs

    PhoneType Pulumi.AwsNative.Connect.UserPhoneType
    The phone type.
    AfterContactWorkTimeLimit int

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    AutoAccept bool
    The Auto accept setting.
    DeskPhoneNumber string
    The phone number for the user's desk phone.
    PhoneType UserPhoneType
    The phone type.
    AfterContactWorkTimeLimit int

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    AutoAccept bool
    The Auto accept setting.
    DeskPhoneNumber string
    The phone number for the user's desk phone.
    phoneType UserPhoneType
    The phone type.
    afterContactWorkTimeLimit Integer

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    autoAccept Boolean
    The Auto accept setting.
    deskPhoneNumber String
    The phone number for the user's desk phone.
    phoneType UserPhoneType
    The phone type.
    afterContactWorkTimeLimit number

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    autoAccept boolean
    The Auto accept setting.
    deskPhoneNumber string
    The phone number for the user's desk phone.
    phone_type UserPhoneType
    The phone type.
    after_contact_work_time_limit int

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    auto_accept bool
    The Auto accept setting.
    desk_phone_number str
    The phone number for the user's desk phone.
    phoneType "SOFT_PHONE" | "DESK_PHONE"
    The phone type.
    afterContactWorkTimeLimit Number

    The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

    When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

    autoAccept Boolean
    The Auto accept setting.
    deskPhoneNumber String
    The phone number for the user's desk phone.

    UserPhoneType, UserPhoneTypeArgs

    SoftPhone
    SOFT_PHONE
    DeskPhone
    DESK_PHONE
    UserPhoneTypeSoftPhone
    SOFT_PHONE
    UserPhoneTypeDeskPhone
    DESK_PHONE
    SoftPhone
    SOFT_PHONE
    DeskPhone
    DESK_PHONE
    SoftPhone
    SOFT_PHONE
    DeskPhone
    DESK_PHONE
    SOFT_PHONE
    SOFT_PHONE
    DESK_PHONE
    DESK_PHONE
    "SOFT_PHONE"
    SOFT_PHONE
    "DESK_PHONE"
    DESK_PHONE

    UserProficiency, UserProficiencyArgs

    AttributeName string
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    AttributeValue string
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    Level double
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
    AttributeName string
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    AttributeValue string
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    Level float64
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
    attributeName String
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    attributeValue String
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    level Double
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
    attributeName string
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    attributeValue string
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    level number
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
    attribute_name str
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    attribute_value str
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    level float
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
    attributeName String
    The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance.
    attributeValue String
    The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance.
    level Number
    The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native