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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

allocatePublicVirtualInterface :: Text -> Text -> NewPublicVirtualInterfaceAllocation -> AllocatePublicVirtualInterface
data AllocatePublicVirtualInterface
aConnectionId :: Lens' AllocatePublicVirtualInterface Text
aOwnerAccount :: Lens' AllocatePublicVirtualInterface Text
aNewPublicVirtualInterfaceAllocation :: Lens' AllocatePublicVirtualInterface NewPublicVirtualInterfaceAllocation
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

allocatePublicVirtualInterface #

Arguments

:: Text	`aConnectionId`
-> Text	`aOwnerAccount`
-> NewPublicVirtualInterfaceAllocation	`aNewPublicVirtualInterfaceAllocation`
-> AllocatePublicVirtualInterface

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 #

Container for the parameters to the AllocatePublicVirtualInterface operation.

See: allocatePublicVirtualInterface smart constructor.

Instances

Eq AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Methods (==) :: AllocatePublicVirtualInterface -> AllocatePublicVirtualInterface -> Bool # (/=) :: AllocatePublicVirtualInterface -> AllocatePublicVirtualInterface -> Bool #
Data AllocatePublicVirtualInterface #
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 #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Methods readsPrec :: Int -> ReadS AllocatePublicVirtualInterface # readList :: ReadS [AllocatePublicVirtualInterface] # readPrec :: ReadPrec AllocatePublicVirtualInterface # readListPrec :: ReadPrec [AllocatePublicVirtualInterface] #
Show AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Methods showsPrec :: Int -> AllocatePublicVirtualInterface -> ShowS # show :: AllocatePublicVirtualInterface -> String # showList :: [AllocatePublicVirtualInterface] -> ShowS #
Generic AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Associated Types type Rep AllocatePublicVirtualInterface :: * -> * # Methods from :: AllocatePublicVirtualInterface -> Rep AllocatePublicVirtualInterface x # to :: Rep AllocatePublicVirtualInterface x -> AllocatePublicVirtualInterface #
Hashable AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Methods hashWithSalt :: Int -> AllocatePublicVirtualInterface -> Int # hash :: AllocatePublicVirtualInterface -> Int #
ToJSON AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Methods toJSON :: AllocatePublicVirtualInterface -> Value # toEncoding :: AllocatePublicVirtualInterface -> Encoding # toJSONList :: [AllocatePublicVirtualInterface] -> Value # toEncodingList :: [AllocatePublicVirtualInterface] -> Encoding #
AWSRequest AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Associated Types type Rs AllocatePublicVirtualInterface :: * # Methods request :: AllocatePublicVirtualInterface -> Request AllocatePublicVirtualInterface # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy AllocatePublicVirtualInterface -> ClientResponse -> m (Response AllocatePublicVirtualInterface) #
ToHeaders AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Methods toHeaders :: AllocatePublicVirtualInterface -> [Header] #
ToPath AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Methods toPath :: AllocatePublicVirtualInterface -> ByteString #
ToQuery AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Methods toQuery :: AllocatePublicVirtualInterface -> QueryString #
NFData AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface Methods rnf :: AllocatePublicVirtualInterface -> () #
type Rep AllocatePublicVirtualInterface #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface type Rep AllocatePublicVirtualInterface = D1 (MetaData "AllocatePublicVirtualInterface" "Network.AWS.DirectConnect.AllocatePublicVirtualInterface" "amazonka-directconnect-1.6.0-4mkgeEVXt4W3NTCklIzKwd" 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 #
Instance details Defined in Network.AWS.DirectConnect.AllocatePublicVirtualInterface type Rs AllocatePublicVirtualInterface = VirtualInterface

Request Lenses

aConnectionId :: Lens' AllocatePublicVirtualInterface Text #

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

aOwnerAccount :: Lens' AllocatePublicVirtualInterface Text #

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

aNewPublicVirtualInterfaceAllocation :: Lens' AllocatePublicVirtualInterface NewPublicVirtualInterfaceAllocation #

Detailed information for the public 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))))))))