Struct aws_sdk_connect::operation::create_user::CreateUserInput
source · #[non_exhaustive]pub struct CreateUserInput {
pub username: Option<String>,
pub password: Option<String>,
pub identity_info: Option<UserIdentityInfo>,
pub phone_config: Option<UserPhoneConfig>,
pub directory_user_id: Option<String>,
pub security_profile_ids: Option<Vec<String>>,
pub routing_profile_id: Option<String>,
pub hierarchy_group_id: Option<String>,
pub instance_id: Option<String>,
pub tags: Option<HashMap<String, String>>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.username: Option<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_-.\@]+.
password: Option<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.
identity_info: Option<UserIdentityInfo>
The information about the identity of the user.
phone_config: Option<UserPhoneConfig>
The phone settings for the user.
directory_user_id: Option<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.
security_profile_ids: Option<Vec<String>>
The identifier of the security profile for the user.
routing_profile_id: Option<String>
The identifier of the routing profile for the user.
hierarchy_group_id: Option<String>
The identifier of the hierarchy group for the user.
instance_id: Option<String>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Implementations§
source§impl CreateUserInput
impl CreateUserInput
sourcepub fn username(&self) -> Option<&str>
pub fn username(&self) -> Option<&str>
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_-.\@]+.
sourcepub fn password(&self) -> Option<&str>
pub fn password(&self) -> Option<&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.
sourcepub fn identity_info(&self) -> Option<&UserIdentityInfo>
pub fn identity_info(&self) -> Option<&UserIdentityInfo>
The information about the identity of the user.
sourcepub fn phone_config(&self) -> Option<&UserPhoneConfig>
pub fn phone_config(&self) -> Option<&UserPhoneConfig>
The phone settings for the user.
sourcepub fn directory_user_id(&self) -> Option<&str>
pub fn directory_user_id(&self) -> Option<&str>
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.
sourcepub fn security_profile_ids(&self) -> &[String]
pub fn security_profile_ids(&self) -> &[String]
The identifier of the security profile for the user.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_profile_ids.is_none()
.
sourcepub fn routing_profile_id(&self) -> Option<&str>
pub fn routing_profile_id(&self) -> Option<&str>
The identifier of the routing profile for the user.
sourcepub fn hierarchy_group_id(&self) -> Option<&str>
pub fn hierarchy_group_id(&self) -> Option<&str>
The identifier of the hierarchy group for the user.
sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
source§impl CreateUserInput
impl CreateUserInput
sourcepub fn builder() -> CreateUserInputBuilder
pub fn builder() -> CreateUserInputBuilder
Creates a new builder-style object to manufacture CreateUserInput
.
Trait Implementations§
source§impl Clone for CreateUserInput
impl Clone for CreateUserInput
source§fn clone(&self) -> CreateUserInput
fn clone(&self) -> CreateUserInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateUserInput
impl Debug for CreateUserInput
source§impl PartialEq for CreateUserInput
impl PartialEq for CreateUserInput
source§fn eq(&self, other: &CreateUserInput) -> bool
fn eq(&self, other: &CreateUserInput) -> bool
self
and other
values to be equal, and is used
by ==
.