amazonka-directconnect-1.6.1: 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.AllocatePublicVirtualInterface

Contents

Description

Provisions a public virtual interface to be owned by a different customer.

The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in Confirming state, and will not be available for handling traffic.

When creating an IPv6 public virtual interface (addressFamily is ipv6), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.

Synopsis

Creating a Request

allocatePublicVirtualInterface Source #

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

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

  • aConnectionId - The connection ID on which the public virtual interface is provisioned. Default: None
  • aOwnerAccount - The AWS account that will own the new public virtual interface. Default: None
  • aNewPublicVirtualInterfaceAllocation - Detailed information for the public virtual interface to be provisioned. Default: None

data AllocatePublicVirtualInterface Source #

Container for the parameters to the AllocatePublicVirtualInterface operation.

See: allocatePublicVirtualInterface smart constructor.

Instances
Eq AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

Data AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AllocatePublicVirtualInterface -> c AllocatePublicVirtualInterface #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AllocatePublicVirtualInterface #

toConstr :: AllocatePublicVirtualInterface -> Constr #

dataTypeOf :: AllocatePublicVirtualInterface -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AllocatePublicVirtualInterface) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AllocatePublicVirtualInterface) #

gmapT :: (forall b. Data b => b -> b) -> AllocatePublicVirtualInterface -> AllocatePublicVirtualInterface #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AllocatePublicVirtualInterface -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AllocatePublicVirtualInterface -> r #

gmapQ :: (forall d. Data d => d -> u) -> AllocatePublicVirtualInterface -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AllocatePublicVirtualInterface -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AllocatePublicVirtualInterface -> m AllocatePublicVirtualInterface #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AllocatePublicVirtualInterface -> m AllocatePublicVirtualInterface #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AllocatePublicVirtualInterface -> m AllocatePublicVirtualInterface #

Read AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

Show AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

Generic AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

Associated Types

type Rep AllocatePublicVirtualInterface :: Type -> Type #

Hashable AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

ToJSON AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

AWSRequest AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

Associated Types

type Rs AllocatePublicVirtualInterface :: Type #

ToHeaders AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

ToPath AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

ToQuery AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

NFData AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

type Rep AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

type Rep AllocatePublicVirtualInterface = D1 (MetaData "AllocatePublicVirtualInterface" "Network.AWS.DirectConnect.AllocatePublicVirtualInterface" "amazonka-directconnect-1.6.1-Jjw4CKEcom3TDRFDWXGnu" False) (C1 (MetaCons "AllocatePublicVirtualInterface'" PrefixI True) (S1 (MetaSel (Just "_aConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_aOwnerAccount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_aNewPublicVirtualInterfaceAllocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 NewPublicVirtualInterfaceAllocation))))
type Rs AllocatePublicVirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface

Request Lenses

aConnectionId :: Lens' AllocatePublicVirtualInterface Text Source #

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

aOwnerAccount :: Lens' AllocatePublicVirtualInterface Text Source #

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

aNewPublicVirtualInterfaceAllocation :: Lens' AllocatePublicVirtualInterface NewPublicVirtualInterfaceAllocation Source #

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

Destructuring the Response

virtualInterface :: VirtualInterface Source #

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 Source #

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

See: virtualInterface smart constructor.

Instances
Eq VirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Data VirtualInterface Source # 
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 Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Show VirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Generic VirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Associated Types

type Rep VirtualInterface :: Type -> Type #

Hashable VirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

FromJSON VirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

NFData VirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Methods

rnf :: VirtualInterface -> () #

type Rep VirtualInterface Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

type Rep VirtualInterface = D1 (MetaData "VirtualInterface" "Network.AWS.DirectConnect.Types.Product" "amazonka-directconnect-1.6.1-Jjw4CKEcom3TDRFDWXGnu" 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))))))))

Response Lenses

viBgpPeers :: Lens' VirtualInterface [BGPPeer] Source #

Undocumented member.

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

Undocumented member.

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

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

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

Undocumented member.

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

Undocumented member.

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

Information for generating the customer router configuration.

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

The AWS account that will own the new virtual interface.