aws_sdk_elasticache/client/
modify_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 [`ModifyUser`](crate::operation::modify_user::builders::ModifyUserFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_id(impl Into<String>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::set_user_id):<br>required: **true**<br><p>The ID of the user.</p><br>
7    ///   - [`access_string(impl Into<String>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::access_string) / [`set_access_string(Option<String>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::set_access_string):<br>required: **false**<br><p>Access permissions string used for this user.</p><br>
8    ///   - [`append_access_string(impl Into<String>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::append_access_string) / [`set_append_access_string(Option<String>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::set_append_access_string):<br>required: **false**<br><p>Adds additional user permissions to the access string.</p><br>
9    ///   - [`passwords(impl Into<String>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::passwords) / [`set_passwords(Option<Vec::<String>>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::set_passwords):<br>required: **false**<br><p>The passwords belonging to the user. You are allowed up to two.</p><br>
10    ///   - [`no_password_required(bool)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::no_password_required) / [`set_no_password_required(Option<bool>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::set_no_password_required):<br>required: **false**<br><p>Indicates no password is required for the user.</p><br>
11    ///   - [`authentication_mode(AuthenticationMode)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::authentication_mode) / [`set_authentication_mode(Option<AuthenticationMode>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::set_authentication_mode):<br>required: **false**<br><p>Specifies how to authenticate the user.</p><br>
12    ///   - [`engine(impl Into<String>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::engine) / [`set_engine(Option<String>)`](crate::operation::modify_user::builders::ModifyUserFluentBuilder::set_engine):<br>required: **false**<br><p>Modifies the engine listed for a user. The options are valkey or redis.</p><br>
13    /// - On success, responds with [`ModifyUserOutput`](crate::operation::modify_user::ModifyUserOutput) with field(s):
14    ///   - [`user_id(Option<String>)`](crate::operation::modify_user::ModifyUserOutput::user_id): <p>The ID of the user.</p>
15    ///   - [`user_name(Option<String>)`](crate::operation::modify_user::ModifyUserOutput::user_name): <p>The username of the user.</p>
16    ///   - [`status(Option<String>)`](crate::operation::modify_user::ModifyUserOutput::status): <p>Indicates the user status. Can be "active", "modifying" or "deleting".</p>
17    ///   - [`engine(Option<String>)`](crate::operation::modify_user::ModifyUserOutput::engine): <p>The options are valkey or redis.</p>
18    ///   - [`minimum_engine_version(Option<String>)`](crate::operation::modify_user::ModifyUserOutput::minimum_engine_version): <p>The minimum engine version required, which is Redis OSS 6.0</p>
19    ///   - [`access_string(Option<String>)`](crate::operation::modify_user::ModifyUserOutput::access_string): <p>Access permissions string used for this user.</p>
20    ///   - [`user_group_ids(Option<Vec::<String>>)`](crate::operation::modify_user::ModifyUserOutput::user_group_ids): <p>Returns a list of the user group IDs the user belongs to.</p>
21    ///   - [`authentication(Option<Authentication>)`](crate::operation::modify_user::ModifyUserOutput::authentication): <p>Denotes whether the user requires a password to authenticate.</p>
22    ///   - [`arn(Option<String>)`](crate::operation::modify_user::ModifyUserOutput::arn): <p>The Amazon Resource Name (ARN) of the user.</p>
23    /// - On failure, responds with [`SdkError<ModifyUserError>`](crate::operation::modify_user::ModifyUserError)
24    pub fn modify_user(&self) -> crate::operation::modify_user::builders::ModifyUserFluentBuilder {
25        crate::operation::modify_user::builders::ModifyUserFluentBuilder::new(self.handle.clone())
26    }
27}
aws_sdk_elasticache/client/modify_user.rs

aws_sdk_elasticache/client/
modify_user.rs
