Struct CreateUserInput

#[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)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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_-.\@\]+.

Username can include @ only if used in an email format. For example:

• Correct: testuser

• Correct: testuser@example.com

• Incorrect: testuser@example

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.

tags: Option<HashMap<String, String>>

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Implementations

impl CreateUserInput

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_-.\@\]+.

Username can include @ only if used in an email format. For example:

• Correct: testuser

• Correct: testuser@example.com

• Incorrect: testuser@example

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.

pub fn identity_info(&self) -> Option<&UserIdentityInfo>

The information about the identity of the user.

pub fn phone_config(&self) -> Option<&UserPhoneConfig>

The phone settings for the user.

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.

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().

pub fn routing_profile_id(&self) -> Option<&str>

The identifier of the routing profile for the user.

pub fn hierarchy_group_id(&self) -> Option<&str>

The identifier of the hierarchy group for the user.

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.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

impl CreateUserInput

pub fn builder() -> CreateUserInputBuilder

Creates a new builder-style object to manufacture CreateUserInput.

Trait Implementations

impl Clone for CreateUserInput

fn clone(&self) -> CreateUserInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateUserInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateUserInput

fn eq(&self, other: &CreateUserInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateUserInput