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
// 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 DescribeFrameworkOutput {
/// <p>The unique name of a framework.</p>
pub framework_name: ::std::option::Option<::std::string::String>,
/// <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>
pub framework_arn: ::std::option::Option<::std::string::String>,
/// <p>An optional description of the framework.</p>
pub framework_description: ::std::option::Option<::std::string::String>,
/// <p>The controls that make up the framework. Each control in the list has a name, input parameters, and scope.</p>
pub framework_controls: ::std::option::Option<::std::vec::Vec<crate::types::FrameworkControl>>,
/// <p>The date and time that a framework is created, in ISO 8601 representation. The value of <code>CreationTime</code> is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.</p>
pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The deployment status of a framework. The statuses are:</p>
/// <p><code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED</code></p>
pub deployment_status: ::std::option::Option<::std::string::String>,
/// <p>A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:</p>
/// <ul>
/// <li>
/// <p><code>ACTIVE</code> when recording is turned on for all resources governed by the framework.</p></li>
/// <li>
/// <p><code>PARTIALLY_ACTIVE</code> when recording is turned off for at least one resource governed by the framework.</p></li>
/// <li>
/// <p><code>INACTIVE</code> when recording is turned off for all resources governed by the framework.</p></li>
/// <li>
/// <p><code>UNAVAILABLE</code> when Backup is unable to validate recording status at this time.</p></li>
/// </ul>
pub framework_status: ::std::option::Option<::std::string::String>,
/// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>DescribeFrameworkOutput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
pub idempotency_token: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl DescribeFrameworkOutput {
/// <p>The unique name of a framework.</p>
pub fn framework_name(&self) -> ::std::option::Option<&str> {
self.framework_name.as_deref()
}
/// <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>
pub fn framework_arn(&self) -> ::std::option::Option<&str> {
self.framework_arn.as_deref()
}
/// <p>An optional description of the framework.</p>
pub fn framework_description(&self) -> ::std::option::Option<&str> {
self.framework_description.as_deref()
}
/// <p>The controls that make up the framework. Each control in the list has a name, input parameters, and scope.</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 `.framework_controls.is_none()`.
pub fn framework_controls(&self) -> &[crate::types::FrameworkControl] {
self.framework_controls.as_deref().unwrap_or_default()
}
/// <p>The date and time that a framework is created, in ISO 8601 representation. The value of <code>CreationTime</code> is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.</p>
pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.creation_time.as_ref()
}
/// <p>The deployment status of a framework. The statuses are:</p>
/// <p><code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED</code></p>
pub fn deployment_status(&self) -> ::std::option::Option<&str> {
self.deployment_status.as_deref()
}
/// <p>A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:</p>
/// <ul>
/// <li>
/// <p><code>ACTIVE</code> when recording is turned on for all resources governed by the framework.</p></li>
/// <li>
/// <p><code>PARTIALLY_ACTIVE</code> when recording is turned off for at least one resource governed by the framework.</p></li>
/// <li>
/// <p><code>INACTIVE</code> when recording is turned off for all resources governed by the framework.</p></li>
/// <li>
/// <p><code>UNAVAILABLE</code> when Backup is unable to validate recording status at this time.</p></li>
/// </ul>
pub fn framework_status(&self) -> ::std::option::Option<&str> {
self.framework_status.as_deref()
}
/// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>DescribeFrameworkOutput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
pub fn idempotency_token(&self) -> ::std::option::Option<&str> {
self.idempotency_token.as_deref()
}
}
impl ::aws_types::request_id::RequestId for DescribeFrameworkOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeFrameworkOutput {
/// Creates a new builder-style object to manufacture [`DescribeFrameworkOutput`](crate::operation::describe_framework::DescribeFrameworkOutput).
pub fn builder() -> crate::operation::describe_framework::builders::DescribeFrameworkOutputBuilder {
crate::operation::describe_framework::builders::DescribeFrameworkOutputBuilder::default()
}
}
/// A builder for [`DescribeFrameworkOutput`](crate::operation::describe_framework::DescribeFrameworkOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeFrameworkOutputBuilder {
pub(crate) framework_name: ::std::option::Option<::std::string::String>,
pub(crate) framework_arn: ::std::option::Option<::std::string::String>,
pub(crate) framework_description: ::std::option::Option<::std::string::String>,
pub(crate) framework_controls: ::std::option::Option<::std::vec::Vec<crate::types::FrameworkControl>>,
pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) deployment_status: ::std::option::Option<::std::string::String>,
pub(crate) framework_status: ::std::option::Option<::std::string::String>,
pub(crate) idempotency_token: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl DescribeFrameworkOutputBuilder {
/// <p>The unique name of a framework.</p>
pub fn framework_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.framework_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The unique name of a framework.</p>
pub fn set_framework_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.framework_name = input;
self
}
/// <p>The unique name of a framework.</p>
pub fn get_framework_name(&self) -> &::std::option::Option<::std::string::String> {
&self.framework_name
}
/// <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>
pub fn framework_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.framework_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>
pub fn set_framework_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.framework_arn = input;
self
}
/// <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>
pub fn get_framework_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.framework_arn
}
/// <p>An optional description of the framework.</p>
pub fn framework_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.framework_description = ::std::option::Option::Some(input.into());
self
}
/// <p>An optional description of the framework.</p>
pub fn set_framework_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.framework_description = input;
self
}
/// <p>An optional description of the framework.</p>
pub fn get_framework_description(&self) -> &::std::option::Option<::std::string::String> {
&self.framework_description
}
/// Appends an item to `framework_controls`.
///
/// To override the contents of this collection use [`set_framework_controls`](Self::set_framework_controls).
///
/// <p>The controls that make up the framework. Each control in the list has a name, input parameters, and scope.</p>
pub fn framework_controls(mut self, input: crate::types::FrameworkControl) -> Self {
let mut v = self.framework_controls.unwrap_or_default();
v.push(input);
self.framework_controls = ::std::option::Option::Some(v);
self
}
/// <p>The controls that make up the framework. Each control in the list has a name, input parameters, and scope.</p>
pub fn set_framework_controls(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::FrameworkControl>>) -> Self {
self.framework_controls = input;
self
}
/// <p>The controls that make up the framework. Each control in the list has a name, input parameters, and scope.</p>
pub fn get_framework_controls(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::FrameworkControl>> {
&self.framework_controls
}
/// <p>The date and time that a framework is created, in ISO 8601 representation. The value of <code>CreationTime</code> is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.</p>
pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.creation_time = ::std::option::Option::Some(input);
self
}
/// <p>The date and time that a framework is created, in ISO 8601 representation. The value of <code>CreationTime</code> is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.</p>
pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.creation_time = input;
self
}
/// <p>The date and time that a framework is created, in ISO 8601 representation. The value of <code>CreationTime</code> is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.</p>
pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.creation_time
}
/// <p>The deployment status of a framework. The statuses are:</p>
/// <p><code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED</code></p>
pub fn deployment_status(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.deployment_status = ::std::option::Option::Some(input.into());
self
}
/// <p>The deployment status of a framework. The statuses are:</p>
/// <p><code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED</code></p>
pub fn set_deployment_status(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.deployment_status = input;
self
}
/// <p>The deployment status of a framework. The statuses are:</p>
/// <p><code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED</code></p>
pub fn get_deployment_status(&self) -> &::std::option::Option<::std::string::String> {
&self.deployment_status
}
/// <p>A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:</p>
/// <ul>
/// <li>
/// <p><code>ACTIVE</code> when recording is turned on for all resources governed by the framework.</p></li>
/// <li>
/// <p><code>PARTIALLY_ACTIVE</code> when recording is turned off for at least one resource governed by the framework.</p></li>
/// <li>
/// <p><code>INACTIVE</code> when recording is turned off for all resources governed by the framework.</p></li>
/// <li>
/// <p><code>UNAVAILABLE</code> when Backup is unable to validate recording status at this time.</p></li>
/// </ul>
pub fn framework_status(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.framework_status = ::std::option::Option::Some(input.into());
self
}
/// <p>A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:</p>
/// <ul>
/// <li>
/// <p><code>ACTIVE</code> when recording is turned on for all resources governed by the framework.</p></li>
/// <li>
/// <p><code>PARTIALLY_ACTIVE</code> when recording is turned off for at least one resource governed by the framework.</p></li>
/// <li>
/// <p><code>INACTIVE</code> when recording is turned off for all resources governed by the framework.</p></li>
/// <li>
/// <p><code>UNAVAILABLE</code> when Backup is unable to validate recording status at this time.</p></li>
/// </ul>
pub fn set_framework_status(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.framework_status = input;
self
}
/// <p>A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:</p>
/// <ul>
/// <li>
/// <p><code>ACTIVE</code> when recording is turned on for all resources governed by the framework.</p></li>
/// <li>
/// <p><code>PARTIALLY_ACTIVE</code> when recording is turned off for at least one resource governed by the framework.</p></li>
/// <li>
/// <p><code>INACTIVE</code> when recording is turned off for all resources governed by the framework.</p></li>
/// <li>
/// <p><code>UNAVAILABLE</code> when Backup is unable to validate recording status at this time.</p></li>
/// </ul>
pub fn get_framework_status(&self) -> &::std::option::Option<::std::string::String> {
&self.framework_status
}
/// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>DescribeFrameworkOutput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
pub fn idempotency_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.idempotency_token = ::std::option::Option::Some(input.into());
self
}
/// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>DescribeFrameworkOutput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
pub fn set_idempotency_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.idempotency_token = input;
self
}
/// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>DescribeFrameworkOutput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
pub fn get_idempotency_token(&self) -> &::std::option::Option<::std::string::String> {
&self.idempotency_token
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`DescribeFrameworkOutput`](crate::operation::describe_framework::DescribeFrameworkOutput).
pub fn build(self) -> crate::operation::describe_framework::DescribeFrameworkOutput {
crate::operation::describe_framework::DescribeFrameworkOutput {
framework_name: self.framework_name,
framework_arn: self.framework_arn,
framework_description: self.framework_description,
framework_controls: self.framework_controls,
creation_time: self.creation_time,
deployment_status: self.deployment_status,
framework_status: self.framework_status,
idempotency_token: self.idempotency_token,
_request_id: self._request_id,
}
}
}