aws_sdk_directconnect/operation/start_bgp_failover_test/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_bgp_failover_test::_start_bgp_failover_test_output::StartBgpFailoverTestOutputBuilder;
3
4pub use crate::operation::start_bgp_failover_test::_start_bgp_failover_test_input::StartBgpFailoverTestInputBuilder;
5
6impl crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestInputBuilder {
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_bgp_failover_test::StartBgpFailoverTestOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_bgp_failover_test::StartBgpFailoverTestError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_bgp_failover_test();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartBgpFailoverTest`.
24///
25/// <p>Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.</p>
26/// <p>You can run the test on public, private, transit, and hosted virtual interfaces.</p>
27/// <p>You can use <a href="https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ListVirtualInterfaceTestHistory.html">ListVirtualInterfaceTestHistory</a> to view the virtual interface test history.</p>
28/// <p>If you need to stop the test before the test interval completes, use <a href="https://docs.aws.amazon.com/directconnect/latest/APIReference/API_StopBgpFailoverTest.html">StopBgpFailoverTest</a>.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct StartBgpFailoverTestFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::start_bgp_failover_test::StartBgpFailoverTestOutput,
38        crate::operation::start_bgp_failover_test::StartBgpFailoverTestError,
39    > for StartBgpFailoverTestFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::start_bgp_failover_test::StartBgpFailoverTestOutput,
47            crate::operation::start_bgp_failover_test::StartBgpFailoverTestError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl StartBgpFailoverTestFluentBuilder {
54    /// Creates a new `StartBgpFailoverTestFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the StartBgpFailoverTest as a reference.
63    pub fn as_input(&self) -> &crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::start_bgp_failover_test::StartBgpFailoverTestOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::start_bgp_failover_test::StartBgpFailoverTestError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::start_bgp_failover_test::StartBgpFailoverTest::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::start_bgp_failover_test::StartBgpFailoverTest::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::start_bgp_failover_test::StartBgpFailoverTestOutput,
100        crate::operation::start_bgp_failover_test::StartBgpFailoverTestError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// <p>The ID of the virtual interface you want to test.</p>
115    pub fn virtual_interface_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116        self.inner = self.inner.virtual_interface_id(input.into());
117        self
118    }
119    /// <p>The ID of the virtual interface you want to test.</p>
120    pub fn set_virtual_interface_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121        self.inner = self.inner.set_virtual_interface_id(input);
122        self
123    }
124    /// <p>The ID of the virtual interface you want to test.</p>
125    pub fn get_virtual_interface_id(&self) -> &::std::option::Option<::std::string::String> {
126        self.inner.get_virtual_interface_id()
127    }
128    ///
129    /// Appends an item to `bgpPeers`.
130    ///
131    /// To override the contents of this collection use [`set_bgp_peers`](Self::set_bgp_peers).
132    ///
133    /// <p>The BGP peers to place in the DOWN state.</p>
134    pub fn bgp_peers(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
135        self.inner = self.inner.bgp_peers(input.into());
136        self
137    }
138    /// <p>The BGP peers to place in the DOWN state.</p>
139    pub fn set_bgp_peers(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
140        self.inner = self.inner.set_bgp_peers(input);
141        self
142    }
143    /// <p>The BGP peers to place in the DOWN state.</p>
144    pub fn get_bgp_peers(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
145        self.inner.get_bgp_peers()
146    }
147    /// <p>The time in minutes that the virtual interface failover test will last.</p>
148    /// <p>Maximum value: 4,320 minutes (72 hours).</p>
149    /// <p>Default: 180 minutes (3 hours).</p>
150    pub fn test_duration_in_minutes(mut self, input: i32) -> Self {
151        self.inner = self.inner.test_duration_in_minutes(input);
152        self
153    }
154    /// <p>The time in minutes that the virtual interface failover test will last.</p>
155    /// <p>Maximum value: 4,320 minutes (72 hours).</p>
156    /// <p>Default: 180 minutes (3 hours).</p>
157    pub fn set_test_duration_in_minutes(mut self, input: ::std::option::Option<i32>) -> Self {
158        self.inner = self.inner.set_test_duration_in_minutes(input);
159        self
160    }
161    /// <p>The time in minutes that the virtual interface failover test will last.</p>
162    /// <p>Maximum value: 4,320 minutes (72 hours).</p>
163    /// <p>Default: 180 minutes (3 hours).</p>
164    pub fn get_test_duration_in_minutes(&self) -> &::std::option::Option<i32> {
165        self.inner.get_test_duration_in_minutes()
166    }
167}
aws_sdk_directconnect/operation/start_bgp_failover_test/builders.rs

aws_sdk_directconnect/operation/start_bgp_failover_test/
builders.rs
