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.Types.BGPPeer

Description

Synopsis

data BGPPeer = BGPPeer' {
- customerAddress :: Maybe Text
- amazonAddress :: Maybe Text
- addressFamily :: Maybe AddressFamily
- awsLogicalDeviceId :: Maybe Text
- bgpStatus :: Maybe BGPStatus
- asn :: Maybe Int
- authKey :: Maybe Text
- bgpPeerId :: Maybe Text
- bgpPeerState :: Maybe BGPPeerState
- awsDeviceV2 :: Maybe Text
}
newBGPPeer :: BGPPeer
bGPPeer_customerAddress :: Lens' BGPPeer (Maybe Text)
bGPPeer_amazonAddress :: Lens' BGPPeer (Maybe Text)
bGPPeer_addressFamily :: Lens' BGPPeer (Maybe AddressFamily)
bGPPeer_awsLogicalDeviceId :: Lens' BGPPeer (Maybe Text)
bGPPeer_bgpStatus :: Lens' BGPPeer (Maybe BGPStatus)
bGPPeer_asn :: Lens' BGPPeer (Maybe Int)
bGPPeer_authKey :: Lens' BGPPeer (Maybe Text)
bGPPeer_bgpPeerId :: Lens' BGPPeer (Maybe Text)
bGPPeer_bgpPeerState :: Lens' BGPPeer (Maybe BGPPeerState)
bGPPeer_awsDeviceV2 :: Lens' BGPPeer (Maybe Text)

Documentation

data BGPPeer Source #

Information about a BGP peer.

See: newBGPPeer smart constructor.

Constructors

BGPPeer'

Fields

customerAddress :: Maybe Text
The IP address assigned to the customer interface.
amazonAddress :: Maybe Text
The IP address assigned to the Amazon interface.
addressFamily :: Maybe AddressFamily
The address family for the BGP peer.
awsLogicalDeviceId :: Maybe Text
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
bgpStatus :: Maybe BGPStatus
The status of the BGP peer. The following are the possible values:
- up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
- down: The BGP peer is down.
- unknown: The BGP peer status is not available.
asn :: Maybe Int
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey :: Maybe Text
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
bgpPeerId :: Maybe Text
The ID of the BGP peer.
bgpPeerState :: Maybe BGPPeerState
The state of the BGP peer. The following are the possible values:
- verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
- pending: The BGP peer is created, and remains in this state until it is ready to be established.
- available: The BGP peer is ready to be established.
- deleting: The BGP peer is being deleted.
- deleted: The BGP peer is deleted and cannot be established.
awsDeviceV2 :: Maybe Text
The Direct Connect endpoint that terminates the BGP peer.

Instances

Instances details

