aws_sdk_m2/operation/update_environment/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_environment::_update_environment_output::UpdateEnvironmentOutputBuilder;
3
4pub use crate::operation::update_environment::_update_environment_input::UpdateEnvironmentInputBuilder;
5
6impl crate::operation::update_environment::builders::UpdateEnvironmentInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::update_environment::UpdateEnvironmentOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_environment::UpdateEnvironmentError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_environment();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateEnvironment`.
24///
25/// <p>Updates the configuration details for a specific runtime environment.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct UpdateEnvironmentFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::update_environment::builders::UpdateEnvironmentInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::update_environment::UpdateEnvironmentOutput,
35        crate::operation::update_environment::UpdateEnvironmentError,
36    > for UpdateEnvironmentFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::update_environment::UpdateEnvironmentOutput,
44            crate::operation::update_environment::UpdateEnvironmentError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl UpdateEnvironmentFluentBuilder {
51    /// Creates a new `UpdateEnvironmentFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the UpdateEnvironment as a reference.
60    pub fn as_input(&self) -> &crate::operation::update_environment::builders::UpdateEnvironmentInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::update_environment::UpdateEnvironmentOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::update_environment::UpdateEnvironmentError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::update_environment::UpdateEnvironment::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::update_environment::UpdateEnvironment::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::update_environment::UpdateEnvironmentOutput,
97        crate::operation::update_environment::UpdateEnvironmentError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The unique identifier of the runtime environment that you want to update.</p>
112    pub fn environment_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.environment_id(input.into());
114        self
115    }
116    /// <p>The unique identifier of the runtime environment that you want to update.</p>
117    pub fn set_environment_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_environment_id(input);
119        self
120    }
121    /// <p>The unique identifier of the runtime environment that you want to update.</p>
122    pub fn get_environment_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_environment_id()
124    }
125    /// <p>The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.</p>
126    pub fn desired_capacity(mut self, input: i32) -> Self {
127        self.inner = self.inner.desired_capacity(input);
128        self
129    }
130    /// <p>The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.</p>
131    pub fn set_desired_capacity(mut self, input: ::std::option::Option<i32>) -> Self {
132        self.inner = self.inner.set_desired_capacity(input);
133        self
134    }
135    /// <p>The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.</p>
136    pub fn get_desired_capacity(&self) -> &::std::option::Option<i32> {
137        self.inner.get_desired_capacity()
138    }
139    /// <p>The instance type for the runtime environment to update.</p>
140    pub fn instance_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.instance_type(input.into());
142        self
143    }
144    /// <p>The instance type for the runtime environment to update.</p>
145    pub fn set_instance_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_instance_type(input);
147        self
148    }
149    /// <p>The instance type for the runtime environment to update.</p>
150    pub fn get_instance_type(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_instance_type()
152    }
153    /// <p>The version of the runtime engine for the runtime environment.</p>
154    pub fn engine_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.engine_version(input.into());
156        self
157    }
158    /// <p>The version of the runtime engine for the runtime environment.</p>
159    pub fn set_engine_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_engine_version(input);
161        self
162    }
163    /// <p>The version of the runtime engine for the runtime environment.</p>
164    pub fn get_engine_version(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_engine_version()
166    }
167    /// <p>Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format <code>ddd:hh24:mi-ddd:hh24:mi</code> and must be less than 24 hours. The following two examples are valid maintenance windows: <code>sun:23:45-mon:00:15</code> or <code>sat:01:00-sat:03:00</code>.</p>
168    /// <p>If you do not provide a value, a random system-generated value will be assigned.</p>
169    pub fn preferred_maintenance_window(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
170        self.inner = self.inner.preferred_maintenance_window(input.into());
171        self
172    }
173    /// <p>Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format <code>ddd:hh24:mi-ddd:hh24:mi</code> and must be less than 24 hours. The following two examples are valid maintenance windows: <code>sun:23:45-mon:00:15</code> or <code>sat:01:00-sat:03:00</code>.</p>
174    /// <p>If you do not provide a value, a random system-generated value will be assigned.</p>
175    pub fn set_preferred_maintenance_window(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176        self.inner = self.inner.set_preferred_maintenance_window(input);
177        self
178    }
179    /// <p>Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format <code>ddd:hh24:mi-ddd:hh24:mi</code> and must be less than 24 hours. The following two examples are valid maintenance windows: <code>sun:23:45-mon:00:15</code> or <code>sat:01:00-sat:03:00</code>.</p>
180    /// <p>If you do not provide a value, a random system-generated value will be assigned.</p>
181    pub fn get_preferred_maintenance_window(&self) -> &::std::option::Option<::std::string::String> {
182        self.inner.get_preferred_maintenance_window()
183    }
184    /// <p>Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the <code>engineVersion</code> parameter only if <code>applyDuringMaintenanceWindow</code> is true. If any parameter other than <code>engineVersion</code> is provided in <code>UpdateEnvironmentRequest</code>, it will fail if <code>applyDuringMaintenanceWindow</code> is set to true.</p>
185    pub fn apply_during_maintenance_window(mut self, input: bool) -> Self {
186        self.inner = self.inner.apply_during_maintenance_window(input);
187        self
188    }
189    /// <p>Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the <code>engineVersion</code> parameter only if <code>applyDuringMaintenanceWindow</code> is true. If any parameter other than <code>engineVersion</code> is provided in <code>UpdateEnvironmentRequest</code>, it will fail if <code>applyDuringMaintenanceWindow</code> is set to true.</p>
190    pub fn set_apply_during_maintenance_window(mut self, input: ::std::option::Option<bool>) -> Self {
191        self.inner = self.inner.set_apply_during_maintenance_window(input);
192        self
193    }
194    /// <p>Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the <code>engineVersion</code> parameter only if <code>applyDuringMaintenanceWindow</code> is true. If any parameter other than <code>engineVersion</code> is provided in <code>UpdateEnvironmentRequest</code>, it will fail if <code>applyDuringMaintenanceWindow</code> is set to true.</p>
195    pub fn get_apply_during_maintenance_window(&self) -> &::std::option::Option<bool> {
196        self.inner.get_apply_during_maintenance_window()
197    }
198    /// <p>Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.</p>
199    /// <p>If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.</p>
200    /// <p>This option is not needed if the attribute being updated is <code>preferredMaintenanceWindow</code>.</p>
201    pub fn force_update(mut self, input: bool) -> Self {
202        self.inner = self.inner.force_update(input);
203        self
204    }
205    /// <p>Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.</p>
206    /// <p>If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.</p>
207    /// <p>This option is not needed if the attribute being updated is <code>preferredMaintenanceWindow</code>.</p>
208    pub fn set_force_update(mut self, input: ::std::option::Option<bool>) -> Self {
209        self.inner = self.inner.set_force_update(input);
210        self
211    }
212    /// <p>Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.</p>
213    /// <p>If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.</p>
214    /// <p>This option is not needed if the attribute being updated is <code>preferredMaintenanceWindow</code>.</p>
215    pub fn get_force_update(&self) -> &::std::option::Option<bool> {
216        self.inner.get_force_update()
217    }
218}