Class StartBgpFailoverTestCommandProtected

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 input = { // StartBgpFailoverTestRequest
  virtualInterfaceId: "STRING_VALUE", // required
  bgpPeers: [ // BGPPeerIdList
    "STRING_VALUE",
  ],
  testDurationInMinutes: Number("int"),
};
const command = new StartBgpFailoverTestCommand(input);
const response = await client.send(command);
// { // StartBgpFailoverTestResponse
//   virtualInterfaceTest: { // VirtualInterfaceTestHistory
//     testId: "STRING_VALUE",
//     virtualInterfaceId: "STRING_VALUE",
//     bgpPeers: [ // BGPPeerIdList
//       "STRING_VALUE",
//     ],
//     status: "STRING_VALUE",
//     ownerAccount: "STRING_VALUE",
//     testDurationInMinutes: Number("int"),
//     startTime: new Date("TIMESTAMP"),
//     endTime: new Date("TIMESTAMP"),
//   },
// };

Param

StartBgpFailoverTestCommandInput

Returns

StartBgpFailoverTestCommandOutput

See

• StartBgpFailoverTestCommandInput for command's input shape.
• StartBgpFailoverTestCommandOutput for command's response shape.
• config for DirectConnectClient's config shape.

Throws

DirectConnectClientException (client fault)

One or more parameters are not valid.

Throws

DirectConnectServerException (server fault)

A server-side error occurred.

Throws

DirectConnectServiceException

Base exception class for all service exceptions from DirectConnect service.