Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.DirectConnect.AllocatePrivateVirtualInterface

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provisions a private virtual interface to be owned by another AWS customer.

Virtual interfaces created using this action must be confirmed by the virtual interface owner by using the ConfirmPrivateVirtualInterface action. Until then, the virtual interface will be in Confirming state, and will not be available for handling traffic.

Synopsis

allocatePrivateVirtualInterface :: Text -> Text -> NewPrivateVirtualInterfaceAllocation -> AllocatePrivateVirtualInterface
data AllocatePrivateVirtualInterface
apviConnectionId :: Lens' AllocatePrivateVirtualInterface Text
apviOwnerAccount :: Lens' AllocatePrivateVirtualInterface Text
apviNewPrivateVirtualInterfaceAllocation :: Lens' AllocatePrivateVirtualInterface NewPrivateVirtualInterfaceAllocation
virtualInterface :: VirtualInterface
data VirtualInterface
viBgpPeers :: Lens' VirtualInterface [BGPPeer]
viVirtualGatewayId :: Lens' VirtualInterface (Maybe Text)
viRouteFilterPrefixes :: Lens' VirtualInterface [RouteFilterPrefix]
viCustomerAddress :: Lens' VirtualInterface (Maybe Text)
viVlan :: Lens' VirtualInterface (Maybe Int)
viLocation :: Lens' VirtualInterface (Maybe Text)
viAmazonAddress :: Lens' VirtualInterface (Maybe Text)
viAddressFamily :: Lens' VirtualInterface (Maybe AddressFamily)
viVirtualInterfaceState :: Lens' VirtualInterface (Maybe VirtualInterfaceState)
viConnectionId :: Lens' VirtualInterface (Maybe Text)
viDirectConnectGatewayId :: Lens' VirtualInterface (Maybe Text)
viAmazonSideASN :: Lens' VirtualInterface (Maybe Integer)
viVirtualInterfaceType :: Lens' VirtualInterface (Maybe Text)
viAsn :: Lens' VirtualInterface (Maybe Int)
viAuthKey :: Lens' VirtualInterface (Maybe Text)
viCustomerRouterConfig :: Lens' VirtualInterface (Maybe Text)
viOwnerAccount :: Lens' VirtualInterface (Maybe Text)
viVirtualInterfaceName :: Lens' VirtualInterface (Maybe Text)
viVirtualInterfaceId :: Lens' VirtualInterface (Maybe Text)

Creating a Request

allocatePrivateVirtualInterface #

Arguments

:: Text	`apviConnectionId`
-> Text	`apviOwnerAccount`
-> NewPrivateVirtualInterfaceAllocation	`apviNewPrivateVirtualInterfaceAllocation`
-> AllocatePrivateVirtualInterface

Creates a value of AllocatePrivateVirtualInterface with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

apviConnectionId - The connection ID on which the private virtual interface is provisioned. Default: None
apviOwnerAccount - The AWS account that will own the new private virtual interface. Default: None
apviNewPrivateVirtualInterfaceAllocation - Detailed information for the private virtual interface to be provisioned. Default: None

data AllocatePrivateVirtualInterface #

Container for the parameters to the AllocatePrivateVirtualInterface operation.

See: allocatePrivateVirtualInterface smart constructor.

Instances

