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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>The input for the <code>ExecuteChangeSet</code> action.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ExecuteChangeSetInput {
/// <p>The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.</p>
pub change_set_name: ::std::option::Option<::std::string::String>,
/// <p>If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.</p>
pub stack_name: ::std::option::Option<::std::string::String>,
/// <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully received them.</p>
pub client_request_token: ::std::option::Option<::std::string::String>,
/// <p>Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation was specified.</p>
/// <ul>
/// <li>
/// <p><code>True</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>DO_NOTHING</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p></li>
/// <li>
/// <p><code>False</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>ROLLBACK</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p></li>
/// </ul>
/// <p>Default: <code>True</code></p>
pub disable_rollback: ::std::option::Option<bool>,
/// <p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p>
/// <p>Default: <code>false</code></p>
pub retain_except_on_create: ::std::option::Option<bool>,
}
impl ExecuteChangeSetInput {
/// <p>The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.</p>
pub fn change_set_name(&self) -> ::std::option::Option<&str> {
self.change_set_name.as_deref()
}
/// <p>If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.</p>
pub fn stack_name(&self) -> ::std::option::Option<&str> {
self.stack_name.as_deref()
}
/// <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully received them.</p>
pub fn client_request_token(&self) -> ::std::option::Option<&str> {
self.client_request_token.as_deref()
}
/// <p>Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation was specified.</p>
/// <ul>
/// <li>
/// <p><code>True</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>DO_NOTHING</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p></li>
/// <li>
/// <p><code>False</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>ROLLBACK</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p></li>
/// </ul>
/// <p>Default: <code>True</code></p>
pub fn disable_rollback(&self) -> ::std::option::Option<bool> {
self.disable_rollback
}
/// <p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p>
/// <p>Default: <code>false</code></p>
pub fn retain_except_on_create(&self) -> ::std::option::Option<bool> {
self.retain_except_on_create
}
}
impl ExecuteChangeSetInput {
/// Creates a new builder-style object to manufacture [`ExecuteChangeSetInput`](crate::operation::execute_change_set::ExecuteChangeSetInput).
pub fn builder() -> crate::operation::execute_change_set::builders::ExecuteChangeSetInputBuilder {
crate::operation::execute_change_set::builders::ExecuteChangeSetInputBuilder::default()
}
}
/// A builder for [`ExecuteChangeSetInput`](crate::operation::execute_change_set::ExecuteChangeSetInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct ExecuteChangeSetInputBuilder {
pub(crate) change_set_name: ::std::option::Option<::std::string::String>,
pub(crate) stack_name: ::std::option::Option<::std::string::String>,
pub(crate) client_request_token: ::std::option::Option<::std::string::String>,
pub(crate) disable_rollback: ::std::option::Option<bool>,
pub(crate) retain_except_on_create: ::std::option::Option<bool>,
}
impl ExecuteChangeSetInputBuilder {
/// <p>The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.</p>
/// This field is required.
pub fn change_set_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.change_set_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.</p>
pub fn set_change_set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.change_set_name = input;
self
}
/// <p>The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.</p>
pub fn get_change_set_name(&self) -> &::std::option::Option<::std::string::String> {
&self.change_set_name
}
/// <p>If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.</p>
pub fn stack_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.stack_name = ::std::option::Option::Some(input.into());
self
}
/// <p>If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.</p>
pub fn set_stack_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.stack_name = input;
self
}
/// <p>If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.</p>
pub fn get_stack_name(&self) -> &::std::option::Option<::std::string::String> {
&self.stack_name
}
/// <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully received them.</p>
pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.client_request_token = ::std::option::Option::Some(input.into());
self
}
/// <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully received them.</p>
pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_request_token = input;
self
}
/// <p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully received them.</p>
pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
&self.client_request_token
}
/// <p>Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation was specified.</p>
/// <ul>
/// <li>
/// <p><code>True</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>DO_NOTHING</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p></li>
/// <li>
/// <p><code>False</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>ROLLBACK</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p></li>
/// </ul>
/// <p>Default: <code>True</code></p>
pub fn disable_rollback(mut self, input: bool) -> Self {
self.disable_rollback = ::std::option::Option::Some(input);
self
}
/// <p>Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation was specified.</p>
/// <ul>
/// <li>
/// <p><code>True</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>DO_NOTHING</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p></li>
/// <li>
/// <p><code>False</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>ROLLBACK</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p></li>
/// </ul>
/// <p>Default: <code>True</code></p>
pub fn set_disable_rollback(mut self, input: ::std::option::Option<bool>) -> Self {
self.disable_rollback = input;
self
}
/// <p>Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation was specified.</p>
/// <ul>
/// <li>
/// <p><code>True</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>DO_NOTHING</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p></li>
/// <li>
/// <p><code>False</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>ROLLBACK</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p></li>
/// </ul>
/// <p>Default: <code>True</code></p>
pub fn get_disable_rollback(&self) -> &::std::option::Option<bool> {
&self.disable_rollback
}
/// <p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p>
/// <p>Default: <code>false</code></p>
pub fn retain_except_on_create(mut self, input: bool) -> Self {
self.retain_except_on_create = ::std::option::Option::Some(input);
self
}
/// <p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p>
/// <p>Default: <code>false</code></p>
pub fn set_retain_except_on_create(mut self, input: ::std::option::Option<bool>) -> Self {
self.retain_except_on_create = input;
self
}
/// <p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p>
/// <p>Default: <code>false</code></p>
pub fn get_retain_except_on_create(&self) -> &::std::option::Option<bool> {
&self.retain_except_on_create
}
/// Consumes the builder and constructs a [`ExecuteChangeSetInput`](crate::operation::execute_change_set::ExecuteChangeSetInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::execute_change_set::ExecuteChangeSetInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::execute_change_set::ExecuteChangeSetInput {
change_set_name: self.change_set_name,
stack_name: self.stack_name,
client_request_token: self.client_request_token,
disable_rollback: self.disable_rollback,
retain_except_on_create: self.retain_except_on_create,
})
}
}