UserState class

Input properties used for looking up and filtering User resources.

Constructors

UserState({Input<String?>? arn, Input<String?>? directoryUserId, Input<String?>? hierarchyGroupId, Input<UserIdentityInfo?>? identityInfo, Input<String?>? instanceId, Input<String?>? name, Input<String?>? password, Input<UserPhoneConfig?>? phoneConfig, Input<String?>? region, Input<String?>? routingProfileId, Input<List<String>?>? securityProfileIds, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? userId})
Creates a new UserState. arn ARN of the user. directoryUserId The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory. This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned. hierarchyGroupId The identifier of the hierarchy group for the user. identityInfo A block that contains information about the identity of the user. Documented below. instanceId Specifies the identifier of the hosting Amazon Connect Instance. name The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+. password 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. phoneConfig A block that contains information about the phone settings for the user. Documented below. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. routingProfileId The identifier of the routing profile for the user. securityProfileIds A list of identifiers for the security profiles for the user. Specify a minimum of 1 and maximum of 10 security profile ids. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide. tags Tags to apply to the user. If configured with a provider tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. userId The identifier for the user.
const
UserState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the user.
final
directoryUserId → Input<String?>?
The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory. This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.
final
hashCode → int
The hash code for this object.
no setterinherited
hierarchyGroupId → Input<String?>?
The identifier of the hierarchy group for the user.
final
identityInfo → Input<UserIdentityInfo?>?
A block that contains information about the identity of the user. Documented below.
final
instanceId → Input<String?>?
Specifies the identifier of the hosting Amazon Connect Instance.
final
name → Input<String?>?
The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.
final
password → Input<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.
final
phoneConfig → Input<UserPhoneConfig?>?
A block that contains information about the phone settings for the user. Documented below.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
routingProfileId → Input<String?>?
The identifier of the routing profile for the user.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityProfileIds → Input<List<String>?>?
A list of identifiers for the security profiles for the user. Specify a minimum of 1 and maximum of 10 security profile ids. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
final
tags → Input<Map<String, String>?>?
Tags to apply to the user. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
userId → Input<String?>?
The identifier for the user.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited