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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Synopsis

data CreatePrivateVirtualInterface = CreatePrivateVirtualInterface' {
- connectionId :: Text
- newPrivateVirtualInterface' :: NewPrivateVirtualInterface
}
newCreatePrivateVirtualInterface :: Text -> NewPrivateVirtualInterface -> CreatePrivateVirtualInterface
createPrivateVirtualInterface_connectionId :: Lens' CreatePrivateVirtualInterface Text
createPrivateVirtualInterface_newPrivateVirtualInterface :: Lens' CreatePrivateVirtualInterface NewPrivateVirtualInterface
data VirtualInterface = VirtualInterface' {
- bgpPeers :: Maybe [BGPPeer]
- virtualGatewayId :: Maybe Text
- mtu :: Maybe Int
- routeFilterPrefixes :: Maybe [RouteFilterPrefix]
- customerAddress :: Maybe Text
- vlan :: Maybe Int
- location :: Maybe Text
- amazonAddress :: Maybe Text
- addressFamily :: Maybe AddressFamily
- virtualInterfaceState :: Maybe VirtualInterfaceState
- connectionId :: Maybe Text
- awsLogicalDeviceId :: Maybe Text
- directConnectGatewayId :: Maybe Text
- amazonSideAsn :: Maybe Integer
- virtualInterfaceType :: Maybe Text
- asn :: Maybe Int
- authKey :: Maybe Text
- jumboFrameCapable :: Maybe Bool
- customerRouterConfig :: Maybe Text
- ownerAccount :: Maybe Text
- region :: Maybe Text
- virtualInterfaceName :: Maybe Text
- awsDeviceV2 :: Maybe Text
- virtualInterfaceId :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
}
newVirtualInterface :: VirtualInterface
virtualInterface_bgpPeers :: Lens' VirtualInterface (Maybe [BGPPeer])
virtualInterface_virtualGatewayId :: Lens' VirtualInterface (Maybe Text)
virtualInterface_mtu :: Lens' VirtualInterface (Maybe Int)
virtualInterface_routeFilterPrefixes :: Lens' VirtualInterface (Maybe [RouteFilterPrefix])
virtualInterface_customerAddress :: Lens' VirtualInterface (Maybe Text)
virtualInterface_vlan :: Lens' VirtualInterface (Maybe Int)
virtualInterface_location :: Lens' VirtualInterface (Maybe Text)
virtualInterface_amazonAddress :: Lens' VirtualInterface (Maybe Text)
virtualInterface_addressFamily :: Lens' VirtualInterface (Maybe AddressFamily)
virtualInterface_virtualInterfaceState :: Lens' VirtualInterface (Maybe VirtualInterfaceState)
virtualInterface_connectionId :: Lens' VirtualInterface (Maybe Text)
virtualInterface_awsLogicalDeviceId :: Lens' VirtualInterface (Maybe Text)
virtualInterface_directConnectGatewayId :: Lens' VirtualInterface (Maybe Text)
virtualInterface_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer)
virtualInterface_virtualInterfaceType :: Lens' VirtualInterface (Maybe Text)
virtualInterface_asn :: Lens' VirtualInterface (Maybe Int)
virtualInterface_authKey :: Lens' VirtualInterface (Maybe Text)
virtualInterface_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool)
virtualInterface_customerRouterConfig :: Lens' VirtualInterface (Maybe Text)
virtualInterface_ownerAccount :: Lens' VirtualInterface (Maybe Text)
virtualInterface_region :: Lens' VirtualInterface (Maybe Text)
virtualInterface_virtualInterfaceName :: Lens' VirtualInterface (Maybe Text)
virtualInterface_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text)
virtualInterface_virtualInterfaceId :: Lens' VirtualInterface (Maybe Text)
virtualInterface_tags :: Lens' VirtualInterface (Maybe (NonEmpty Tag))

Creating a Request

data CreatePrivateVirtualInterface Source #

See: newCreatePrivateVirtualInterface smart constructor.

Constructors

CreatePrivateVirtualInterface'
Fields connectionId :: Text The ID of the connection. newPrivateVirtualInterface' :: NewPrivateVirtualInterface Information about the private virtual interface.

Instances

Instances details

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

newCreatePrivateVirtualInterface Source #

Arguments

:: Text	`$sel:connectionId:CreatePrivateVirtualInterface'`
-> NewPrivateVirtualInterface	`$sel:newPrivateVirtualInterface':CreatePrivateVirtualInterface'`
-> CreatePrivateVirtualInterface

Create a value of CreatePrivateVirtualInterface 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:connectionId:CreatePrivateVirtualInterface', createPrivateVirtualInterface_connectionId - The ID of the connection.

$sel:newPrivateVirtualInterface':CreatePrivateVirtualInterface', createPrivateVirtualInterface_newPrivateVirtualInterface - Information about the private virtual interface.

Request Lenses

createPrivateVirtualInterface_connectionId :: Lens' CreatePrivateVirtualInterface Text Source #

The ID of the connection.

createPrivateVirtualInterface_newPrivateVirtualInterface :: Lens' CreatePrivateVirtualInterface NewPrivateVirtualInterface Source #

