amazonka-directconnect-1.6.0: Amazon Direct Connect SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DirectConnect.AllocatePrivateVirtualInterface

Contents

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

Creating a Request

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:

data AllocatePrivateVirtualInterface #

Container for the parameters to the AllocatePrivateVirtualInterface operation.

See: allocatePrivateVirtualInterface smart constructor.

Instances

Eq AllocatePrivateVirtualInterface # 
Data 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 # 
Show AllocatePrivateVirtualInterface # 
Generic AllocatePrivateVirtualInterface # 
Hashable AllocatePrivateVirtualInterface # 
ToJSON AllocatePrivateVirtualInterface # 
NFData AllocatePrivateVirtualInterface # 
AWSRequest AllocatePrivateVirtualInterface # 
ToHeaders AllocatePrivateVirtualInterface # 
ToPath AllocatePrivateVirtualInterface # 
ToQuery AllocatePrivateVirtualInterface # 
type Rep AllocatePrivateVirtualInterface # 
type Rep AllocatePrivateVirtualInterface = D1 * (MetaData "AllocatePrivateVirtualInterface" "Network.AWS.DirectConnect.AllocatePrivateVirtualInterface" "amazonka-directconnect-1.6.0-1iHBIYuuv8NGkO6PD7WukU" False) (C1 * (MetaCons "AllocatePrivateVirtualInterface'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_apviConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_apviOwnerAccount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_apviNewPrivateVirtualInterfaceAllocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * NewPrivateVirtualInterfaceAllocation)))))
type Rs AllocatePrivateVirtualInterface # 

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:

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 # 
Data VirtualInterface # 

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 # 
Show VirtualInterface # 
Generic VirtualInterface # 
Hashable VirtualInterface # 
FromJSON VirtualInterface # 
NFData VirtualInterface # 

Methods

rnf :: VirtualInterface -> () #

type Rep VirtualInterface # 
type Rep VirtualInterface = D1 * (MetaData "VirtualInterface" "Network.AWS.DirectConnect.Types.Product" "amazonka-directconnect-1.6.0-1iHBIYuuv8NGkO6PD7WukU" False) (C1 * (MetaCons "VirtualInterface'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_viBgpPeers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [BGPPeer]))) (S1 * (MetaSel (Just Symbol "_viVirtualGatewayId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_viRouteFilterPrefixes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [RouteFilterPrefix]))) (S1 * (MetaSel (Just Symbol "_viCustomerAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_viVlan") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_viLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_viAmazonAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_viAddressFamily") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AddressFamily))) (S1 * (MetaSel (Just Symbol "_viVirtualInterfaceState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VirtualInterfaceState))))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_viConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_viDirectConnectGatewayId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_viAmazonSideASN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))) ((:*:) * (S1 * (MetaSel (Just Symbol "_viVirtualInterfaceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_viAsn") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_viAuthKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_viCustomerRouterConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_viOwnerAccount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_viVirtualInterfaceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_viVirtualInterfaceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))))

Response Lenses

viBgpPeers :: Lens' VirtualInterface [BGPPeer] #

Undocumented member.

viVlan :: Lens' VirtualInterface (Maybe Int) #

Undocumented member.

viLocation :: Lens' VirtualInterface (Maybe Text) #

Undocumented member.

viConnectionId :: Lens' VirtualInterface (Maybe Text) #

Undocumented member.

viAmazonSideASN :: Lens' VirtualInterface (Maybe Integer) #

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

viAsn :: Lens' VirtualInterface (Maybe Int) #

Undocumented member.

viAuthKey :: Lens' VirtualInterface (Maybe Text) #

Undocumented member.

viCustomerRouterConfig :: Lens' VirtualInterface (Maybe Text) #

Information for generating the customer router configuration.

viOwnerAccount :: Lens' VirtualInterface (Maybe Text) #

The AWS account that will own the new virtual interface.