aws_sdk_elasticache/client/
modify_user_group.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 [`ModifyUserGroup`](crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_group_id(impl Into<String>)`](crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder::user_group_id) / [`set_user_group_id(Option<String>)`](crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder::set_user_group_id):<br>required: **true**<br><p>The ID of the user group.</p><br>
7    ///   - [`user_ids_to_add(impl Into<String>)`](crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder::user_ids_to_add) / [`set_user_ids_to_add(Option<Vec::<String>>)`](crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder::set_user_ids_to_add):<br>required: **false**<br><p>The list of user IDs to add to the user group.</p><br>
8    ///   - [`user_ids_to_remove(impl Into<String>)`](crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder::user_ids_to_remove) / [`set_user_ids_to_remove(Option<Vec::<String>>)`](crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder::set_user_ids_to_remove):<br>required: **false**<br><p>The list of user IDs to remove from the user group.</p><br>
9    ///   - [`engine(impl Into<String>)`](crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder::engine) / [`set_engine(Option<String>)`](crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder::set_engine):<br>required: **false**<br><p>Modifies the engine listed in a user group. The options are valkey or redis.</p><br>
10    /// - On success, responds with [`ModifyUserGroupOutput`](crate::operation::modify_user_group::ModifyUserGroupOutput) with field(s):
11    ///   - [`user_group_id(Option<String>)`](crate::operation::modify_user_group::ModifyUserGroupOutput::user_group_id): <p>The ID of the user group.</p>
12    ///   - [`status(Option<String>)`](crate::operation::modify_user_group::ModifyUserGroupOutput::status): <p>Indicates user group status. Can be "creating", "active", "modifying", "deleting".</p>
13    ///   - [`engine(Option<String>)`](crate::operation::modify_user_group::ModifyUserGroupOutput::engine): <p>The options are valkey or redis.</p>
14    ///   - [`user_ids(Option<Vec::<String>>)`](crate::operation::modify_user_group::ModifyUserGroupOutput::user_ids): <p>The list of user IDs that belong to the user group.</p>
15    ///   - [`minimum_engine_version(Option<String>)`](crate::operation::modify_user_group::ModifyUserGroupOutput::minimum_engine_version): <p>The minimum engine version required, which is Redis OSS 6.0</p>
16    ///   - [`pending_changes(Option<UserGroupPendingChanges>)`](crate::operation::modify_user_group::ModifyUserGroupOutput::pending_changes): <p>A list of updates being applied to the user group.</p>
17    ///   - [`replication_groups(Option<Vec::<String>>)`](crate::operation::modify_user_group::ModifyUserGroupOutput::replication_groups): <p>A list of replication groups that the user group can access.</p>
18    ///   - [`serverless_caches(Option<Vec::<String>>)`](crate::operation::modify_user_group::ModifyUserGroupOutput::serverless_caches): <p>Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
19    ///   - [`arn(Option<String>)`](crate::operation::modify_user_group::ModifyUserGroupOutput::arn): <p>The Amazon Resource Name (ARN) of the user group.</p>
20    /// - On failure, responds with [`SdkError<ModifyUserGroupError>`](crate::operation::modify_user_group::ModifyUserGroupError)
21    pub fn modify_user_group(&self) -> crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder {
22        crate::operation::modify_user_group::builders::ModifyUserGroupFluentBuilder::new(self.handle.clone())
23    }
24}
aws_sdk_elasticache/client/modify_user_group.rs

aws_sdk_elasticache/client/
modify_user_group.rs
