Network.AWS.DirectConnect.AssociateVirtualInterface

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.

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

Methods

(==) :: AssociateVirtualInterface -> AssociateVirtualInterface -> Bool

(/=) :: AssociateVirtualInterface -> AssociateVirtualInterface -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS AssociateVirtualInterface

readList :: ReadS [AssociateVirtualInterface]

readPrec :: ReadPrec AssociateVirtualInterface

readListPrec :: ReadPrec [AssociateVirtualInterface]

Show AssociateVirtualInterface

Methods

showsPrec :: Int -> AssociateVirtualInterface -> ShowS

show :: AssociateVirtualInterface -> String

showList :: [AssociateVirtualInterface] -> ShowS

Generic AssociateVirtualInterface

Associated Types

type Rep AssociateVirtualInterface :: * -> *

Methods

from :: AssociateVirtualInterface -> Rep AssociateVirtualInterface x

to :: Rep AssociateVirtualInterface x -> AssociateVirtualInterface

Hashable AssociateVirtualInterface

Methods

hashWithSalt :: Int -> AssociateVirtualInterface -> Int

hash :: AssociateVirtualInterface -> Int

ToJSON AssociateVirtualInterface

Methods

toJSON :: AssociateVirtualInterface -> Value

toEncoding :: AssociateVirtualInterface -> Encoding

toJSONList :: [AssociateVirtualInterface] -> Value

toEncodingList :: [AssociateVirtualInterface] -> Encoding

NFData AssociateVirtualInterface

Methods

rnf :: AssociateVirtualInterface -> ()

AWSRequest AssociateVirtualInterface

Associated Types

type Rs AssociateVirtualInterface :: *

Methods

request :: AssociateVirtualInterface -> Request AssociateVirtualInterface

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * AssociateVirtualInterface -> ClientResponse -> m (Response AssociateVirtualInterface)

ToHeaders AssociateVirtualInterface

Methods

toHeaders :: AssociateVirtualInterface -> [Header]

ToPath AssociateVirtualInterface

Methods

toPath :: AssociateVirtualInterface -> ByteString

ToQuery AssociateVirtualInterface

Methods

toQuery :: AssociateVirtualInterface -> QueryString

type Rep AssociateVirtualInterface

type Rep AssociateVirtualInterface = D1 * (MetaData "AssociateVirtualInterface" "Network.AWS.DirectConnect.AssociateVirtualInterface" "amazonka-directconnect-1.6.0-3Ds8OcMuONt5kWQC5zsRrM" False) (C1 * (MetaCons "AssociateVirtualInterface'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_aviVirtualInterfaceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_aviConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

type Rs 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

Methods

(==) :: VirtualInterface -> VirtualInterface -> Bool

(/=) :: VirtualInterface -> VirtualInterface -> Bool

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

Methods

readsPrec :: Int -> ReadS VirtualInterface

readList :: ReadS [VirtualInterface]

readPrec :: ReadPrec VirtualInterface

readListPrec :: ReadPrec [VirtualInterface]

Show VirtualInterface

Methods

showsPrec :: Int -> VirtualInterface -> ShowS

show :: VirtualInterface -> String

showList :: [VirtualInterface] -> ShowS

Generic VirtualInterface

Associated Types

type Rep VirtualInterface :: * -> *

Methods

from :: VirtualInterface -> Rep VirtualInterface x

to :: Rep VirtualInterface x -> VirtualInterface

Hashable VirtualInterface

Methods

hashWithSalt :: Int -> VirtualInterface -> Int

hash :: VirtualInterface -> Int

FromJSON VirtualInterface

Methods

parseJSON :: Value -> Parser VirtualInterface

parseJSONList :: Value -> Parser [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-3Ds8OcMuONt5kWQC5zsRrM" 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.

viVirtualGatewayId :: Lens' VirtualInterface (Maybe Text)

Undocumented member.

viRouteFilterPrefixes :: Lens' VirtualInterface [RouteFilterPrefix]

Undocumented member.

viCustomerAddress :: Lens' VirtualInterface (Maybe Text)

Undocumented member.

viVlan :: Lens' VirtualInterface (Maybe Int)

Undocumented member.

viLocation :: Lens' VirtualInterface (Maybe Text)

Undocumented member.

viAmazonAddress :: Lens' VirtualInterface (Maybe Text)

Undocumented member.

viAddressFamily :: Lens' VirtualInterface (Maybe AddressFamily)

Undocumented member.

viVirtualInterfaceState :: Lens' VirtualInterface (Maybe VirtualInterfaceState)

Undocumented member.

viConnectionId :: Lens' VirtualInterface (Maybe Text)

Undocumented member.

viDirectConnectGatewayId :: Lens' VirtualInterface (Maybe Text)

Undocumented member.

viAmazonSideASN :: Lens' VirtualInterface (Maybe Integer)

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

viVirtualInterfaceType :: Lens' VirtualInterface (Maybe Text)

Undocumented member.

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.

viVirtualInterfaceName :: Lens' VirtualInterface (Maybe Text)

Undocumented member.

viVirtualInterfaceId :: Lens' VirtualInterface (Maybe Text)

Undocumented member.