Information about the private virtual interface.

Destructuring the Response

data VirtualInterface Source #

Information about a virtual interface.

See: newVirtualInterface smart constructor.

Constructors

VirtualInterface'

Fields

bgpPeers :: Maybe [BGPPeer]
The BGP peers configured on this virtual interface.
virtualGatewayId :: Maybe Text
The ID of the virtual private gateway. Applies only to private virtual interfaces.
mtu :: Maybe Int
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
routeFilterPrefixes :: Maybe [RouteFilterPrefix]
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
customerAddress :: Maybe Text
The IP address assigned to the customer interface.
vlan :: Maybe Int
The ID of the VLAN.
location :: Maybe Text
The location of the connection.
amazonAddress :: Maybe Text
The IP address assigned to the Amazon interface.
addressFamily :: Maybe AddressFamily
The address family for the BGP peer.
virtualInterfaceState :: Maybe VirtualInterfaceState
The state of the virtual interface. The following are the possible values:
- confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
- verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
- pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
- available: A virtual interface that is able to forward traffic.
- down: A virtual interface that is BGP down.
- deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
- deleted: A virtual interface that cannot forward traffic.
- rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
- unknown: The state of the virtual interface is not available.
connectionId :: Maybe Text
The ID of the connection.
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.
directConnectGatewayId :: Maybe Text
The ID of the Direct Connect gateway.
amazonSideAsn :: Maybe Integer
The autonomous system number (ASN) for the Amazon side of the connection.
virtualInterfaceType :: Maybe Text
The type of virtual interface. The possible values are private and public.
asn :: Maybe Int
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
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.
jumboFrameCapable :: Maybe Bool
Indicates whether jumbo frames (9001 MTU) are supported.
customerRouterConfig :: Maybe Text
The customer router configuration.
ownerAccount :: Maybe Text
The ID of the Amazon Web Services account that owns the virtual interface.
region :: Maybe Text
The Amazon Web Services Region where the virtual interface is located.
virtualInterfaceName :: Maybe Text
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
awsDeviceV2 :: Maybe Text
The Direct Connect endpoint that terminates the physical connection.
virtualInterfaceId :: Maybe Text
The ID of the virtual interface.
tags :: Maybe (NonEmpty Tag)
The tags associated with the virtual interface.

Instances

Instances details