Eq AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Methods (==) :: AllocatePrivateVirtualInterface -> AllocatePrivateVirtualInterface -> Bool # (/=) :: AllocatePrivateVirtualInterface -> AllocatePrivateVirtualInterface -> Bool #
Data AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AllocatePrivateVirtualInterface -> c AllocatePrivateVirtualInterface # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AllocatePrivateVirtualInterface # toConstr :: AllocatePrivateVirtualInterface -> Constr # dataTypeOf :: AllocatePrivateVirtualInterface -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AllocatePrivateVirtualInterface) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AllocatePrivateVirtualInterface) # gmapT :: (forall b. Data b => b -> b) -> AllocatePrivateVirtualInterface -> AllocatePrivateVirtualInterface # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AllocatePrivateVirtualInterface -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AllocatePrivateVirtualInterface -> r # gmapQ :: (forall d. Data d => d -> u) -> AllocatePrivateVirtualInterface -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AllocatePrivateVirtualInterface -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AllocatePrivateVirtualInterface -> m AllocatePrivateVirtualInterface # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AllocatePrivateVirtualInterface -> m AllocatePrivateVirtualInterface # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AllocatePrivateVirtualInterface -> m AllocatePrivateVirtualInterface #
Read AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Methods readsPrec :: Int -> ReadS AllocatePrivateVirtualInterface # readList :: ReadS [AllocatePrivateVirtualInterface] # readPrec :: ReadPrec AllocatePrivateVirtualInterface # readListPrec :: ReadPrec [AllocatePrivateVirtualInterface] #
Show AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Methods showsPrec :: Int -> AllocatePrivateVirtualInterface -> ShowS # show :: AllocatePrivateVirtualInterface -> String # showList :: [AllocatePrivateVirtualInterface] -> ShowS #
Generic AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Associated Types type Rep AllocatePrivateVirtualInterface :: * -> * # Methods from :: AllocatePrivateVirtualInterface -> Rep AllocatePrivateVirtualInterface x # to :: Rep AllocatePrivateVirtualInterface x -> AllocatePrivateVirtualInterface #
Hashable AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Methods hashWithSalt :: Int -> AllocatePrivateVirtualInterface -> Int # hash :: AllocatePrivateVirtualInterface -> Int #
ToJSON AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Methods toJSON :: AllocatePrivateVirtualInterface -> Value # toEncoding :: AllocatePrivateVirtualInterface -> Encoding # toJSONList :: [AllocatePrivateVirtualInterface] -> Value # toEncodingList :: [AllocatePrivateVirtualInterface] -> Encoding #
AWSRequest AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Associated Types type Rs AllocatePrivateVirtualInterface :: * # Methods request :: AllocatePrivateVirtualInterface -> Request AllocatePrivateVirtualInterface # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy AllocatePrivateVirtualInterface -> ClientResponse -> m (Response AllocatePrivateVirtualInterface) #
ToHeaders AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Methods toHeaders :: AllocatePrivateVirtualInterface -> [Header] #
ToPath AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Methods toPath :: AllocatePrivateVirtualInterface -> ByteString #
ToQuery AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Methods toQuery :: AllocatePrivateVirtualInterface -> QueryString #
NFData AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface Methods rnf :: AllocatePrivateVirtualInterface -> () #
type Rep AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface type Rep AllocatePrivateVirtualInterface = D1 (MetaData "AllocatePrivateVirtualInterface" "Network.AWS.DirectConnect.AllocatePrivateVirtualInterface" "amazonka-directconnect-1.6.0-4mkgeEVXt4W3NTCklIzKwd" False) (C1 (MetaCons "AllocatePrivateVirtualInterface'" PrefixI True) (S1 (MetaSel (Just "_apviConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_apviOwnerAccount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_apviNewPrivateVirtualInterfaceAllocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NewPrivateVirtualInterfaceAllocation))))
type Rs AllocatePrivateVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePrivateVirtualInterface type Rs AllocatePrivateVirtualInterface = VirtualInterface

Request Lenses

apviConnectionId :: Lens' AllocatePrivateVirtualInterface Text #

The connection ID on which the private virtual interface is provisioned. Default: None

apviOwnerAccount :: Lens' AllocatePrivateVirtualInterface Text #

The AWS account that will own the new private virtual interface. Default: None

apviNewPrivateVirtualInterfaceAllocation :: Lens' AllocatePrivateVirtualInterface NewPrivateVirtualInterfaceAllocation #

Detailed information for the private virtual interface to be provisioned. Default: None

Destructuring the Response

virtualInterface :: VirtualInterface #

Creates a value of VirtualInterface with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

viBgpPeers - Undocumented member.
viVirtualGatewayId - Undocumented member.
viRouteFilterPrefixes - Undocumented member.
viCustomerAddress - Undocumented member.
viVlan - Undocumented member.
viLocation - Undocumented member.
viAmazonAddress - Undocumented member.
viAddressFamily - Undocumented member.
viVirtualInterfaceState - Undocumented member.
viConnectionId - Undocumented member.
viDirectConnectGatewayId - Undocumented member.
viAmazonSideASN - The autonomous system number (ASN) for the Amazon side of the connection.
viVirtualInterfaceType - Undocumented member.
viAsn - Undocumented member.
viAuthKey - Undocumented member.
viCustomerRouterConfig - Information for generating the customer router configuration.
viOwnerAccount - The AWS account that will own the new virtual interface.
viVirtualInterfaceName - Undocumented member.
viVirtualInterfaceId - Undocumented member.

data VirtualInterface #

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

See: virtualInterface smart constructor.

Instances

Eq VirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.Types.Product Methods (==) :: VirtualInterface -> VirtualInterface -> Bool # (/=) :: VirtualInterface -> VirtualInterface -> Bool #
Data VirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VirtualInterface -> c VirtualInterface # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VirtualInterface # toConstr :: VirtualInterface -> Constr # dataTypeOf :: VirtualInterface -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c VirtualInterface) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VirtualInterface) # gmapT :: (forall b. Data b => b -> b) -> VirtualInterface -> VirtualInterface # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VirtualInterface -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VirtualInterface -> r # gmapQ :: (forall d. Data d => d -> u) -> VirtualInterface -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> VirtualInterface -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> VirtualInterface -> m VirtualInterface # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VirtualInterface -> m VirtualInterface # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VirtualInterface -> m VirtualInterface #
Read VirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.Types.Product Methods readsPrec :: Int -> ReadS VirtualInterface # readList :: ReadS [VirtualInterface] # readPrec :: ReadPrec VirtualInterface # readListPrec :: ReadPrec [VirtualInterface] #
Show VirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.Types.Product Methods showsPrec :: Int -> VirtualInterface -> ShowS # show :: VirtualInterface -> String # showList :: [VirtualInterface] -> ShowS #
Generic VirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.Types.Product Associated Types type Rep VirtualInterface :: * -> * # Methods from :: VirtualInterface -> Rep VirtualInterface x # to :: Rep VirtualInterface x -> VirtualInterface #
Hashable VirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.Types.Product Methods hashWithSalt :: Int -> VirtualInterface -> Int # hash :: VirtualInterface -> Int #
FromJSON VirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.Types.Product Methods parseJSON :: Value -> Parser VirtualInterface # parseJSONList :: Value -> Parser [VirtualInterface] #
NFData VirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.Types.Product Methods rnf :: VirtualInterface -> () #
type Rep VirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.Types.Product type Rep VirtualInterface = D1 (MetaData "VirtualInterface" "Network.AWS.DirectConnect.Types.Product" "amazonka-directconnect-1.6.0-4mkgeEVXt4W3NTCklIzKwd" False) (C1 (MetaCons "VirtualInterface'" PrefixI True) ((((S1 (MetaSel (Just "_viBgpPeers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [BGPPeer])) :: S1 (MetaSel (Just "_viVirtualGatewayId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_viRouteFilterPrefixes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [RouteFilterPrefix])) :: S1 (MetaSel (Just "_viCustomerAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_viVlan") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :: S1 (MetaSel (Just "_viLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_viAmazonAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_viAddressFamily") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AddressFamily)) :: S1 (MetaSel (Just "_viVirtualInterfaceState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VirtualInterfaceState)))))) :: (((S1 (MetaSel (Just "_viConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_viDirectConnectGatewayId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_viAmazonSideASN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 (MetaSel (Just "_viVirtualInterfaceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_viAsn") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 (MetaSel (Just "_viAuthKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_viCustomerRouterConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_viOwnerAccount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_viVirtualInterfaceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_viVirtualInterfaceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))