aws_sdk_cloudformation/types/
_change_set_summary.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// <p>The <code>ChangeSetSummary</code> structure describes a change set, its status, and the stack with which it's associated.</p>
4#[non_exhaustive]
5#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
6pub struct ChangeSetSummary {
7    /// <p>The ID of the stack with which the change set is associated.</p>
8    pub stack_id: ::std::option::Option<::std::string::String>,
9    /// <p>The name of the stack with which the change set is associated.</p>
10    pub stack_name: ::std::option::Option<::std::string::String>,
11    /// <p>The ID of the change set.</p>
12    pub change_set_id: ::std::option::Option<::std::string::String>,
13    /// <p>The name of the change set.</p>
14    pub change_set_name: ::std::option::Option<::std::string::String>,
15    /// <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>
16    pub execution_status: ::std::option::Option<crate::types::ExecutionStatus>,
17    /// <p>The state of the change set, such as <code>CREATE_PENDING</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>
18    pub status: ::std::option::Option<crate::types::ChangeSetStatus>,
19    /// <p>A description of the change set's status. For example, if your change set is in the <code>FAILED</code> state, CloudFormation shows the error message.</p>
20    pub status_reason: ::std::option::Option<::std::string::String>,
21    /// <p>The start time when the change set was created, in UTC.</p>
22    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
23    /// <p>Descriptive information about the change set.</p>
24    pub description: ::std::option::Option<::std::string::String>,
25    /// <p>Specifies the current setting of <code>IncludeNestedStacks</code> for the change set.</p>
26    pub include_nested_stacks: ::std::option::Option<bool>,
27    /// <p>The parent change set ID.</p>
28    pub parent_change_set_id: ::std::option::Option<::std::string::String>,
29    /// <p>The root change set ID.</p>
30    pub root_change_set_id: ::std::option::Option<::std::string::String>,
31    /// <p>Indicates if the change set imports resources that already exist.</p>
32    pub import_existing_resources: ::std::option::Option<bool>,
33}
34impl ChangeSetSummary {
35    /// <p>The ID of the stack with which the change set is associated.</p>
36    pub fn stack_id(&self) -> ::std::option::Option<&str> {
37        self.stack_id.as_deref()
38    }
39    /// <p>The name of the stack with which the change set is associated.</p>
40    pub fn stack_name(&self) -> ::std::option::Option<&str> {
41        self.stack_name.as_deref()
42    }
43    /// <p>The ID of the change set.</p>
44    pub fn change_set_id(&self) -> ::std::option::Option<&str> {
45        self.change_set_id.as_deref()
46    }
47    /// <p>The name of the change set.</p>
48    pub fn change_set_name(&self) -> ::std::option::Option<&str> {
49        self.change_set_name.as_deref()
50    }
51    /// <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>
52    pub fn execution_status(&self) -> ::std::option::Option<&crate::types::ExecutionStatus> {
53        self.execution_status.as_ref()
54    }
55    /// <p>The state of the change set, such as <code>CREATE_PENDING</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>
56    pub fn status(&self) -> ::std::option::Option<&crate::types::ChangeSetStatus> {
57        self.status.as_ref()
58    }
59    /// <p>A description of the change set's status. For example, if your change set is in the <code>FAILED</code> state, CloudFormation shows the error message.</p>
60    pub fn status_reason(&self) -> ::std::option::Option<&str> {
61        self.status_reason.as_deref()
62    }
63    /// <p>The start time when the change set was created, in UTC.</p>
64    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
65        self.creation_time.as_ref()
66    }
67    /// <p>Descriptive information about the change set.</p>
68    pub fn description(&self) -> ::std::option::Option<&str> {
69        self.description.as_deref()
70    }
71    /// <p>Specifies the current setting of <code>IncludeNestedStacks</code> for the change set.</p>
72    pub fn include_nested_stacks(&self) -> ::std::option::Option<bool> {
73        self.include_nested_stacks
74    }
75    /// <p>The parent change set ID.</p>
76    pub fn parent_change_set_id(&self) -> ::std::option::Option<&str> {
77        self.parent_change_set_id.as_deref()
78    }
79    /// <p>The root change set ID.</p>
80    pub fn root_change_set_id(&self) -> ::std::option::Option<&str> {
81        self.root_change_set_id.as_deref()
82    }
83    /// <p>Indicates if the change set imports resources that already exist.</p>
84    pub fn import_existing_resources(&self) -> ::std::option::Option<bool> {
85        self.import_existing_resources
86    }
87}
88impl ChangeSetSummary {
89    /// Creates a new builder-style object to manufacture [`ChangeSetSummary`](crate::types::ChangeSetSummary).
90    pub fn builder() -> crate::types::builders::ChangeSetSummaryBuilder {
91        crate::types::builders::ChangeSetSummaryBuilder::default()
92    }
93}
94
95/// A builder for [`ChangeSetSummary`](crate::types::ChangeSetSummary).
96#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
97#[non_exhaustive]
98pub struct ChangeSetSummaryBuilder {
99    pub(crate) stack_id: ::std::option::Option<::std::string::String>,
100    pub(crate) stack_name: ::std::option::Option<::std::string::String>,
101    pub(crate) change_set_id: ::std::option::Option<::std::string::String>,
102    pub(crate) change_set_name: ::std::option::Option<::std::string::String>,
103    pub(crate) execution_status: ::std::option::Option<crate::types::ExecutionStatus>,
104    pub(crate) status: ::std::option::Option<crate::types::ChangeSetStatus>,
105    pub(crate) status_reason: ::std::option::Option<::std::string::String>,
106    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
107    pub(crate) description: ::std::option::Option<::std::string::String>,
108    pub(crate) include_nested_stacks: ::std::option::Option<bool>,
109    pub(crate) parent_change_set_id: ::std::option::Option<::std::string::String>,
110    pub(crate) root_change_set_id: ::std::option::Option<::std::string::String>,
111    pub(crate) import_existing_resources: ::std::option::Option<bool>,
112}
113impl ChangeSetSummaryBuilder {
114    /// <p>The ID of the stack with which the change set is associated.</p>
115    pub fn stack_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116        self.stack_id = ::std::option::Option::Some(input.into());
117        self
118    }
119    /// <p>The ID of the stack with which the change set is associated.</p>
120    pub fn set_stack_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121        self.stack_id = input;
122        self
123    }
124    /// <p>The ID of the stack with which the change set is associated.</p>
125    pub fn get_stack_id(&self) -> &::std::option::Option<::std::string::String> {
126        &self.stack_id
127    }
128    /// <p>The name of the stack with which the change set is associated.</p>
129    pub fn stack_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
130        self.stack_name = ::std::option::Option::Some(input.into());
131        self
132    }
133    /// <p>The name of the stack with which the change set is associated.</p>
134    pub fn set_stack_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
135        self.stack_name = input;
136        self
137    }
138    /// <p>The name of the stack with which the change set is associated.</p>
139    pub fn get_stack_name(&self) -> &::std::option::Option<::std::string::String> {
140        &self.stack_name
141    }
142    /// <p>The ID of the change set.</p>
143    pub fn change_set_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
144        self.change_set_id = ::std::option::Option::Some(input.into());
145        self
146    }
147    /// <p>The ID of the change set.</p>
148    pub fn set_change_set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
149        self.change_set_id = input;
150        self
151    }
152    /// <p>The ID of the change set.</p>
153    pub fn get_change_set_id(&self) -> &::std::option::Option<::std::string::String> {
154        &self.change_set_id
155    }
156    /// <p>The name of the change set.</p>
157    pub fn change_set_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
158        self.change_set_name = ::std::option::Option::Some(input.into());
159        self
160    }
161    /// <p>The name of the change set.</p>
162    pub fn set_change_set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
163        self.change_set_name = input;
164        self
165    }
166    /// <p>The name of the change set.</p>
167    pub fn get_change_set_name(&self) -> &::std::option::Option<::std::string::String> {
168        &self.change_set_name
169    }
170    /// <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>
171    pub fn execution_status(mut self, input: crate::types::ExecutionStatus) -> Self {
172        self.execution_status = ::std::option::Option::Some(input);
173        self
174    }
175    /// <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>
176    pub fn set_execution_status(mut self, input: ::std::option::Option<crate::types::ExecutionStatus>) -> Self {
177        self.execution_status = input;
178        self
179    }
180    /// <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>
181    pub fn get_execution_status(&self) -> &::std::option::Option<crate::types::ExecutionStatus> {
182        &self.execution_status
183    }
184    /// <p>The state of the change set, such as <code>CREATE_PENDING</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>
185    pub fn status(mut self, input: crate::types::ChangeSetStatus) -> Self {
186        self.status = ::std::option::Option::Some(input);
187        self
188    }
189    /// <p>The state of the change set, such as <code>CREATE_PENDING</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>
190    pub fn set_status(mut self, input: ::std::option::Option<crate::types::ChangeSetStatus>) -> Self {
191        self.status = input;
192        self
193    }
194    /// <p>The state of the change set, such as <code>CREATE_PENDING</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>
195    pub fn get_status(&self) -> &::std::option::Option<crate::types::ChangeSetStatus> {
196        &self.status
197    }
198    /// <p>A description of the change set's status. For example, if your change set is in the <code>FAILED</code> state, CloudFormation shows the error message.</p>
199    pub fn status_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
200        self.status_reason = ::std::option::Option::Some(input.into());
201        self
202    }
203    /// <p>A description of the change set's status. For example, if your change set is in the <code>FAILED</code> state, CloudFormation shows the error message.</p>
204    pub fn set_status_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
205        self.status_reason = input;
206        self
207    }
208    /// <p>A description of the change set's status. For example, if your change set is in the <code>FAILED</code> state, CloudFormation shows the error message.</p>
209    pub fn get_status_reason(&self) -> &::std::option::Option<::std::string::String> {
210        &self.status_reason
211    }
212    /// <p>The start time when the change set was created, in UTC.</p>
213    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
214        self.creation_time = ::std::option::Option::Some(input);
215        self
216    }
217    /// <p>The start time when the change set was created, in UTC.</p>
218    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
219        self.creation_time = input;
220        self
221    }
222    /// <p>The start time when the change set was created, in UTC.</p>
223    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
224        &self.creation_time
225    }
226    /// <p>Descriptive information about the change set.</p>
227    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
228        self.description = ::std::option::Option::Some(input.into());
229        self
230    }
231    /// <p>Descriptive information about the change set.</p>
232    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
233        self.description = input;
234        self
235    }
236    /// <p>Descriptive information about the change set.</p>
237    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
238        &self.description
239    }
240    /// <p>Specifies the current setting of <code>IncludeNestedStacks</code> for the change set.</p>
241    pub fn include_nested_stacks(mut self, input: bool) -> Self {
242        self.include_nested_stacks = ::std::option::Option::Some(input);
243        self
244    }
245    /// <p>Specifies the current setting of <code>IncludeNestedStacks</code> for the change set.</p>
246    pub fn set_include_nested_stacks(mut self, input: ::std::option::Option<bool>) -> Self {
247        self.include_nested_stacks = input;
248        self
249    }
250    /// <p>Specifies the current setting of <code>IncludeNestedStacks</code> for the change set.</p>
251    pub fn get_include_nested_stacks(&self) -> &::std::option::Option<bool> {
252        &self.include_nested_stacks
253    }
254    /// <p>The parent change set ID.</p>
255    pub fn parent_change_set_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
256        self.parent_change_set_id = ::std::option::Option::Some(input.into());
257        self
258    }
259    /// <p>The parent change set ID.</p>
260    pub fn set_parent_change_set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
261        self.parent_change_set_id = input;
262        self
263    }
264    /// <p>The parent change set ID.</p>
265    pub fn get_parent_change_set_id(&self) -> &::std::option::Option<::std::string::String> {
266        &self.parent_change_set_id
267    }
268    /// <p>The root change set ID.</p>
269    pub fn root_change_set_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
270        self.root_change_set_id = ::std::option::Option::Some(input.into());
271        self
272    }
273    /// <p>The root change set ID.</p>
274    pub fn set_root_change_set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
275        self.root_change_set_id = input;
276        self
277    }
278    /// <p>The root change set ID.</p>
279    pub fn get_root_change_set_id(&self) -> &::std::option::Option<::std::string::String> {
280        &self.root_change_set_id
281    }
282    /// <p>Indicates if the change set imports resources that already exist.</p>
283    pub fn import_existing_resources(mut self, input: bool) -> Self {
284        self.import_existing_resources = ::std::option::Option::Some(input);
285        self
286    }
287    /// <p>Indicates if the change set imports resources that already exist.</p>
288    pub fn set_import_existing_resources(mut self, input: ::std::option::Option<bool>) -> Self {
289        self.import_existing_resources = input;
290        self
291    }
292    /// <p>Indicates if the change set imports resources that already exist.</p>
293    pub fn get_import_existing_resources(&self) -> &::std::option::Option<bool> {
294        &self.import_existing_resources
295    }
296    /// Consumes the builder and constructs a [`ChangeSetSummary`](crate::types::ChangeSetSummary).
297    pub fn build(self) -> crate::types::ChangeSetSummary {
298        crate::types::ChangeSetSummary {
299            stack_id: self.stack_id,
300            stack_name: self.stack_name,
301            change_set_id: self.change_set_id,
302            change_set_name: self.change_set_name,
303            execution_status: self.execution_status,
304            status: self.status,
305            status_reason: self.status_reason,
306            creation_time: self.creation_time,
307            description: self.description,
308            include_nested_stacks: self.include_nested_stacks,
309            parent_change_set_id: self.parent_change_set_id,
310            root_change_set_id: self.root_change_set_id,
311            import_existing_resources: self.import_existing_resources,
312        }
313    }
314}
aws_sdk_cloudformation/types/_change_set_summary.rs

aws_sdk_cloudformation/types/
_change_set_summary.rs
