aws-sdk-rds 1.132.0

AWS SDK for Amazon Relational Database Service
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
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

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>The details of an option.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Option {
    /// <p>The name of the option.</p>
    pub option_name: ::std::option::Option<::std::string::String>,
    /// <p>The description of the option.</p>
    pub option_description: ::std::option::Option<::std::string::String>,
    /// <p>Indicates whether this option is persistent.</p>
    pub persistent: ::std::option::Option<bool>,
    /// <p>Indicates whether this option is permanent.</p>
    pub permanent: ::std::option::Option<bool>,
    /// <p>If required, the port configured for this option to use.</p>
    pub port: ::std::option::Option<i32>,
    /// <p>The version of the option.</p>
    pub option_version: ::std::option::Option<::std::string::String>,
    /// <p>The option settings for this option.</p>
    pub option_settings: ::std::option::Option<::std::vec::Vec<crate::types::OptionSetting>>,
    /// <p>If the option requires access to a port, then this DB security group allows access to the port.</p>
    pub db_security_group_memberships: ::std::option::Option<::std::vec::Vec<crate::types::DbSecurityGroupMembership>>,
    /// <p>If the option requires access to a port, then this VPC security group allows access to the port.</p>
    pub vpc_security_group_memberships: ::std::option::Option<::std::vec::Vec<crate::types::VpcSecurityGroupMembership>>,
}
impl Option {
    /// <p>The name of the option.</p>
    pub fn option_name(&self) -> ::std::option::Option<&str> {
        self.option_name.as_deref()
    }
    /// <p>The description of the option.</p>
    pub fn option_description(&self) -> ::std::option::Option<&str> {
        self.option_description.as_deref()
    }
    /// <p>Indicates whether this option is persistent.</p>
    pub fn persistent(&self) -> ::std::option::Option<bool> {
        self.persistent
    }
    /// <p>Indicates whether this option is permanent.</p>
    pub fn permanent(&self) -> ::std::option::Option<bool> {
        self.permanent
    }
    /// <p>If required, the port configured for this option to use.</p>
    pub fn port(&self) -> ::std::option::Option<i32> {
        self.port
    }
    /// <p>The version of the option.</p>
    pub fn option_version(&self) -> ::std::option::Option<&str> {
        self.option_version.as_deref()
    }
    /// <p>The option settings for this option.</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 `.option_settings.is_none()`.
    pub fn option_settings(&self) -> &[crate::types::OptionSetting] {
        self.option_settings.as_deref().unwrap_or_default()
    }
    /// <p>If the option requires access to a port, then this DB security group allows access to the port.</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 `.db_security_group_memberships.is_none()`.
    pub fn db_security_group_memberships(&self) -> &[crate::types::DbSecurityGroupMembership] {
        self.db_security_group_memberships.as_deref().unwrap_or_default()
    }
    /// <p>If the option requires access to a port, then this VPC security group allows access to the port.</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 `.vpc_security_group_memberships.is_none()`.
    pub fn vpc_security_group_memberships(&self) -> &[crate::types::VpcSecurityGroupMembership] {
        self.vpc_security_group_memberships.as_deref().unwrap_or_default()
    }
}
impl Option {
    /// Creates a new builder-style object to manufacture [`Option`](crate::types::Option).
    pub fn builder() -> crate::types::builders::OptionBuilder {
        crate::types::builders::OptionBuilder::default()
    }
}

