aws_sdk_elasticache/client/
create_user.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateUser`](crate::operation::create_user::builders::CreateUserFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_id(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_user_id):<br>required: **true**<br><p>The ID of the user.</p><br>
7    ///   - [`user_name(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::user_name) / [`set_user_name(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_user_name):<br>required: **true**<br><p>The username of the user.</p><br>
8    ///   - [`engine(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::engine) / [`set_engine(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_engine):<br>required: **true**<br><p>The options are valkey or redis.</p><br>
9    ///   - [`passwords(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::passwords) / [`set_passwords(Option<Vec::<String>>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_passwords):<br>required: **false**<br><p>Passwords used for this user. You can create up to two passwords for each user.</p><br>
10    ///   - [`access_string(impl Into<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::access_string) / [`set_access_string(Option<String>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_access_string):<br>required: **true**<br><p>Access permissions string used for this user.</p><br>
11    ///   - [`no_password_required(bool)`](crate::operation::create_user::builders::CreateUserFluentBuilder::no_password_required) / [`set_no_password_required(Option<bool>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_no_password_required):<br>required: **false**<br><p>Indicates a password is not required for this user.</p><br>
12    ///   - [`tags(Tag)`](crate::operation::create_user::builders::CreateUserFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_tags):<br>required: **false**<br><p>A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.</p><br>
13    ///   - [`authentication_mode(AuthenticationMode)`](crate::operation::create_user::builders::CreateUserFluentBuilder::authentication_mode) / [`set_authentication_mode(Option<AuthenticationMode>)`](crate::operation::create_user::builders::CreateUserFluentBuilder::set_authentication_mode):<br>required: **false**<br><p>Specifies how to authenticate the user.</p><br>
14    /// - On success, responds with [`CreateUserOutput`](crate::operation::create_user::CreateUserOutput) with field(s):
15    ///   - [`user_id(Option<String>)`](crate::operation::create_user::CreateUserOutput::user_id): <p>The ID of the user.</p>
16    ///   - [`user_name(Option<String>)`](crate::operation::create_user::CreateUserOutput::user_name): <p>The username of the user.</p>
17    ///   - [`status(Option<String>)`](crate::operation::create_user::CreateUserOutput::status): <p>Indicates the user status. Can be "active", "modifying" or "deleting".</p>
18    ///   - [`engine(Option<String>)`](crate::operation::create_user::CreateUserOutput::engine): <p>The options are valkey or redis.</p>
19    ///   - [`minimum_engine_version(Option<String>)`](crate::operation::create_user::CreateUserOutput::minimum_engine_version): <p>The minimum engine version required, which is Redis OSS 6.0</p>
20    ///   - [`access_string(Option<String>)`](crate::operation::create_user::CreateUserOutput::access_string): <p>Access permissions string used for this user.</p>
21    ///   - [`user_group_ids(Option<Vec::<String>>)`](crate::operation::create_user::CreateUserOutput::user_group_ids): <p>Returns a list of the user group IDs the user belongs to.</p>
22    ///   - [`authentication(Option<Authentication>)`](crate::operation::create_user::CreateUserOutput::authentication): <p>Denotes whether the user requires a password to authenticate.</p>
23    ///   - [`arn(Option<String>)`](crate::operation::create_user::CreateUserOutput::arn): <p>The Amazon Resource Name (ARN) of the user.</p>
24    /// - On failure, responds with [`SdkError<CreateUserError>`](crate::operation::create_user::CreateUserError)
25    pub fn create_user(&self) -> crate::operation::create_user::builders::CreateUserFluentBuilder {
26        crate::operation::create_user::builders::CreateUserFluentBuilder::new(self.handle.clone())
27    }
28}
aws_sdk_elasticache/client/create_user.rs

aws_sdk_elasticache/client/
create_user.rs
