AWS Native

v0.43.0 published on Thursday, Dec 1, 2022 by Pulumi

User

Resource Type definition for AWS::Connect::User

Create User Resource

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         directory_user_id: Optional[str] = None,
         hierarchy_group_arn: Optional[str] = None,
         identity_info: Optional[UserIdentityInfoArgs] = None,
         instance_arn: Optional[str] = None,
         password: Optional[str] = None,
         phone_config: Optional[UserPhoneConfigArgs] = None,
         routing_profile_arn: Optional[str] = None,
         security_profile_arns: Optional[Sequence[str]] = None,
         tags: Optional[Sequence[UserTagArgs]] = None,
         username: Optional[str] = None)
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = 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.

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

The User resource accepts the following input properties:

InstanceArn string

The identifier of the Amazon Connect instance.

PhoneConfig Pulumi.AwsNative.Connect.Inputs.UserPhoneConfigArgs

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

Username string

The user name for the account.

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.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 List<Pulumi.AwsNative.Connect.Inputs.UserTagArgs>

One or more tags.

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

Username string

The user name for the account.

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 []UserTagArgs

One or more tags.

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 List<String>

One or more security profile arns for the user

username String

The user name for the account.

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 List<UserTagArgs>

One or more tags.

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

username string

The user name for the account.

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 UserTagArgs[]

One or more tags.

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

username str

The user name for the account.

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[UserTagArgs]

One or more tags.

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

username String

The user name for the account.

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.

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

UserIdentityInfo

Email string
FirstName string
LastName string
Mobile string
SecondaryEmail string
Email string
FirstName string
LastName string
Mobile string
SecondaryEmail string
email String
firstName String
lastName String
mobile String
secondaryEmail String
email string
firstName string
lastName string
mobile string
secondaryEmail string
email String
firstName String
lastName String
mobile String
secondaryEmail String

UserPhoneConfig

UserPhoneType

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

UserTag

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0