aws_sdk_directconnect/client/
start_bgp_failover_test.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`StartBgpFailoverTest`](crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`virtual_interface_id(impl Into<String>)`](crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestFluentBuilder::virtual_interface_id) / [`set_virtual_interface_id(Option<String>)`](crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestFluentBuilder::set_virtual_interface_id):<br>required: **true**<br><p>The ID of the virtual interface you want to test.</p><br>
7    ///   - [`bgp_peers(impl Into<String>)`](crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestFluentBuilder::bgp_peers) / [`set_bgp_peers(Option<Vec::<String>>)`](crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestFluentBuilder::set_bgp_peers):<br>required: **false**<br><p>The BGP peers to place in the DOWN state.</p><br>
8    ///   - [`test_duration_in_minutes(i32)`](crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestFluentBuilder::test_duration_in_minutes) / [`set_test_duration_in_minutes(Option<i32>)`](crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestFluentBuilder::set_test_duration_in_minutes):<br>required: **false**<br><p>The time in minutes that the virtual interface failover test will last.</p> <p>Maximum value: 4,320 minutes (72 hours).</p> <p>Default: 180 minutes (3 hours).</p><br>
9    /// - On success, responds with [`StartBgpFailoverTestOutput`](crate::operation::start_bgp_failover_test::StartBgpFailoverTestOutput) with field(s):
10    ///   - [`virtual_interface_test(Option<VirtualInterfaceTestHistory>)`](crate::operation::start_bgp_failover_test::StartBgpFailoverTestOutput::virtual_interface_test): <p>Information about the virtual interface failover test.</p>
11    /// - On failure, responds with [`SdkError<StartBgpFailoverTestError>`](crate::operation::start_bgp_failover_test::StartBgpFailoverTestError)
12    pub fn start_bgp_failover_test(&self) -> crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestFluentBuilder {
13        crate::operation::start_bgp_failover_test::builders::StartBgpFailoverTestFluentBuilder::new(self.handle.clone())
14    }
15}