Struct aws_sdk_directconnect::client::fluent_builders::StartBgpFailoverTest

pub struct StartBgpFailoverTest<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to StartBgpFailoverTest.

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.

You can run the test on public, private, transit, and hosted virtual interfaces.

You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.

If you need to stop the test before the test interval completes, use StopBgpFailoverTest.

Implementations

impl<C, M, R> StartBgpFailoverTest<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<StartBgpFailoverTestOutput, SdkError<StartBgpFailoverTestError>> where
    R::Policy: SmithyRetryPolicy<StartBgpFailoverTestInputOperationOutputAlias, StartBgpFailoverTestOutput, StartBgpFailoverTestError, StartBgpFailoverTestInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn virtual_interface_id(self, inp: impl Into<String>) -> Self

The ID of the virtual interface you want to test.

pub fn set_virtual_interface_id(self, input: Option<String>) -> Self

The ID of the virtual interface you want to test.

pub fn bgp_peers(self, inp: impl Into<String>) -> Self

Appends an item to bgpPeers.

To override the contents of this collection use set_bgp_peers.

The BGP peers to place in the DOWN state.

pub fn set_bgp_peers(self, input: Option<Vec<String>>) -> Self

The BGP peers to place in the DOWN state.

pub fn test_duration_in_minutes(self, inp: i32) -> Self

The time in minutes that the virtual interface failover test will last.

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

pub fn set_test_duration_in_minutes(self, input: Option<i32>) -> Self

The time in minutes that the virtual interface failover test will last.

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for StartBgpFailoverTest<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.