aws-sdk-elasticache 1.110.0

AWS SDK for Amazon ElastiCache
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ModifyUserInput {
    /// <p>The ID of the user.</p>
    pub user_id: ::std::option::Option<::std::string::String>,
    /// <p>Access permissions string used for this user.</p>
    pub access_string: ::std::option::Option<::std::string::String>,
    /// <p>Adds additional user permissions to the access string.</p>
    pub append_access_string: ::std::option::Option<::std::string::String>,
    /// <p>The passwords belonging to the user. You are allowed up to two.</p>
    pub passwords: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>Indicates no password is required for the user.</p>
    pub no_password_required: ::std::option::Option<bool>,
    /// <p>Specifies how to authenticate the user.</p>
    pub authentication_mode: ::std::option::Option<crate::types::AuthenticationMode>,
    /// <p>Modifies the engine listed for a user. The options are valkey or redis.</p>
    pub engine: ::std::option::Option<::std::string::String>,
}
impl ModifyUserInput {
    /// <p>The ID of the user.</p>
    pub fn user_id(&self) -> ::std::option::Option<&str> {
        self.user_id.as_deref()
    }
    /// <p>Access permissions string used for this user.</p>
    pub fn access_string(&self) -> ::std::option::Option<&str> {
        self.access_string.as_deref()
    }
    /// <p>Adds additional user permissions to the access string.</p>
    pub fn append_access_string(&self) -> ::std::option::Option<&str> {
        self.append_access_string.as_deref()
    }
    /// <p>The passwords belonging to the user. You are allowed up to two.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.passwords.is_none()`.
    pub fn passwords(&self) -> &[::std::string::String] {
        self.passwords.as_deref().unwrap_or_default()
    }
    /// <p>Indicates no password is required for the user.</p>
    pub fn no_password_required(&self) -> ::std::option::Option<bool> {
        self.no_password_required
    }
    /// <p>Specifies how to authenticate the user.</p>
    pub fn authentication_mode(&self) -> ::std::option::Option<&crate::types::AuthenticationMode> {
        self.authentication_mode.as_ref()
    }
    /// <p>Modifies the engine listed for a user. The options are valkey or redis.</p>
    pub fn engine(&self) -> ::std::option::Option<&str> {
        self.engine.as_deref()
    }
}
impl ModifyUserInput {
    /// Creates a new builder-style object to manufacture [`ModifyUserInput`](crate::operation::modify_user::ModifyUserInput).
    pub fn builder() -> crate::operation::modify_user::builders::ModifyUserInputBuilder {
        crate::operation::modify_user::builders::ModifyUserInputBuilder::default()
    }
}

/// A builder for [`ModifyUserInput`](crate::operation::modify_user::ModifyUserInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ModifyUserInputBuilder {
    pub(crate) user_id: ::std::option::Option<::std::string::String>,
    pub(crate) access_string: ::std::option::Option<::std::string::String>,
    pub(crate) append_access_string: ::std::option::Option<::std::string::String>,
    pub(crate) passwords: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) no_password_required: ::std::option::Option<bool>,
    pub(crate) authentication_mode: ::std::option::Option<crate::types::AuthenticationMode>,
    pub(crate) engine: ::std::option::Option<::std::string::String>,
}
impl ModifyUserInputBuilder {
    /// <p>The ID of the user.</p>
    /// This field is required.
    pub fn user_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.user_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the user.</p>
    pub fn set_user_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.user_id = input;
        self
    }
    /// <p>The ID of the user.</p>
    pub fn get_user_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.user_id
    }
    /// <p>Access permissions string used for this user.</p>
    pub fn access_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.access_string = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Access permissions string used for this user.</p>
    pub fn set_access_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.access_string = input;
        self
    }
    /// <p>Access permissions string used for this user.</p>
    pub fn get_access_string(&self) -> &::std::option::Option<::std::string::String> {
        &self.access_string
    }
    /// <p>Adds additional user permissions to the access string.</p>
    pub fn append_access_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.append_access_string = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Adds additional user permissions to the access string.</p>
    pub fn set_append_access_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.append_access_string = input;
        self
    }
    /// <p>Adds additional user permissions to the access string.</p>
    pub fn get_append_access_string(&self) -> &::std::option::Option<::std::string::String> {
        &self.append_access_string
    }
    /// Appends an item to `passwords`.
    ///
    /// To override the contents of this collection use [`set_passwords`](Self::set_passwords).
    ///
    /// <p>The passwords belonging to the user. You are allowed up to two.</p>
    pub fn passwords(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.passwords.unwrap_or_default();
        v.push(input.into());
        self.passwords = ::std::option::Option::Some(v);
        self
    }
    /// <p>The passwords belonging to the user. You are allowed up to two.</p>
    pub fn set_passwords(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.passwords = input;
        self
    }
    /// <p>The passwords belonging to the user. You are allowed up to two.</p>
    pub fn get_passwords(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.passwords
    }
    /// <p>Indicates no password is required for the user.</p>
    pub fn no_password_required(mut self, input: bool) -> Self {
        self.no_password_required = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates no password is required for the user.</p>
    pub fn set_no_password_required(mut self, input: ::std::option::Option<bool>) -> Self {
        self.no_password_required = input;
        self
    }
    /// <p>Indicates no password is required for the user.</p>
    pub fn get_no_password_required(&self) -> &::std::option::Option<bool> {
        &self.no_password_required
    }
    /// <p>Specifies how to authenticate the user.</p>
    pub fn authentication_mode(mut self, input: crate::types::AuthenticationMode) -> Self {
        self.authentication_mode = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies how to authenticate the user.</p>
    pub fn set_authentication_mode(mut self, input: ::std::option::Option<crate::types::AuthenticationMode>) -> Self {
        self.authentication_mode = input;
        self
    }
    /// <p>Specifies how to authenticate the user.</p>
    pub fn get_authentication_mode(&self) -> &::std::option::Option<crate::types::AuthenticationMode> {
        &self.authentication_mode
    }
    /// <p>Modifies the engine listed for a user. The options are valkey or redis.</p>
    pub fn engine(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.engine = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Modifies the engine listed for a user. The options are valkey or redis.</p>
    pub fn set_engine(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.engine = input;
        self
    }
    /// <p>Modifies the engine listed for a user. The options are valkey or redis.</p>
    pub fn get_engine(&self) -> &::std::option::Option<::std::string::String> {
        &self.engine
    }
    /// Consumes the builder and constructs a [`ModifyUserInput`](crate::operation::modify_user::ModifyUserInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::modify_user::ModifyUserInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::modify_user::ModifyUserInput {
            user_id: self.user_id,
            access_string: self.access_string,
            append_access_string: self.append_access_string,
            passwords: self.passwords,
            no_password_required: self.no_password_required,
            authentication_mode: self.authentication_mode,
            engine: self.engine,
        })
    }
}