/// A builder for [`Option`](crate::types::Option).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct OptionBuilder {
    pub(crate) option_name: ::std::option::Option<::std::string::String>,
    pub(crate) option_description: ::std::option::Option<::std::string::String>,
    pub(crate) persistent: ::std::option::Option<bool>,
    pub(crate) permanent: ::std::option::Option<bool>,
    pub(crate) port: ::std::option::Option<i32>,
    pub(crate) option_version: ::std::option::Option<::std::string::String>,
    pub(crate) option_settings: ::std::option::Option<::std::vec::Vec<crate::types::OptionSetting>>,
    pub(crate) db_security_group_memberships: ::std::option::Option<::std::vec::Vec<crate::types::DbSecurityGroupMembership>>,
    pub(crate) vpc_security_group_memberships: ::std::option::Option<::std::vec::Vec<crate::types::VpcSecurityGroupMembership>>,
}
impl OptionBuilder {
    /// <p>The name of the option.</p>
    pub fn option_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.option_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the option.</p>
    pub fn set_option_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.option_name = input;
        self
    }
    /// <p>The name of the option.</p>
    pub fn get_option_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.option_name
    }
    /// <p>The description of the option.</p>
    pub fn option_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.option_description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The description of the option.</p>
    pub fn set_option_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.option_description = input;
        self
    }
    /// <p>The description of the option.</p>
    pub fn get_option_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.option_description
    }
    /// <p>Indicates whether this option is persistent.</p>
    pub fn persistent(mut self, input: bool) -> Self {
        self.persistent = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether this option is persistent.</p>
    pub fn set_persistent(mut self, input: ::std::option::Option<bool>) -> Self {
        self.persistent = input;
        self
    }
    /// <p>Indicates whether this option is persistent.</p>
    pub fn get_persistent(&self) -> &::std::option::Option<bool> {
        &self.persistent
    }
    /// <p>Indicates whether this option is permanent.</p>
    pub fn permanent(mut self, input: bool) -> Self {
        self.permanent = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether this option is permanent.</p>
    pub fn set_permanent(mut self, input: ::std::option::Option<bool>) -> Self {
        self.permanent = input;
        self
    }
    /// <p>Indicates whether this option is permanent.</p>
    pub fn get_permanent(&self) -> &::std::option::Option<bool> {
        &self.permanent
    }
    /// <p>If required, the port configured for this option to use.</p>
    pub fn port(mut self, input: i32) -> Self {
        self.port = ::std::option::Option::Some(input);
        self
    }
    /// <p>If required, the port configured for this option to use.</p>
    pub fn set_port(mut self, input: ::std::option::Option<i32>) -> Self {
        self.port = input;
        self
    }
    /// <p>If required, the port configured for this option to use.</p>
    pub fn get_port(&self) -> &::std::option::Option<i32> {
        &self.port
    }
    /// <p>The version of the option.</p>
    pub fn option_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.option_version = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The version of the option.</p>
    pub fn set_option_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.option_version = input;
        self
    }
    /// <p>The version of the option.</p>
    pub fn get_option_version(&self) -> &::std::option::Option<::std::string::String> {
        &self.option_version
    }
    /// Appends an item to `option_settings`.
    ///
    /// To override the contents of this collection use [`set_option_settings`](Self::set_option_settings).
    ///
    /// <p>The option settings for this option.</p>
    pub fn option_settings(mut self, input: crate::types::OptionSetting) -> Self {
        let mut v = self.option_settings.unwrap_or_default();
        v.push(input);
        self.option_settings = ::std::option::Option::Some(v);
        self
    }
    /// <p>The option settings for this option.</p>
    pub fn set_option_settings(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::OptionSetting>>) -> Self {
        self.option_settings = input;
        self
    }
    /// <p>The option settings for this option.</p>
    pub fn get_option_settings(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::OptionSetting>> {
        &self.option_settings
    }
    /// Appends an item to `db_security_group_memberships`.
    ///
    /// To override the contents of this collection use [`set_db_security_group_memberships`](Self::set_db_security_group_memberships).
    ///
    /// <p>If the option requires access to a port, then this DB security group allows access to the port.</p>
    pub fn db_security_group_memberships(mut self, input: crate::types::DbSecurityGroupMembership) -> Self {
        let mut v = self.db_security_group_memberships.unwrap_or_default();
        v.push(input);
        self.db_security_group_memberships = ::std::option::Option::Some(v);
        self
    }
    /// <p>If the option requires access to a port, then this DB security group allows access to the port.</p>
    pub fn set_db_security_group_memberships(
        mut self,
        input: ::std::option::Option<::std::vec::Vec<crate::types::DbSecurityGroupMembership>>,
    ) -> Self {
        self.db_security_group_memberships = input;
        self
    }
    /// <p>If the option requires access to a port, then this DB security group allows access to the port.</p>
    pub fn get_db_security_group_memberships(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DbSecurityGroupMembership>> {
        &self.db_security_group_memberships
    }
    /// Appends an item to `vpc_security_group_memberships`.
    ///
    /// To override the contents of this collection use [`set_vpc_security_group_memberships`](Self::set_vpc_security_group_memberships).
    ///
    /// <p>If the option requires access to a port, then this VPC security group allows access to the port.</p>
    pub fn vpc_security_group_memberships(mut self, input: crate::types::VpcSecurityGroupMembership) -> Self {
        let mut v = self.vpc_security_group_memberships.unwrap_or_default();
        v.push(input);
        self.vpc_security_group_memberships = ::std::option::Option::Some(v);
        self
    }
    /// <p>If the option requires access to a port, then this VPC security group allows access to the port.</p>
    pub fn set_vpc_security_group_memberships(
        mut self,
        input: ::std::option::Option<::std::vec::Vec<crate::types::VpcSecurityGroupMembership>>,
    ) -> Self {
        self.vpc_security_group_memberships = input;
        self
    }
    /// <p>If the option requires access to a port, then this VPC security group allows access to the port.</p>
    pub fn get_vpc_security_group_memberships(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::VpcSecurityGroupMembership>> {
        &self.vpc_security_group_memberships
    }
    /// Consumes the builder and constructs a [`Option`](crate::types::Option).
    pub fn build(self) -> crate::types::Option {
        crate::types::Option {
            option_name: self.option_name,
            option_description: self.option_description,
            persistent: self.persistent,
            permanent: self.permanent,
            port: self.port,
            option_version: self.option_version,
            option_settings: self.option_settings,
            db_security_group_memberships: self.db_security_group_memberships,
            vpc_security_group_memberships: self.vpc_security_group_memberships,
        }
    }
}