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
// 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 ListRulesInput {
/// <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>The token for the next page of results.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.</p>
/// <ul>
/// <li>
/// <p>To list retention rules that retain EBS volumes, specify <code>EBS_VOLUME</code>.</p></li>
/// <li>
/// <p>To list retention rules that retain EBS snapshots, specify <code>EBS_SNAPSHOT</code>.</p></li>
/// <li>
/// <p>To list retention rules that retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p></li>
/// </ul>
pub resource_type: ::std::option::Option<crate::types::ResourceType>,
/// <p>\[Tag-level retention rules only\] Information about the resource tags used to identify resources that are retained by the retention rule.</p>
pub resource_tags: ::std::option::Option<::std::vec::Vec<crate::types::ResourceTag>>,
/// <p>The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.</p>
pub lock_state: ::std::option::Option<crate::types::LockState>,
/// <p>\[Region-level retention rules only\] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.</p>
pub exclude_resource_tags: ::std::option::Option<::std::vec::Vec<crate::types::ResourceTag>>,
}
impl ListRulesInput {
/// <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>The token for the next page of results.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.</p>
/// <ul>
/// <li>
/// <p>To list retention rules that retain EBS volumes, specify <code>EBS_VOLUME</code>.</p></li>
/// <li>
/// <p>To list retention rules that retain EBS snapshots, specify <code>EBS_SNAPSHOT</code>.</p></li>
/// <li>
/// <p>To list retention rules that retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p></li>
/// </ul>
pub fn resource_type(&self) -> ::std::option::Option<&crate::types::ResourceType> {
self.resource_type.as_ref()
}
/// <p>\[Tag-level retention rules only\] Information about the resource tags used to identify resources that are retained by the retention rule.</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 `.resource_tags.is_none()`.
pub fn resource_tags(&self) -> &[crate::types::ResourceTag] {
self.resource_tags.as_deref().unwrap_or_default()
}
/// <p>The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.</p>
pub fn lock_state(&self) -> ::std::option::Option<&crate::types::LockState> {
self.lock_state.as_ref()
}
/// <p>\[Region-level retention rules only\] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.</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 `.exclude_resource_tags.is_none()`.
pub fn exclude_resource_tags(&self) -> &[crate::types::ResourceTag] {
self.exclude_resource_tags.as_deref().unwrap_or_default()
}
}
impl ListRulesInput {
/// Creates a new builder-style object to manufacture [`ListRulesInput`](crate::operation::list_rules::ListRulesInput).
pub fn builder() -> crate::operation::list_rules::builders::ListRulesInputBuilder {
crate::operation::list_rules::builders::ListRulesInputBuilder::default()
}
}
/// A builder for [`ListRulesInput`](crate::operation::list_rules::ListRulesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListRulesInputBuilder {
pub(crate) max_results: ::std::option::Option<i32>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) resource_type: ::std::option::Option<crate::types::ResourceType>,
pub(crate) resource_tags: ::std::option::Option<::std::vec::Vec<crate::types::ResourceTag>>,
pub(crate) lock_state: ::std::option::Option<crate::types::LockState>,
pub(crate) exclude_resource_tags: ::std::option::Option<::std::vec::Vec<crate::types::ResourceTag>>,
}
impl ListRulesInputBuilder {
/// <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>The token for the next page of results.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.next_token = ::std::option::Option::Some(input.into());
self
}
/// <p>The token for the next page of results.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>The token for the next page of results.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// <p>The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.</p>
/// <ul>
/// <li>
/// <p>To list retention rules that retain EBS volumes, specify <code>EBS_VOLUME</code>.</p></li>
/// <li>
/// <p>To list retention rules that retain EBS snapshots, specify <code>EBS_SNAPSHOT</code>.</p></li>
/// <li>
/// <p>To list retention rules that retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p></li>
/// </ul>
/// This field is required.
pub fn resource_type(mut self, input: crate::types::ResourceType) -> Self {
self.resource_type = ::std::option::Option::Some(input);
self
}
/// <p>The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.</p>
/// <ul>
/// <li>
/// <p>To list retention rules that retain EBS volumes, specify <code>EBS_VOLUME</code>.</p></li>
/// <li>
/// <p>To list retention rules that retain EBS snapshots, specify <code>EBS_SNAPSHOT</code>.</p></li>
/// <li>
/// <p>To list retention rules that retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p></li>
/// </ul>
pub fn set_resource_type(mut self, input: ::std::option::Option<crate::types::ResourceType>) -> Self {
self.resource_type = input;
self
}
/// <p>The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.</p>
/// <ul>
/// <li>
/// <p>To list retention rules that retain EBS volumes, specify <code>EBS_VOLUME</code>.</p></li>
/// <li>
/// <p>To list retention rules that retain EBS snapshots, specify <code>EBS_SNAPSHOT</code>.</p></li>
/// <li>
/// <p>To list retention rules that retain EBS-backed AMIs, specify <code>EC2_IMAGE</code>.</p></li>
/// </ul>
pub fn get_resource_type(&self) -> &::std::option::Option<crate::types::ResourceType> {
&self.resource_type
}
/// Appends an item to `resource_tags`.
///
/// To override the contents of this collection use [`set_resource_tags`](Self::set_resource_tags).
///
/// <p>\[Tag-level retention rules only\] Information about the resource tags used to identify resources that are retained by the retention rule.</p>
pub fn resource_tags(mut self, input: crate::types::ResourceTag) -> Self {
let mut v = self.resource_tags.unwrap_or_default();
v.push(input);
self.resource_tags = ::std::option::Option::Some(v);
self
}
/// <p>\[Tag-level retention rules only\] Information about the resource tags used to identify resources that are retained by the retention rule.</p>
pub fn set_resource_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ResourceTag>>) -> Self {
self.resource_tags = input;
self
}
/// <p>\[Tag-level retention rules only\] Information about the resource tags used to identify resources that are retained by the retention rule.</p>
pub fn get_resource_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ResourceTag>> {
&self.resource_tags
}
/// <p>The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.</p>
pub fn lock_state(mut self, input: crate::types::LockState) -> Self {
self.lock_state = ::std::option::Option::Some(input);
self
}
/// <p>The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.</p>
pub fn set_lock_state(mut self, input: ::std::option::Option<crate::types::LockState>) -> Self {
self.lock_state = input;
self
}
/// <p>The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.</p>
pub fn get_lock_state(&self) -> &::std::option::Option<crate::types::LockState> {
&self.lock_state
}
/// Appends an item to `exclude_resource_tags`.
///
/// To override the contents of this collection use [`set_exclude_resource_tags`](Self::set_exclude_resource_tags).
///
/// <p>\[Region-level retention rules only\] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.</p>
pub fn exclude_resource_tags(mut self, input: crate::types::ResourceTag) -> Self {
let mut v = self.exclude_resource_tags.unwrap_or_default();
v.push(input);
self.exclude_resource_tags = ::std::option::Option::Some(v);
self
}
/// <p>\[Region-level retention rules only\] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.</p>
pub fn set_exclude_resource_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ResourceTag>>) -> Self {
self.exclude_resource_tags = input;
self
}
/// <p>\[Region-level retention rules only\] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.</p>
pub fn get_exclude_resource_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ResourceTag>> {
&self.exclude_resource_tags
}
/// Consumes the builder and constructs a [`ListRulesInput`](crate::operation::list_rules::ListRulesInput).
pub fn build(self) -> ::std::result::Result<crate::operation::list_rules::ListRulesInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::list_rules::ListRulesInput {
max_results: self.max_results,
next_token: self.next_token,
resource_type: self.resource_type,
resource_tags: self.resource_tags,
lock_state: self.lock_state,
exclude_resource_tags: self.exclude_resource_tags,
})
}
}