Eq BGPPeer Source #
Instance details Defined in Amazonka.DirectConnect.Types.BGPPeer Methods (==) :: BGPPeer -> BGPPeer -> Bool # (/=) :: BGPPeer -> BGPPeer -> Bool #
Read BGPPeer Source #
Instance details Defined in Amazonka.DirectConnect.Types.BGPPeer Methods readsPrec :: Int -> ReadS BGPPeer # readList :: ReadS [BGPPeer] # readPrec :: ReadPrec BGPPeer # readListPrec :: ReadPrec [BGPPeer] #
Show BGPPeer Source #
Instance details Defined in Amazonka.DirectConnect.Types.BGPPeer Methods showsPrec :: Int -> BGPPeer -> ShowS # show :: BGPPeer -> String # showList :: [BGPPeer] -> ShowS #
Generic BGPPeer Source #
Instance details Defined in Amazonka.DirectConnect.Types.BGPPeer Associated Types type Rep BGPPeer :: Type -> Type # Methods from :: BGPPeer -> Rep BGPPeer x # to :: Rep BGPPeer x -> BGPPeer #
NFData BGPPeer Source #
Instance details Defined in Amazonka.DirectConnect.Types.BGPPeer Methods rnf :: BGPPeer -> () #
Hashable BGPPeer Source #
Instance details Defined in Amazonka.DirectConnect.Types.BGPPeer Methods hashWithSalt :: Int -> BGPPeer -> Int # hash :: BGPPeer -> Int #
FromJSON BGPPeer Source #
Instance details Defined in Amazonka.DirectConnect.Types.BGPPeer Methods parseJSON :: Value -> Parser BGPPeer # parseJSONList :: Value -> Parser [BGPPeer] #
type Rep BGPPeer Source #
Instance details Defined in Amazonka.DirectConnect.Types.BGPPeer type Rep BGPPeer = D1 ('MetaData "BGPPeer" "Amazonka.DirectConnect.Types.BGPPeer" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "BGPPeer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customerAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "amazonAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "addressFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AddressFamily)) :: (S1 ('MetaSel ('Just "awsLogicalDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "bgpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BGPStatus))))) :: ((S1 ('MetaSel ('Just "asn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "authKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "bgpPeerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "bgpPeerState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BGPPeerState)) :*: S1 ('MetaSel ('Just "awsDeviceV2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newBGPPeer :: BGPPeer Source #

Create a value of BGPPeer 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:customerAddress:BGPPeer', bGPPeer_customerAddress - The IP address assigned to the customer interface.

$sel:amazonAddress:BGPPeer', bGPPeer_amazonAddress - The IP address assigned to the Amazon interface.

$sel:addressFamily:BGPPeer', bGPPeer_addressFamily - The address family for the BGP peer.

$sel:awsLogicalDeviceId:BGPPeer', bGPPeer_awsLogicalDeviceId - The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

$sel:bgpStatus:BGPPeer', bGPPeer_bgpStatus - The status of the BGP peer. The following are the possible values:

up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down: The BGP peer is down.
unknown: The BGP peer status is not available.

$sel:asn:BGPPeer', bGPPeer_asn - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

$sel:authKey:BGPPeer', bGPPeer_authKey - The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

$sel:bgpPeerId:BGPPeer', bGPPeer_bgpPeerId - The ID of the BGP peer.

$sel:bgpPeerState:BGPPeer', bGPPeer_bgpPeerState - The state of the BGP peer. The following are the possible values:

verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending: The BGP peer is created, and remains in this state until it is ready to be established.
available: The BGP peer is ready to be established.
deleting: The BGP peer is being deleted.
deleted: The BGP peer is deleted and cannot be established.

$sel:awsDeviceV2:BGPPeer', bGPPeer_awsDeviceV2 - The Direct Connect endpoint that terminates the BGP peer.

bGPPeer_customerAddress :: Lens' BGPPeer (Maybe Text) Source #

The IP address assigned to the customer interface.

bGPPeer_amazonAddress :: Lens' BGPPeer (Maybe Text) Source #

The IP address assigned to the Amazon interface.

bGPPeer_addressFamily :: Lens' BGPPeer (Maybe AddressFamily) Source #

The address family for the BGP peer.

bGPPeer_awsLogicalDeviceId :: Lens' BGPPeer (Maybe Text) Source #

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

bGPPeer_bgpStatus :: Lens' BGPPeer (Maybe BGPStatus) Source #

The status of the BGP peer. The following are the possible values:

up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down: The BGP peer is down.
unknown: The BGP peer status is not available.

bGPPeer_asn :: Lens' BGPPeer (Maybe Int) Source #

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

bGPPeer_authKey :: Lens' BGPPeer (Maybe Text) Source #

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

bGPPeer_bgpPeerId :: Lens' BGPPeer (Maybe Text) Source #

The ID of the BGP peer.

bGPPeer_bgpPeerState :: Lens' BGPPeer (Maybe BGPPeerState) Source #

The state of the BGP peer. The following are the possible values:

verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending: The BGP peer is created, and remains in this state until it is ready to be established.
available: The BGP peer is ready to be established.
deleting: The BGP peer is being deleted.
deleted: The BGP peer is deleted and cannot be established.

bGPPeer_awsDeviceV2 :: Lens' BGPPeer (Maybe Text) Source #

The Direct Connect endpoint that terminates the BGP peer.