Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StartBgpFailoverTestCommand

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.

example

Use a bare-bones client and the command you need to make an API call.

import { DirectConnectClient, StartBgpFailoverTestCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, StartBgpFailoverTestCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const command = new StartBgpFailoverTestCommand(input);
const response = await client.send(command);
see

StartBgpFailoverTestCommandInput for command's input shape.

see

StartBgpFailoverTestCommandOutput for command's response shape.

see

config for DirectConnectClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: StartBgpFailoverTestCommandInput

Readonly middlewareStack

Methods

Static getEndpointParameterInstructions