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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p></p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeDbInstancesInput {
/// <p>The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DB instance.</p></li>
/// </ul>
pub db_instance_identifier: ::std::option::Option<::std::string::String>,
/// <p>A filter that specifies one or more DB instances to describe.</p>
/// <p>Supported Filters:</p>
/// <ul>
/// <li>
/// <p><code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.</p></li>
/// <li>
/// <p><code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.</p></li>
/// <li>
/// <p><code>dbi-resource-id</code> - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.</p></li>
/// <li>
/// <p><code>domain</code> - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.</p></li>
/// <li>
/// <p><code>engine</code> - Accepts engine names. The results list only includes information about the DB instances for these engines.</p></li>
/// </ul>
pub filters: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>,
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
/// <p>Default: 100</p>
/// <p>Constraints: Minimum 20, maximum 100.</p>
pub max_records: ::std::option::Option<i32>,
/// <p>An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
pub marker: ::std::option::Option<::std::string::String>,
}
impl DescribeDbInstancesInput {
/// <p>The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DB instance.</p></li>
/// </ul>
pub fn db_instance_identifier(&self) -> ::std::option::Option<&str> {
self.db_instance_identifier.as_deref()
}
/// <p>A filter that specifies one or more DB instances to describe.</p>
/// <p>Supported Filters:</p>
/// <ul>
/// <li>
/// <p><code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.</p></li>
/// <li>
/// <p><code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.</p></li>
/// <li>
/// <p><code>dbi-resource-id</code> - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.</p></li>
/// <li>
/// <p><code>domain</code> - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.</p></li>
/// <li>
/// <p><code>engine</code> - Accepts engine names. The results list only includes information about the DB instances for these engines.</p></li>
/// </ul>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.filters.is_none()`.
pub fn filters(&self) -> &[crate::types::Filter] {
self.filters.as_deref().unwrap_or_default()
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
/// <p>Default: 100</p>
/// <p>Constraints: Minimum 20, maximum 100.</p>
pub fn max_records(&self) -> ::std::option::Option<i32> {
self.max_records
}
/// <p>An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
pub fn marker(&self) -> ::std::option::Option<&str> {
self.marker.as_deref()
}
}
impl DescribeDbInstancesInput {
/// Creates a new builder-style object to manufacture [`DescribeDbInstancesInput`](crate::operation::describe_db_instances::DescribeDbInstancesInput).
pub fn builder() -> crate::operation::describe_db_instances::builders::DescribeDbInstancesInputBuilder {
crate::operation::describe_db_instances::builders::DescribeDbInstancesInputBuilder::default()
}
}
/// A builder for [`DescribeDbInstancesInput`](crate::operation::describe_db_instances::DescribeDbInstancesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeDbInstancesInputBuilder {
pub(crate) db_instance_identifier: ::std::option::Option<::std::string::String>,
pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>,
pub(crate) max_records: ::std::option::Option<i32>,
pub(crate) marker: ::std::option::Option<::std::string::String>,
}
impl DescribeDbInstancesInputBuilder {
/// <p>The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DB instance.</p></li>
/// </ul>
pub fn db_instance_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.db_instance_identifier = ::std::option::Option::Some(input.into());
self
}
/// <p>The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DB instance.</p></li>
/// </ul>
pub fn set_db_instance_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.db_instance_identifier = input;
self
}
/// <p>The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>If supplied, must match the identifier of an existing DB instance.</p></li>
/// </ul>
pub fn get_db_instance_identifier(&self) -> &::std::option::Option<::std::string::String> {
&self.db_instance_identifier
}
/// Appends an item to `filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>A filter that specifies one or more DB instances to describe.</p>
/// <p>Supported Filters:</p>
/// <ul>
/// <li>
/// <p><code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.</p></li>
/// <li>
/// <p><code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.</p></li>
/// <li>
/// <p><code>dbi-resource-id</code> - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.</p></li>
/// <li>
/// <p><code>domain</code> - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.</p></li>
/// <li>
/// <p><code>engine</code> - Accepts engine names. The results list only includes information about the DB instances for these engines.</p></li>
/// </ul>
pub fn filters(mut self, input: crate::types::Filter) -> Self {
let mut v = self.filters.unwrap_or_default();
v.push(input);
self.filters = ::std::option::Option::Some(v);
self
}
/// <p>A filter that specifies one or more DB instances to describe.</p>
/// <p>Supported Filters:</p>
/// <ul>
/// <li>
/// <p><code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.</p></li>
/// <li>
/// <p><code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.</p></li>
/// <li>
/// <p><code>dbi-resource-id</code> - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.</p></li>
/// <li>
/// <p><code>domain</code> - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.</p></li>
/// <li>
/// <p><code>engine</code> - Accepts engine names. The results list only includes information about the DB instances for these engines.</p></li>
/// </ul>
pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
self.filters = input;
self
}
/// <p>A filter that specifies one or more DB instances to describe.</p>
/// <p>Supported Filters:</p>
/// <ul>
/// <li>
/// <p><code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.</p></li>
/// <li>
/// <p><code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.</p></li>
/// <li>
/// <p><code>dbi-resource-id</code> - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.</p></li>
/// <li>
/// <p><code>domain</code> - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.</p></li>
/// <li>
/// <p><code>engine</code> - Accepts engine names. The results list only includes information about the DB instances for these engines.</p></li>
/// </ul>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
&self.filters
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
/// <p>Default: 100</p>
/// <p>Constraints: Minimum 20, maximum 100.</p>
pub fn max_records(mut self, input: i32) -> Self {
self.max_records = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
/// <p>Default: 100</p>
/// <p>Constraints: Minimum 20, maximum 100.</p>
pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_records = input;
self
}
/// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
/// <p>Default: 100</p>
/// <p>Constraints: Minimum 20, maximum 100.</p>
pub fn get_max_records(&self) -> &::std::option::Option<i32> {
&self.max_records
}
/// <p>An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.marker = ::std::option::Option::Some(input.into());
self
}
/// <p>An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.marker = input;
self
}
/// <p>An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
&self.marker
}
/// Consumes the builder and constructs a [`DescribeDbInstancesInput`](crate::operation::describe_db_instances::DescribeDbInstancesInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::describe_db_instances::DescribeDbInstancesInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::describe_db_instances::DescribeDbInstancesInput {
db_instance_identifier: self.db_instance_identifier,
filters: self.filters,
max_records: self.max_records,
marker: self.marker,
})
}
}