Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DirectConnect.StartBgpFailoverTest

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data StartBgpFailoverTest Source #

See: newStartBgpFailoverTest smart constructor.

Constructors

StartBgpFailoverTest'
Fields bgpPeers :: Maybe [Text] The BGP peers to place in the DOWN state. testDurationInMinutes :: Maybe Int The time in minutes that the virtual interface failover test will last. Maximum value: 180 minutes (3 hours). Default: 180 minutes (3 hours). virtualInterfaceId :: Text The ID of the virtual interface you want to test.

Instances

Instances details

Eq StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods (==) :: StartBgpFailoverTest -> StartBgpFailoverTest -> Bool # (/=) :: StartBgpFailoverTest -> StartBgpFailoverTest -> Bool #
Read StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods readsPrec :: Int -> ReadS StartBgpFailoverTest # readList :: ReadS [StartBgpFailoverTest] # readPrec :: ReadPrec StartBgpFailoverTest # readListPrec :: ReadPrec [StartBgpFailoverTest] #
Show StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods showsPrec :: Int -> StartBgpFailoverTest -> ShowS # show :: StartBgpFailoverTest -> String # showList :: [StartBgpFailoverTest] -> ShowS #
Generic StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Associated Types type Rep StartBgpFailoverTest :: Type -> Type # Methods from :: StartBgpFailoverTest -> Rep StartBgpFailoverTest x # to :: Rep StartBgpFailoverTest x -> StartBgpFailoverTest #
NFData StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods rnf :: StartBgpFailoverTest -> () #
Hashable StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods hashWithSalt :: Int -> StartBgpFailoverTest -> Int # hash :: StartBgpFailoverTest -> Int #
ToJSON StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods toJSON :: StartBgpFailoverTest -> Value # toEncoding :: StartBgpFailoverTest -> Encoding # toJSONList :: [StartBgpFailoverTest] -> Value # toEncodingList :: [StartBgpFailoverTest] -> Encoding #
AWSRequest StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Associated Types type AWSResponse StartBgpFailoverTest # Methods request :: StartBgpFailoverTest -> Request StartBgpFailoverTest # response :: MonadResource m => Logger -> Service -> Proxy StartBgpFailoverTest -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartBgpFailoverTest))) #
ToHeaders StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods toHeaders :: StartBgpFailoverTest -> [Header] #
ToPath StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods toPath :: StartBgpFailoverTest -> ByteString #
ToQuery StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods toQuery :: StartBgpFailoverTest -> QueryString #
type Rep StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest type Rep StartBgpFailoverTest = D1 ('MetaData "StartBgpFailoverTest" "Amazonka.DirectConnect.StartBgpFailoverTest" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "StartBgpFailoverTest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bgpPeers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "testDurationInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "virtualInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StartBgpFailoverTest Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest type AWSResponse StartBgpFailoverTest = StartBgpFailoverTestResponse

newStartBgpFailoverTest Source #

Arguments

:: Text	`$sel:virtualInterfaceId:StartBgpFailoverTest'`
-> StartBgpFailoverTest

Create a value of StartBgpFailoverTest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bgpPeers:StartBgpFailoverTest', startBgpFailoverTest_bgpPeers - The BGP peers to place in the DOWN state.

$sel:testDurationInMinutes:StartBgpFailoverTest', startBgpFailoverTest_testDurationInMinutes - The time in minutes that the virtual interface failover test will last.

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

$sel:virtualInterfaceId:StartBgpFailoverTest', startBgpFailoverTest_virtualInterfaceId - The ID of the virtual interface you want to test.

Request Lenses

startBgpFailoverTest_bgpPeers :: Lens' StartBgpFailoverTest (Maybe [Text]) Source #

The BGP peers to place in the DOWN state.

startBgpFailoverTest_testDurationInMinutes :: Lens' StartBgpFailoverTest (Maybe Int) Source #

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

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

startBgpFailoverTest_virtualInterfaceId :: Lens' StartBgpFailoverTest Text Source #

The ID of the virtual interface you want to test.

Destructuring the Response

data StartBgpFailoverTestResponse Source #

See: newStartBgpFailoverTestResponse smart constructor.

Constructors

StartBgpFailoverTestResponse'
Fields virtualInterfaceTest :: Maybe VirtualInterfaceTestHistory Information about the virtual interface failover test. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartBgpFailoverTestResponse Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods (==) :: StartBgpFailoverTestResponse -> StartBgpFailoverTestResponse -> Bool # (/=) :: StartBgpFailoverTestResponse -> StartBgpFailoverTestResponse -> Bool #
Read StartBgpFailoverTestResponse Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods readsPrec :: Int -> ReadS StartBgpFailoverTestResponse # readList :: ReadS [StartBgpFailoverTestResponse] # readPrec :: ReadPrec StartBgpFailoverTestResponse # readListPrec :: ReadPrec [StartBgpFailoverTestResponse] #
Show StartBgpFailoverTestResponse Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods showsPrec :: Int -> StartBgpFailoverTestResponse -> ShowS # show :: StartBgpFailoverTestResponse -> String # showList :: [StartBgpFailoverTestResponse] -> ShowS #
Generic StartBgpFailoverTestResponse Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Associated Types type Rep StartBgpFailoverTestResponse :: Type -> Type # Methods from :: StartBgpFailoverTestResponse -> Rep StartBgpFailoverTestResponse x # to :: Rep StartBgpFailoverTestResponse x -> StartBgpFailoverTestResponse #
NFData StartBgpFailoverTestResponse Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest Methods rnf :: StartBgpFailoverTestResponse -> () #
type Rep StartBgpFailoverTestResponse Source #
Instance details Defined in Amazonka.DirectConnect.StartBgpFailoverTest type Rep StartBgpFailoverTestResponse = D1 ('MetaData "StartBgpFailoverTestResponse" "Amazonka.DirectConnect.StartBgpFailoverTest" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "StartBgpFailoverTestResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "virtualInterfaceTest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VirtualInterfaceTestHistory)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartBgpFailoverTestResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartBgpFailoverTestResponse'`
-> StartBgpFailoverTestResponse

Create a value of StartBgpFailoverTestResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:virtualInterfaceTest:StartBgpFailoverTestResponse', startBgpFailoverTestResponse_virtualInterfaceTest - Information about the virtual interface failover test.

$sel:httpStatus:StartBgpFailoverTestResponse', startBgpFailoverTestResponse_httpStatus - The response's http status code.

Response Lenses

startBgpFailoverTestResponse_virtualInterfaceTest :: Lens' StartBgpFailoverTestResponse (Maybe VirtualInterfaceTestHistory) Source #

Information about the virtual interface failover test.

startBgpFailoverTestResponse_httpStatus :: Lens' StartBgpFailoverTestResponse Int Source #

The response's http status code.