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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.

Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection .

In order to reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG to which the virtual interface will be newly associated.

Synopsis

associateVirtualInterface :: Text -> Text -> AssociateVirtualInterface
data AssociateVirtualInterface
aviVirtualInterfaceId :: Lens' AssociateVirtualInterface Text
aviConnectionId :: Lens' AssociateVirtualInterface Text
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

associateVirtualInterface #

Arguments

:: Text	`aviVirtualInterfaceId`
-> Text	`aviConnectionId`
-> AssociateVirtualInterface

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

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

aviVirtualInterfaceId - The ID of the virtual interface. Example: dxvif-123dfg56 Default: None
aviConnectionId - The ID of the LAG or connection with which to associate the virtual interface. Example: dxlag-abc123 or dxcon-abc123 Default: None

data AssociateVirtualInterface #

Container for the parameters to the AssociateVirtualInterface operation.

See: associateVirtualInterface smart constructor.

Instances

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

Request Lenses

aviVirtualInterfaceId :: Lens' AssociateVirtualInterface Text #

The ID of the virtual interface. Example: dxvif-123dfg56 Default: None

aviConnectionId :: Lens' AssociateVirtualInterface Text #

The ID of the LAG or connection with which to associate the virtual interface. Example: dxlag-abc123 or dxcon-abc123 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 :: Type -> Type # 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.1-BYxp3TU0eV1AtKckuIjZGd" 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))))))))