Network.AWS.DirectConnect.AllocatePrivateVirtualInterface

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

The owner of a connection calls this function to provision a private 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 ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

Creating a Request

allocatePrivateVirtualInterface

Arguments

:: Text

apviConnectionId

-> Text

apviOwnerAccount

-> NewPrivateVirtualInterfaceAllocation

apviNewPrivateVirtualInterfaceAllocation

-> 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:

• apviConnectionId
• apviOwnerAccount
• apviNewPrivateVirtualInterfaceAllocation

data AllocatePrivateVirtualInterface

Container for the parameters to the AllocatePrivateVirtualInterface operation.

See: allocatePrivateVirtualInterface smart constructor.

Instances

Eq AllocatePrivateVirtualInterface

Methods

(==) :: AllocatePrivateVirtualInterface -> AllocatePrivateVirtualInterface -> Bool

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

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

Methods

readsPrec :: Int -> ReadS AllocatePrivateVirtualInterface

readList :: ReadS [AllocatePrivateVirtualInterface]

readPrec :: ReadPrec AllocatePrivateVirtualInterface

readListPrec :: ReadPrec [AllocatePrivateVirtualInterface]

Show AllocatePrivateVirtualInterface

Methods

showsPrec :: Int -> AllocatePrivateVirtualInterface -> ShowS

show :: AllocatePrivateVirtualInterface -> String

showList :: [AllocatePrivateVirtualInterface] -> ShowS

Generic AllocatePrivateVirtualInterface

Associated Types

type Rep AllocatePrivateVirtualInterface :: * -> *

Methods

from :: AllocatePrivateVirtualInterface -> Rep AllocatePrivateVirtualInterface x

to :: Rep AllocatePrivateVirtualInterface x -> AllocatePrivateVirtualInterface

Hashable AllocatePrivateVirtualInterface

Methods

hashWithSalt :: Int -> AllocatePrivateVirtualInterface -> Int

hash :: AllocatePrivateVirtualInterface -> Int

ToJSON AllocatePrivateVirtualInterface

Methods

toJSON :: AllocatePrivateVirtualInterface -> Value

toEncoding :: AllocatePrivateVirtualInterface -> Encoding

toJSONList :: [AllocatePrivateVirtualInterface] -> Value

toEncodingList :: [AllocatePrivateVirtualInterface] -> Encoding

NFData AllocatePrivateVirtualInterface

Methods

rnf :: AllocatePrivateVirtualInterface -> ()

AWSRequest AllocatePrivateVirtualInterface

Associated Types

type Rs AllocatePrivateVirtualInterface :: *

Methods

request :: AllocatePrivateVirtualInterface -> Request AllocatePrivateVirtualInterface

response :: MonadResource m => Logger -> Service -> Proxy * AllocatePrivateVirtualInterface -> ClientResponse -> m (Response AllocatePrivateVirtualInterface)

ToQuery AllocatePrivateVirtualInterface

Methods

toQuery :: AllocatePrivateVirtualInterface -> QueryString

ToPath AllocatePrivateVirtualInterface

Methods

toPath :: AllocatePrivateVirtualInterface -> ByteString

ToHeaders AllocatePrivateVirtualInterface

Methods

toHeaders :: AllocatePrivateVirtualInterface -> [Header]

type Rep AllocatePrivateVirtualInterface

type Rep AllocatePrivateVirtualInterface = D1 (MetaData "AllocatePrivateVirtualInterface" "Network.AWS.DirectConnect.AllocatePrivateVirtualInterface" "amazonka-directconnect-1.4.2-I0txNAUWTHoVUwpUXXFnH" 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

type Rs AllocatePrivateVirtualInterface = VirtualInterface

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:

• viVirtualGatewayId
• viRouteFilterPrefixes
• viCustomerAddress
• viVlan
• viLocation
• viAmazonAddress
• viVirtualInterfaceState
• viConnectionId
• viVirtualInterfaceType
• viAsn
• viAuthKey
• viCustomerRouterConfig
• viOwnerAccount
• viVirtualInterfaceName
• viVirtualInterfaceId

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.4.2-I0txNAUWTHoVUwpUXXFnH" False) (C1 (MetaCons "VirtualInterface'" PrefixI True) ((:*:) ((:*:) ((:*:) (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 "_viVirtualInterfaceState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VirtualInterfaceState)))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_viConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (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

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.

viVirtualInterfaceState :: Lens' VirtualInterface (Maybe VirtualInterfaceState)

Undocumented member.

viConnectionId :: Lens' VirtualInterface (Maybe Text)

Undocumented member.

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)

Undocumented member.

viVirtualInterfaceName :: Lens' VirtualInterface (Maybe Text)

Undocumented member.

viVirtualInterfaceId :: Lens' VirtualInterface (Maybe Text)

Undocumented member.