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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Detailed information about an individual parameter.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Parameter {
/// <p>Specifies the name of the parameter.</p>
pub parameter_name: ::std::option::Option<::std::string::String>,
/// <p>Specifies the value of the parameter. Must be one or more of the cluster parameter's <code>AllowedValues</code> in CSV format:</p>
/// <p>Valid values are:</p>
/// <ul>
/// <li>
/// <p><code>enabled</code>: The cluster accepts secure connections using TLS version 1.0 through 1.3.</p></li>
/// <li>
/// <p><code>disabled</code>: The cluster does not accept secure connections using TLS.</p></li>
/// <li>
/// <p><code>fips-140-3</code>: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.</p></li>
/// <li>
/// <p><code>tls1.2+</code>: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p></li>
/// <li>
/// <p><code>tls1.3+</code>: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p></li>
/// </ul>
pub parameter_value: ::std::option::Option<::std::string::String>,
/// <p>Provides a description of the parameter.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>Indicates the source of the parameter value.</p>
pub source: ::std::option::Option<::std::string::String>,
/// <p>Specifies the engine-specific parameters type.</p>
pub apply_type: ::std::option::Option<::std::string::String>,
/// <p>Specifies the valid data type for the parameter.</p>
pub data_type: ::std::option::Option<::std::string::String>,
/// <p>Specifies the valid range of values for the parameter.</p>
pub allowed_values: ::std::option::Option<::std::string::String>,
/// <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.</p>
pub is_modifiable: ::std::option::Option<bool>,
/// <p>The earliest engine version to which the parameter can apply.</p>
pub minimum_engine_version: ::std::option::Option<::std::string::String>,
/// <p>Indicates when to apply parameter updates.</p>
pub apply_method: ::std::option::Option<crate::types::ApplyMethod>,
}
impl Parameter {
/// <p>Specifies the name of the parameter.</p>
pub fn parameter_name(&self) -> ::std::option::Option<&str> {
self.parameter_name.as_deref()
}
/// <p>Specifies the value of the parameter. Must be one or more of the cluster parameter's <code>AllowedValues</code> in CSV format:</p>
/// <p>Valid values are:</p>
/// <ul>
/// <li>
/// <p><code>enabled</code>: The cluster accepts secure connections using TLS version 1.0 through 1.3.</p></li>
/// <li>
/// <p><code>disabled</code>: The cluster does not accept secure connections using TLS.</p></li>
/// <li>
/// <p><code>fips-140-3</code>: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.</p></li>
/// <li>
/// <p><code>tls1.2+</code>: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p></li>
/// <li>
/// <p><code>tls1.3+</code>: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p></li>
/// </ul>
pub fn parameter_value(&self) -> ::std::option::Option<&str> {
self.parameter_value.as_deref()
}
/// <p>Provides a description of the parameter.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>Indicates the source of the parameter value.</p>
pub fn source(&self) -> ::std::option::Option<&str> {
self.source.as_deref()
}
/// <p>Specifies the engine-specific parameters type.</p>
pub fn apply_type(&self) -> ::std::option::Option<&str> {
self.apply_type.as_deref()
}
/// <p>Specifies the valid data type for the parameter.</p>
pub fn data_type(&self) -> ::std::option::Option<&str> {
self.data_type.as_deref()
}
/// <p>Specifies the valid range of values for the parameter.</p>
pub fn allowed_values(&self) -> ::std::option::Option<&str> {
self.allowed_values.as_deref()
}
/// <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.</p>
pub fn is_modifiable(&self) -> ::std::option::Option<bool> {
self.is_modifiable
}
/// <p>The earliest engine version to which the parameter can apply.</p>
pub fn minimum_engine_version(&self) -> ::std::option::Option<&str> {
self.minimum_engine_version.as_deref()
}
/// <p>Indicates when to apply parameter updates.</p>
pub fn apply_method(&self) -> ::std::option::Option<&crate::types::ApplyMethod> {
self.apply_method.as_ref()
}
}
impl Parameter {
/// Creates a new builder-style object to manufacture [`Parameter`](crate::types::Parameter).
pub fn builder() -> crate::types::builders::ParameterBuilder {
crate::types::builders::ParameterBuilder::default()
}
}
/// A builder for [`Parameter`](crate::types::Parameter).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ParameterBuilder {
pub(crate) parameter_name: ::std::option::Option<::std::string::String>,
pub(crate) parameter_value: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) source: ::std::option::Option<::std::string::String>,
pub(crate) apply_type: ::std::option::Option<::std::string::String>,
pub(crate) data_type: ::std::option::Option<::std::string::String>,
pub(crate) allowed_values: ::std::option::Option<::std::string::String>,
pub(crate) is_modifiable: ::std::option::Option<bool>,
pub(crate) minimum_engine_version: ::std::option::Option<::std::string::String>,
pub(crate) apply_method: ::std::option::Option<crate::types::ApplyMethod>,
}
impl ParameterBuilder {
/// <p>Specifies the name of the parameter.</p>
pub fn parameter_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.parameter_name = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies the name of the parameter.</p>
pub fn set_parameter_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.parameter_name = input;
self
}
/// <p>Specifies the name of the parameter.</p>
pub fn get_parameter_name(&self) -> &::std::option::Option<::std::string::String> {
&self.parameter_name
}
/// <p>Specifies the value of the parameter. Must be one or more of the cluster parameter's <code>AllowedValues</code> in CSV format:</p>
/// <p>Valid values are:</p>
/// <ul>
/// <li>
/// <p><code>enabled</code>: The cluster accepts secure connections using TLS version 1.0 through 1.3.</p></li>
/// <li>
/// <p><code>disabled</code>: The cluster does not accept secure connections using TLS.</p></li>
/// <li>
/// <p><code>fips-140-3</code>: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.</p></li>
/// <li>
/// <p><code>tls1.2+</code>: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p></li>
/// <li>
/// <p><code>tls1.3+</code>: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p></li>
/// </ul>
pub fn parameter_value(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.parameter_value = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies the value of the parameter. Must be one or more of the cluster parameter's <code>AllowedValues</code> in CSV format:</p>
/// <p>Valid values are:</p>
/// <ul>
/// <li>
/// <p><code>enabled</code>: The cluster accepts secure connections using TLS version 1.0 through 1.3.</p></li>
/// <li>
/// <p><code>disabled</code>: The cluster does not accept secure connections using TLS.</p></li>
/// <li>
/// <p><code>fips-140-3</code>: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.</p></li>
/// <li>
/// <p><code>tls1.2+</code>: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p></li>
/// <li>
/// <p><code>tls1.3+</code>: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p></li>
/// </ul>
pub fn set_parameter_value(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.parameter_value = input;
self
}
/// <p>Specifies the value of the parameter. Must be one or more of the cluster parameter's <code>AllowedValues</code> in CSV format:</p>
/// <p>Valid values are:</p>
/// <ul>
/// <li>
/// <p><code>enabled</code>: The cluster accepts secure connections using TLS version 1.0 through 1.3.</p></li>
/// <li>
/// <p><code>disabled</code>: The cluster does not accept secure connections using TLS.</p></li>
/// <li>
/// <p><code>fips-140-3</code>: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.</p></li>
/// <li>
/// <p><code>tls1.2+</code>: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p></li>
/// <li>
/// <p><code>tls1.3+</code>: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p></li>
/// </ul>
pub fn get_parameter_value(&self) -> &::std::option::Option<::std::string::String> {
&self.parameter_value
}
/// <p>Provides a description of the parameter.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>Provides a description of the parameter.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>Provides a description of the parameter.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>Indicates the source of the parameter value.</p>
pub fn source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.source = ::std::option::Option::Some(input.into());
self
}
/// <p>Indicates the source of the parameter value.</p>
pub fn set_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.source = input;
self
}
/// <p>Indicates the source of the parameter value.</p>
pub fn get_source(&self) -> &::std::option::Option<::std::string::String> {
&self.source
}
/// <p>Specifies the engine-specific parameters type.</p>
pub fn apply_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.apply_type = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies the engine-specific parameters type.</p>
pub fn set_apply_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.apply_type = input;
self
}
/// <p>Specifies the engine-specific parameters type.</p>
pub fn get_apply_type(&self) -> &::std::option::Option<::std::string::String> {
&self.apply_type
}
/// <p>Specifies the valid data type for the parameter.</p>
pub fn data_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.data_type = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies the valid data type for the parameter.</p>
pub fn set_data_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.data_type = input;
self
}
/// <p>Specifies the valid data type for the parameter.</p>
pub fn get_data_type(&self) -> &::std::option::Option<::std::string::String> {
&self.data_type
}
/// <p>Specifies the valid range of values for the parameter.</p>
pub fn allowed_values(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.allowed_values = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies the valid range of values for the parameter.</p>
pub fn set_allowed_values(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.allowed_values = input;
self
}
/// <p>Specifies the valid range of values for the parameter.</p>
pub fn get_allowed_values(&self) -> &::std::option::Option<::std::string::String> {
&self.allowed_values
}
/// <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.</p>
pub fn is_modifiable(mut self, input: bool) -> Self {
self.is_modifiable = ::std::option::Option::Some(input);
self
}
/// <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.</p>
pub fn set_is_modifiable(mut self, input: ::std::option::Option<bool>) -> Self {
self.is_modifiable = input;
self
}
/// <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.</p>
pub fn get_is_modifiable(&self) -> &::std::option::Option<bool> {
&self.is_modifiable
}
/// <p>The earliest engine version to which the parameter can apply.</p>
pub fn minimum_engine_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.minimum_engine_version = ::std::option::Option::Some(input.into());
self
}
/// <p>The earliest engine version to which the parameter can apply.</p>
pub fn set_minimum_engine_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.minimum_engine_version = input;
self
}
/// <p>The earliest engine version to which the parameter can apply.</p>
pub fn get_minimum_engine_version(&self) -> &::std::option::Option<::std::string::String> {
&self.minimum_engine_version
}
/// <p>Indicates when to apply parameter updates.</p>
pub fn apply_method(mut self, input: crate::types::ApplyMethod) -> Self {
self.apply_method = ::std::option::Option::Some(input);
self
}
/// <p>Indicates when to apply parameter updates.</p>
pub fn set_apply_method(mut self, input: ::std::option::Option<crate::types::ApplyMethod>) -> Self {
self.apply_method = input;
self
}
/// <p>Indicates when to apply parameter updates.</p>
pub fn get_apply_method(&self) -> &::std::option::Option<crate::types::ApplyMethod> {
&self.apply_method
}
/// Consumes the builder and constructs a [`Parameter`](crate::types::Parameter).
pub fn build(self) -> crate::types::Parameter {
crate::types::Parameter {
parameter_name: self.parameter_name,
parameter_value: self.parameter_value,
description: self.description,
source: self.source,
apply_type: self.apply_type,
data_type: self.data_type,
allowed_values: self.allowed_values,
is_modifiable: self.is_modifiable,
minimum_engine_version: self.minimum_engine_version,
apply_method: self.apply_method,
}
}
}