aws_sdk_arcregionswitch/operation/start_plan_execution/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_plan_execution::_start_plan_execution_output::StartPlanExecutionOutputBuilder;
3
4pub use crate::operation::start_plan_execution::_start_plan_execution_input::StartPlanExecutionInputBuilder;
5
6impl crate::operation::start_plan_execution::builders::StartPlanExecutionInputBuilder {
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::start_plan_execution::StartPlanExecutionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_plan_execution::StartPlanExecutionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_plan_execution();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartPlanExecution`.
24///
25/// <p>Starts the execution of a Region switch plan. You can execute a plan in either PRACTICE or RECOVERY mode.</p>
26/// <p>In PRACTICE mode, the execution simulates the steps without making actual changes to your application's traffic routing. In RECOVERY mode, the execution performs actual changes to shift traffic between Regions.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct StartPlanExecutionFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::start_plan_execution::builders::StartPlanExecutionInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::start_plan_execution::StartPlanExecutionOutput,
36        crate::operation::start_plan_execution::StartPlanExecutionError,
37    > for StartPlanExecutionFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::start_plan_execution::StartPlanExecutionOutput,
45            crate::operation::start_plan_execution::StartPlanExecutionError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl StartPlanExecutionFluentBuilder {
52    /// Creates a new `StartPlanExecutionFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the StartPlanExecution as a reference.
61    pub fn as_input(&self) -> &crate::operation::start_plan_execution::builders::StartPlanExecutionInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::start_plan_execution::StartPlanExecutionOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::start_plan_execution::StartPlanExecutionError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::start_plan_execution::StartPlanExecution::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::start_plan_execution::StartPlanExecution::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::start_plan_execution::StartPlanExecutionOutput,
98        crate::operation::start_plan_execution::StartPlanExecutionError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>The Amazon Resource Name (ARN) of the plan to execute.</p>
113    pub fn plan_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.plan_arn(input.into());
115        self
116    }
117    /// <p>The Amazon Resource Name (ARN) of the plan to execute.</p>
118    pub fn set_plan_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_plan_arn(input);
120        self
121    }
122    /// <p>The Amazon Resource Name (ARN) of the plan to execute.</p>
123    pub fn get_plan_arn(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_plan_arn()
125    }
126    /// <p>The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.</p>
127    pub fn target_region(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.target_region(input.into());
129        self
130    }
131    /// <p>The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.</p>
132    pub fn set_target_region(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_target_region(input);
134        self
135    }
136    /// <p>The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.</p>
137    pub fn get_target_region(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_target_region()
139    }
140    /// <p>The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).</p>
141    pub fn action(mut self, input: crate::types::ExecutionAction) -> Self {
142        self.inner = self.inner.action(input);
143        self
144    }
145    /// <p>The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).</p>
146    pub fn set_action(mut self, input: ::std::option::Option<crate::types::ExecutionAction>) -> Self {
147        self.inner = self.inner.set_action(input);
148        self
149    }
150    /// <p>The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).</p>
151    pub fn get_action(&self) -> &::std::option::Option<crate::types::ExecutionAction> {
152        self.inner.get_action()
153    }
154    /// <p>The plan execution mode. Valid values are <code>Practice</code>, for testing without making actual changes, or <code>Recovery</code>, for actual traffic shifting and application recovery.</p>
155    pub fn mode(mut self, input: crate::types::ExecutionMode) -> Self {
156        self.inner = self.inner.mode(input);
157        self
158    }
159    /// <p>The plan execution mode. Valid values are <code>Practice</code>, for testing without making actual changes, or <code>Recovery</code>, for actual traffic shifting and application recovery.</p>
160    pub fn set_mode(mut self, input: ::std::option::Option<crate::types::ExecutionMode>) -> Self {
161        self.inner = self.inner.set_mode(input);
162        self
163    }
164    /// <p>The plan execution mode. Valid values are <code>Practice</code>, for testing without making actual changes, or <code>Recovery</code>, for actual traffic shifting and application recovery.</p>
165    pub fn get_mode(&self) -> &::std::option::Option<crate::types::ExecutionMode> {
166        self.inner.get_mode()
167    }
168    /// <p>An optional comment explaining why the plan execution is being started.</p>
169    pub fn comment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
170        self.inner = self.inner.comment(input.into());
171        self
172    }
173    /// <p>An optional comment explaining why the plan execution is being started.</p>
174    pub fn set_comment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
175        self.inner = self.inner.set_comment(input);
176        self
177    }
178    /// <p>An optional comment explaining why the plan execution is being started.</p>
179    pub fn get_comment(&self) -> &::std::option::Option<::std::string::String> {
180        self.inner.get_comment()
181    }
182    /// <p>A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.</p>
183    pub fn latest_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
184        self.inner = self.inner.latest_version(input.into());
185        self
186    }
187    /// <p>A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.</p>
188    pub fn set_latest_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
189        self.inner = self.inner.set_latest_version(input);
190        self
191    }
192    /// <p>A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.</p>
193    pub fn get_latest_version(&self) -> &::std::option::Option<::std::string::String> {
194        self.inner.get_latest_version()
195    }
196}
aws_sdk_arcregionswitch/operation/start_plan_execution/builders.rs

aws_sdk_arcregionswitch/operation/start_plan_execution/
builders.rs
