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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Information about an Automation runbook used in a runbook workflow in Change Manager.</p><note>
/// <p>The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.</p>
/// </note>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Runbook {
/// <p>The name of the Automation runbook used in a runbook workflow.</p>
pub document_name: ::std::string::String,
/// <p>The version of the Automation runbook used in a runbook workflow.</p>
pub document_version: ::std::option::Option<::std::string::String>,
/// <p>The key-value map of execution parameters, which were supplied when calling <code>StartChangeRequestExecution</code>.</p>
pub parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>,
/// <p>The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify <code>Targets</code>.</p>
pub target_parameter_name: ::std::option::Option<::std::string::String>,
/// <p>A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify <code>TargetParameterName</code>.</p>
pub targets: ::std::option::Option<::std::vec::Vec<crate::types::Target>>,
/// <p>A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>
pub target_maps:
::std::option::Option<::std::vec::Vec<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>>,
/// <p>The <code>MaxConcurrency</code> value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.</p>
pub max_concurrency: ::std::option::Option<::std::string::String>,
/// <p>The <code>MaxErrors</code> value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.</p>
pub max_errors: ::std::option::Option<::std::string::String>,
/// <p>Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.</p>
pub target_locations: ::std::option::Option<::std::vec::Vec<crate::types::TargetLocation>>,
}
impl Runbook {
/// <p>The name of the Automation runbook used in a runbook workflow.</p>
pub fn document_name(&self) -> &str {
use std::ops::Deref;
self.document_name.deref()
}
/// <p>The version of the Automation runbook used in a runbook workflow.</p>
pub fn document_version(&self) -> ::std::option::Option<&str> {
self.document_version.as_deref()
}
/// <p>The key-value map of execution parameters, which were supplied when calling <code>StartChangeRequestExecution</code>.</p>
pub fn parameters(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>> {
self.parameters.as_ref()
}
/// <p>The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify <code>Targets</code>.</p>
pub fn target_parameter_name(&self) -> ::std::option::Option<&str> {
self.target_parameter_name.as_deref()
}
/// <p>A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify <code>TargetParameterName</code>.</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 `.targets.is_none()`.
pub fn targets(&self) -> &[crate::types::Target] {
self.targets.as_deref().unwrap_or_default()
}
/// <p>A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.</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 `.target_maps.is_none()`.
pub fn target_maps(&self) -> &[::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>] {
self.target_maps.as_deref().unwrap_or_default()
}
/// <p>The <code>MaxConcurrency</code> value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.</p>
pub fn max_concurrency(&self) -> ::std::option::Option<&str> {
self.max_concurrency.as_deref()
}
/// <p>The <code>MaxErrors</code> value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.</p>
pub fn max_errors(&self) -> ::std::option::Option<&str> {
self.max_errors.as_deref()
}
/// <p>Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.</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 `.target_locations.is_none()`.
pub fn target_locations(&self) -> &[crate::types::TargetLocation] {
self.target_locations.as_deref().unwrap_or_default()
}
}
impl Runbook {
/// Creates a new builder-style object to manufacture [`Runbook`](crate::types::Runbook).
pub fn builder() -> crate::types::builders::RunbookBuilder {
crate::types::builders::RunbookBuilder::default()
}
}
/// A builder for [`Runbook`](crate::types::Runbook).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct RunbookBuilder {
pub(crate) document_name: ::std::option::Option<::std::string::String>,
pub(crate) document_version: ::std::option::Option<::std::string::String>,
pub(crate) parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>,
pub(crate) target_parameter_name: ::std::option::Option<::std::string::String>,
pub(crate) targets: ::std::option::Option<::std::vec::Vec<crate::types::Target>>,
pub(crate) target_maps:
::std::option::Option<::std::vec::Vec<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>>,
pub(crate) max_concurrency: ::std::option::Option<::std::string::String>,
pub(crate) max_errors: ::std::option::Option<::std::string::String>,
pub(crate) target_locations: ::std::option::Option<::std::vec::Vec<crate::types::TargetLocation>>,
}
impl RunbookBuilder {
/// <p>The name of the Automation runbook used in a runbook workflow.</p>
/// This field is required.
pub fn document_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.document_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the Automation runbook used in a runbook workflow.</p>
pub fn set_document_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.document_name = input;
self
}
/// <p>The name of the Automation runbook used in a runbook workflow.</p>
pub fn get_document_name(&self) -> &::std::option::Option<::std::string::String> {
&self.document_name
}
/// <p>The version of the Automation runbook used in a runbook workflow.</p>
pub fn document_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.document_version = ::std::option::Option::Some(input.into());
self
}
/// <p>The version of the Automation runbook used in a runbook workflow.</p>
pub fn set_document_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.document_version = input;
self
}
/// <p>The version of the Automation runbook used in a runbook workflow.</p>
pub fn get_document_version(&self) -> &::std::option::Option<::std::string::String> {
&self.document_version
}
/// Adds a key-value pair to `parameters`.
///
/// To override the contents of this collection use [`set_parameters`](Self::set_parameters).
///
/// <p>The key-value map of execution parameters, which were supplied when calling <code>StartChangeRequestExecution</code>.</p>
pub fn parameters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: ::std::vec::Vec<::std::string::String>) -> Self {
let mut hash_map = self.parameters.unwrap_or_default();
hash_map.insert(k.into(), v);
self.parameters = ::std::option::Option::Some(hash_map);
self
}
/// <p>The key-value map of execution parameters, which were supplied when calling <code>StartChangeRequestExecution</code>.</p>
pub fn set_parameters(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>,
) -> Self {
self.parameters = input;
self
}
/// <p>The key-value map of execution parameters, which were supplied when calling <code>StartChangeRequestExecution</code>.</p>
pub fn get_parameters(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>> {
&self.parameters
}
/// <p>The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify <code>Targets</code>.</p>
pub fn target_parameter_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.target_parameter_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify <code>Targets</code>.</p>
pub fn set_target_parameter_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.target_parameter_name = input;
self
}
/// <p>The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify <code>Targets</code>.</p>
pub fn get_target_parameter_name(&self) -> &::std::option::Option<::std::string::String> {
&self.target_parameter_name
}
/// Appends an item to `targets`.
///
/// To override the contents of this collection use [`set_targets`](Self::set_targets).
///
/// <p>A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify <code>TargetParameterName</code>.</p>
pub fn targets(mut self, input: crate::types::Target) -> Self {
let mut v = self.targets.unwrap_or_default();
v.push(input);
self.targets = ::std::option::Option::Some(v);
self
}
/// <p>A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify <code>TargetParameterName</code>.</p>
pub fn set_targets(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Target>>) -> Self {
self.targets = input;
self
}
/// <p>A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify <code>TargetParameterName</code>.</p>
pub fn get_targets(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Target>> {
&self.targets
}
/// Appends an item to `target_maps`.
///
/// To override the contents of this collection use [`set_target_maps`](Self::set_target_maps).
///
/// <p>A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>
pub fn target_maps(mut self, input: ::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>) -> Self {
let mut v = self.target_maps.unwrap_or_default();
v.push(input);
self.target_maps = ::std::option::Option::Some(v);
self
}
/// <p>A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>
pub fn set_target_maps(
mut self,
input: ::std::option::Option<::std::vec::Vec<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>>,
) -> Self {
self.target_maps = input;
self
}
/// <p>A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>
pub fn get_target_maps(
&self,
) -> &::std::option::Option<::std::vec::Vec<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>> {
&self.target_maps
}
/// <p>The <code>MaxConcurrency</code> value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.</p>
pub fn max_concurrency(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.max_concurrency = ::std::option::Option::Some(input.into());
self
}
/// <p>The <code>MaxConcurrency</code> value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.</p>
pub fn set_max_concurrency(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.max_concurrency = input;
self
}
/// <p>The <code>MaxConcurrency</code> value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.</p>
pub fn get_max_concurrency(&self) -> &::std::option::Option<::std::string::String> {
&self.max_concurrency
}
/// <p>The <code>MaxErrors</code> value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.</p>
pub fn max_errors(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.max_errors = ::std::option::Option::Some(input.into());
self
}
/// <p>The <code>MaxErrors</code> value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.</p>
pub fn set_max_errors(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.max_errors = input;
self
}
/// <p>The <code>MaxErrors</code> value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.</p>
pub fn get_max_errors(&self) -> &::std::option::Option<::std::string::String> {
&self.max_errors
}
/// Appends an item to `target_locations`.
///
/// To override the contents of this collection use [`set_target_locations`](Self::set_target_locations).
///
/// <p>Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.</p>
pub fn target_locations(mut self, input: crate::types::TargetLocation) -> Self {
let mut v = self.target_locations.unwrap_or_default();
v.push(input);
self.target_locations = ::std::option::Option::Some(v);
self
}
/// <p>Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.</p>
pub fn set_target_locations(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TargetLocation>>) -> Self {
self.target_locations = input;
self
}
/// <p>Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.</p>
pub fn get_target_locations(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TargetLocation>> {
&self.target_locations
}
/// Consumes the builder and constructs a [`Runbook`](crate::types::Runbook).
/// This method will fail if any of the following fields are not set:
/// - [`document_name`](crate::types::builders::RunbookBuilder::document_name)
pub fn build(self) -> ::std::result::Result<crate::types::Runbook, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::types::Runbook {
document_name: self.document_name.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"document_name",
"document_name was not specified but it is required when building Runbook",
)
})?,
document_version: self.document_version,
parameters: self.parameters,
target_parameter_name: self.target_parameter_name,
targets: self.targets,
target_maps: self.target_maps,
max_concurrency: self.max_concurrency,
max_errors: self.max_errors,
target_locations: self.target_locations,
})
}
}