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.CreateBGPPeer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a BGP peer on the specified virtual interface.

You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.

Creating a Request

data CreateBGPPeer Source #

See: newCreateBGPPeer smart constructor.

Constructors

CreateBGPPeer'
Fields newBGPPeer' :: Maybe NewBGPPeer Information about the BGP peer. virtualInterfaceId :: Maybe Text The ID of the virtual interface.

Instances

Instances details

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

newCreateBGPPeer :: CreateBGPPeer Source #

Create a value of CreateBGPPeer 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:newBGPPeer':CreateBGPPeer', createBGPPeer_newBGPPeer - Information about the BGP peer.

$sel:virtualInterfaceId:CreateBGPPeer', createBGPPeer_virtualInterfaceId - The ID of the virtual interface.

Request Lenses

createBGPPeer_newBGPPeer :: Lens' CreateBGPPeer (Maybe NewBGPPeer) Source #

Information about the BGP peer.

createBGPPeer_virtualInterfaceId :: Lens' CreateBGPPeer (Maybe Text) Source #

The ID of the virtual interface.

Destructuring the Response

data CreateBGPPeerResponse Source #

See: newCreateBGPPeerResponse smart constructor.

Constructors

CreateBGPPeerResponse'
Fields virtualInterface :: Maybe VirtualInterface The virtual interface. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateBGPPeerResponse Source #

Arguments

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

Create a value of CreateBGPPeerResponse 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:virtualInterface:CreateBGPPeerResponse', createBGPPeerResponse_virtualInterface - The virtual interface.

$sel:httpStatus:CreateBGPPeerResponse', createBGPPeerResponse_httpStatus - The response's http status code.

Response Lenses

createBGPPeerResponse_virtualInterface :: Lens' CreateBGPPeerResponse (Maybe VirtualInterface) Source #

The virtual interface.

createBGPPeerResponse_httpStatus :: Lens' CreateBGPPeerResponse Int Source #

The response's http status code.