Struct aws_sdk_connect::operation::create_user::builders::CreateUserFluentBuilder

pub struct CreateUserFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateUser.

Creates a user account for the specified Amazon Connect instance.

Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.

Implementations

impl CreateUserFluentBuilder

pub fn as_input(&self) -> &CreateUserInputBuilder

Access the CreateUser as a reference.

pub async fn send( self ) -> Result<CreateUserOutput, SdkError<CreateUserError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateUserOutput, CreateUserError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn username(self, input: impl Into<String>) -> Self

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

pub fn set_username(self, input: Option<String>) -> Self

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

pub fn get_username(&self) -> &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_-.\@]+.

pub fn password(self, input: impl Into<String>) -> Self

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 set_password(self, input: Option<String>) -> Self

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 get_password(&self) -> &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.

pub fn identity_info(self, input: UserIdentityInfo) -> Self

The information about the identity of the user.

pub fn set_identity_info(self, input: Option<UserIdentityInfo>) -> Self

The information about the identity of the user.

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

The information about the identity of the user.

pub fn phone_config(self, input: UserPhoneConfig) -> Self

The phone settings for the user.

pub fn set_phone_config(self, input: Option<UserPhoneConfig>) -> Self

The phone settings for the user.

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

The phone settings for the user.

pub fn directory_user_id(self, input: impl Into<String>) -> Self

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 set_directory_user_id(self, input: Option<String>) -> Self

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 get_directory_user_id(&self) -> &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.

pub fn security_profile_ids(self, input: impl Into<String>) -> Self

Appends an item to SecurityProfileIds.

To override the contents of this collection use set_security_profile_ids.

The identifier of the security profile for the user.

pub fn set_security_profile_ids(self, input: Option<Vec<String>>) -> Self

The identifier of the security profile for the user.

pub fn get_security_profile_ids(&self) -> &Option<Vec<String>>

The identifier of the security profile for the user.

pub fn routing_profile_id(self, input: impl Into<String>) -> Self

The identifier of the routing profile for the user.

pub fn set_routing_profile_id(self, input: Option<String>) -> Self

The identifier of the routing profile for the user.

pub fn get_routing_profile_id(&self) -> &Option<String>

The identifier of the routing profile for the user.

pub fn hierarchy_group_id(self, input: impl Into<String>) -> Self

The identifier of the hierarchy group for the user.

pub fn set_hierarchy_group_id(self, input: Option<String>) -> Self

The identifier of the hierarchy group for the user.

pub fn get_hierarchy_group_id(&self) -> &Option<String>

The identifier of the hierarchy group for the user.

pub fn instance_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

pub fn set_instance_id(self, input: Option<String>) -> Self

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

pub fn get_instance_id(&self) -> &Option<String>

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, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Tags.

To override the contents of this collection use set_tags.

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

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

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

pub fn get_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"} }.

Trait Implementations

impl Clone for CreateUserFluentBuilder

fn clone(&self) -> CreateUserFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateUserFluentBuilder

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

Formats the value using the given formatter.