Eq VirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.Types.VirtualInterface Methods (==) :: VirtualInterface -> VirtualInterface -> Bool # (/=) :: VirtualInterface -> VirtualInterface -> Bool #
Read VirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.Types.VirtualInterface Methods readsPrec :: Int -> ReadS VirtualInterface # readList :: ReadS [VirtualInterface] # readPrec :: ReadPrec VirtualInterface # readListPrec :: ReadPrec [VirtualInterface] #
Show VirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.Types.VirtualInterface Methods showsPrec :: Int -> VirtualInterface -> ShowS # show :: VirtualInterface -> String # showList :: [VirtualInterface] -> ShowS #
Generic VirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.Types.VirtualInterface Associated Types type Rep VirtualInterface :: Type -> Type # Methods from :: VirtualInterface -> Rep VirtualInterface x # to :: Rep VirtualInterface x -> VirtualInterface #
NFData VirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.Types.VirtualInterface Methods rnf :: VirtualInterface -> () #
Hashable VirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.Types.VirtualInterface Methods hashWithSalt :: Int -> VirtualInterface -> Int # hash :: VirtualInterface -> Int #
FromJSON VirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.Types.VirtualInterface Methods parseJSON :: Value -> Parser VirtualInterface # parseJSONList :: Value -> Parser [VirtualInterface] #
type Rep VirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.Types.VirtualInterface type Rep VirtualInterface = D1 ('MetaData "VirtualInterface" "Amazonka.DirectConnect.Types.VirtualInterface" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "VirtualInterface'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "bgpPeers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BGPPeer])) :: (S1 ('MetaSel ('Just "virtualGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "mtu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "routeFilterPrefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RouteFilterPrefix])) :: (S1 ('MetaSel ('Just "customerAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "vlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "location") '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 "virtualInterfaceState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VirtualInterfaceState)) :: (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "awsLogicalDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "directConnectGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "amazonSideAsn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "virtualInterfaceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "asn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "authKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jumboFrameCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "customerRouterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "virtualInterfaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "awsDeviceV2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "virtualInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))))))))

newVirtualInterface :: VirtualInterface Source #

Create a value of VirtualInterface 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:VirtualInterface', virtualInterface_bgpPeers - The BGP peers configured on this virtual interface.

$sel:virtualGatewayId:VirtualInterface', virtualInterface_virtualGatewayId - The ID of the virtual private gateway. Applies only to private virtual interfaces.

$sel:mtu:VirtualInterface', virtualInterface_mtu - The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

$sel:routeFilterPrefixes:VirtualInterface', virtualInterface_routeFilterPrefixes - The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

$sel:customerAddress:VirtualInterface', virtualInterface_customerAddress - The IP address assigned to the customer interface.

$sel:vlan:VirtualInterface', virtualInterface_vlan - The ID of the VLAN.

$sel:location:VirtualInterface', virtualInterface_location - The location of the connection.

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

$sel:addressFamily:VirtualInterface', virtualInterface_addressFamily - The address family for the BGP peer.

$sel:virtualInterfaceState:VirtualInterface', virtualInterface_virtualInterfaceState - The state of the virtual interface. The following are the possible values:

confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.

$sel:connectionId:VirtualInterface', virtualInterface_connectionId - The ID of the connection.

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

$sel:directConnectGatewayId:VirtualInterface', virtualInterface_directConnectGatewayId - The ID of the Direct Connect gateway.

$sel:amazonSideAsn:VirtualInterface', virtualInterface_amazonSideAsn - The autonomous system number (ASN) for the Amazon side of the connection.

$sel:virtualInterfaceType:VirtualInterface', virtualInterface_virtualInterfaceType - The type of virtual interface. The possible values are private and public.

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

The valid values are 1-2147483647.

$sel:authKey:VirtualInterface', virtualInterface_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:jumboFrameCapable:VirtualInterface', virtualInterface_jumboFrameCapable - Indicates whether jumbo frames (9001 MTU) are supported.

$sel:customerRouterConfig:VirtualInterface', virtualInterface_customerRouterConfig - The customer router configuration.

$sel:ownerAccount:VirtualInterface', virtualInterface_ownerAccount - The ID of the Amazon Web Services account that owns the virtual interface.

$sel:region:VirtualInterface', virtualInterface_region - The Amazon Web Services Region where the virtual interface is located.

$sel:virtualInterfaceName:VirtualInterface', virtualInterface_virtualInterfaceName - The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

$sel:awsDeviceV2:VirtualInterface', virtualInterface_awsDeviceV2 - The Direct Connect endpoint that terminates the physical connection.

$sel:virtualInterfaceId:VirtualInterface', virtualInterface_virtualInterfaceId - The ID of the virtual interface.

$sel:tags:VirtualInterface', virtualInterface_tags - The tags associated with the virtual interface.

Response Lenses

virtualInterface_bgpPeers :: Lens' VirtualInterface (Maybe [BGPPeer]) Source #

The BGP peers configured on this virtual interface.

virtualInterface_virtualGatewayId :: Lens' VirtualInterface (Maybe Text) Source #

The ID of the virtual private gateway. Applies only to private virtual interfaces.

virtualInterface_mtu :: Lens' VirtualInterface (Maybe Int) Source #

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

virtualInterface_routeFilterPrefixes :: Lens' VirtualInterface (Maybe [RouteFilterPrefix]) Source #

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

virtualInterface_customerAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

virtualInterface_vlan :: Lens' VirtualInterface (Maybe Int) Source #

The ID of the VLAN.

virtualInterface_location :: Lens' VirtualInterface (Maybe Text) Source #

The location of the connection.

virtualInterface_amazonAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the Amazon interface.

virtualInterface_addressFamily :: Lens' VirtualInterface (Maybe AddressFamily) Source #

The address family for the BGP peer.

virtualInterface_virtualInterfaceState :: Lens' VirtualInterface (Maybe VirtualInterfaceState) Source #

The state of the virtual interface. The following are the possible values:

confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
available: A virtual interface that is able to forward traffic.
down: A virtual interface that is BGP down.
deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
deleted: A virtual interface that cannot forward traffic.
rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
unknown: The state of the virtual interface is not available.

virtualInterface_connectionId :: Lens' VirtualInterface (Maybe Text) Source #

The ID of the connection.

virtualInterface_awsLogicalDeviceId :: Lens' VirtualInterface (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.

virtualInterface_directConnectGatewayId :: Lens' VirtualInterface (Maybe Text) Source #

The ID of the Direct Connect gateway.

virtualInterface_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer) Source #

The autonomous system number (ASN) for the Amazon side of the connection.

virtualInterface_virtualInterfaceType :: Lens' VirtualInterface (Maybe Text) Source #

The type of virtual interface. The possible values are private and public.

virtualInterface_asn :: Lens' VirtualInterface (Maybe Int) Source #

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

The valid values are 1-2147483647.

virtualInterface_authKey :: Lens' VirtualInterface (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.

virtualInterface_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

virtualInterface_customerRouterConfig :: Lens' VirtualInterface (Maybe Text) Source #

The customer router configuration.

virtualInterface_ownerAccount :: Lens' VirtualInterface (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the virtual interface.

virtualInterface_region :: Lens' VirtualInterface (Maybe Text) Source #

The Amazon Web Services Region where the virtual interface is located.

virtualInterface_virtualInterfaceName :: Lens' VirtualInterface (Maybe Text) Source #

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

virtualInterface_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

virtualInterface_virtualInterfaceId :: Lens' VirtualInterface (Maybe Text) Source #

The ID of the virtual interface.

virtualInterface_tags :: Lens' VirtualInterface (Maybe (NonEmpty Tag)) Source #

The tags associated with the virtual interface.