Network.AWS.DirectConnect.AllocatePublicVirtualInterface

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.

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

Methods

(==) :: AllocatePublicVirtualInterface -> AllocatePublicVirtualInterface -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS AllocatePublicVirtualInterface

readList :: ReadS [AllocatePublicVirtualInterface]

readPrec :: ReadPrec AllocatePublicVirtualInterface

readListPrec :: ReadPrec [AllocatePublicVirtualInterface]

Show AllocatePublicVirtualInterface

Methods

showsPrec :: Int -> AllocatePublicVirtualInterface -> ShowS

show :: AllocatePublicVirtualInterface -> String

showList :: [AllocatePublicVirtualInterface] -> ShowS

Generic AllocatePublicVirtualInterface

Associated Types

type Rep AllocatePublicVirtualInterface :: * -> *

Methods

from :: AllocatePublicVirtualInterface -> Rep AllocatePublicVirtualInterface x

to :: Rep AllocatePublicVirtualInterface x -> AllocatePublicVirtualInterface

Hashable AllocatePublicVirtualInterface

Methods

hashWithSalt :: Int -> AllocatePublicVirtualInterface -> Int

hash :: AllocatePublicVirtualInterface -> Int

ToJSON AllocatePublicVirtualInterface

Methods

toJSON :: AllocatePublicVirtualInterface -> Value

toEncoding :: AllocatePublicVirtualInterface -> Encoding

toJSONList :: [AllocatePublicVirtualInterface] -> Value

toEncodingList :: [AllocatePublicVirtualInterface] -> Encoding

NFData AllocatePublicVirtualInterface

Methods

rnf :: AllocatePublicVirtualInterface -> ()

AWSRequest 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

Methods

toHeaders :: AllocatePublicVirtualInterface -> [Header]

ToPath AllocatePublicVirtualInterface

Methods

toPath :: AllocatePublicVirtualInterface -> ByteString

ToQuery AllocatePublicVirtualInterface

Methods

toQuery :: AllocatePublicVirtualInterface -> QueryString

type Rep AllocatePublicVirtualInterface

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

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

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.