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< ? securityProfileIds, Input<String> ?>Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? userId}) -
Creates a new UserState.
arnARN of the user.directoryUserIdThe 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.hierarchyGroupIdThe identifier of the hierarchy group for the user.identityInfoA block that contains information about the identity of the user. Documented below.instanceIdSpecifies the identifier of the hosting Amazon Connect Instance.nameThe 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_-.\@]+.passwordThe 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.phoneConfigA block that contains information about the phone settings for the user. Documented below.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.routingProfileIdThe identifier of the routing profile for the user.securityProfileIdsA 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.tagsTags to apply to the user. If configured with a providertagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.userIdThe 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 to apply to the user. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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