Copyright	(c) 2013-2021 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

Amazonka.DirectConnect.AllocateTransitVirtualInterface

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

Synopsis

Creating a Request

data AllocateTransitVirtualInterface Source #

See: newAllocateTransitVirtualInterface smart constructor.

Constructors

AllocateTransitVirtualInterface'
Fields connectionId :: Text The ID of the connection on which the transit virtual interface is provisioned. ownerAccount :: Text The ID of the Amazon Web Services account that owns the transit virtual interface. newTransitVirtualInterfaceAllocation' :: NewTransitVirtualInterfaceAllocation Information about the transit virtual interface.

Instances

Instances details

Eq AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods (==) :: AllocateTransitVirtualInterface -> AllocateTransitVirtualInterface -> Bool # (/=) :: AllocateTransitVirtualInterface -> AllocateTransitVirtualInterface -> Bool #
Read AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods readsPrec :: Int -> ReadS AllocateTransitVirtualInterface # readList :: ReadS [AllocateTransitVirtualInterface] # readPrec :: ReadPrec AllocateTransitVirtualInterface # readListPrec :: ReadPrec [AllocateTransitVirtualInterface] #
Show AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods showsPrec :: Int -> AllocateTransitVirtualInterface -> ShowS # show :: AllocateTransitVirtualInterface -> String # showList :: [AllocateTransitVirtualInterface] -> ShowS #
Generic AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Associated Types type Rep AllocateTransitVirtualInterface :: Type -> Type # Methods from :: AllocateTransitVirtualInterface -> Rep AllocateTransitVirtualInterface x # to :: Rep AllocateTransitVirtualInterface x -> AllocateTransitVirtualInterface #
NFData AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods rnf :: AllocateTransitVirtualInterface -> () #
Hashable AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods hashWithSalt :: Int -> AllocateTransitVirtualInterface -> Int # hash :: AllocateTransitVirtualInterface -> Int #
ToJSON AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods toJSON :: AllocateTransitVirtualInterface -> Value # toEncoding :: AllocateTransitVirtualInterface -> Encoding # toJSONList :: [AllocateTransitVirtualInterface] -> Value # toEncodingList :: [AllocateTransitVirtualInterface] -> Encoding #
AWSRequest AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Associated Types type AWSResponse AllocateTransitVirtualInterface # Methods request :: AllocateTransitVirtualInterface -> Request AllocateTransitVirtualInterface # response :: MonadResource m => Logger -> Service -> Proxy AllocateTransitVirtualInterface -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AllocateTransitVirtualInterface))) #
ToHeaders AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods toHeaders :: AllocateTransitVirtualInterface -> [Header] #
ToPath AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods toPath :: AllocateTransitVirtualInterface -> ByteString #
ToQuery AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods toQuery :: AllocateTransitVirtualInterface -> QueryString #
type Rep AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface type Rep AllocateTransitVirtualInterface = D1 ('MetaData "AllocateTransitVirtualInterface" "Amazonka.DirectConnect.AllocateTransitVirtualInterface" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "AllocateTransitVirtualInterface'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "newTransitVirtualInterfaceAllocation'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NewTransitVirtualInterfaceAllocation))))
type AWSResponse AllocateTransitVirtualInterface Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface type AWSResponse AllocateTransitVirtualInterface = AllocateTransitVirtualInterfaceResponse

newAllocateTransitVirtualInterface Source #

Arguments

:: Text	`$sel:connectionId:AllocateTransitVirtualInterface'`
-> Text	`$sel:ownerAccount:AllocateTransitVirtualInterface'`
-> NewTransitVirtualInterfaceAllocation	`$sel:newTransitVirtualInterfaceAllocation':AllocateTransitVirtualInterface'`
-> AllocateTransitVirtualInterface

Create a value of AllocateTransitVirtualInterface with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:connectionId:AllocateTransitVirtualInterface', allocateTransitVirtualInterface_connectionId - The ID of the connection on which the transit virtual interface is provisioned.

$sel:ownerAccount:AllocateTransitVirtualInterface', allocateTransitVirtualInterface_ownerAccount - The ID of the Amazon Web Services account that owns the transit virtual interface.

$sel:newTransitVirtualInterfaceAllocation':AllocateTransitVirtualInterface', allocateTransitVirtualInterface_newTransitVirtualInterfaceAllocation - Information about the transit virtual interface.

Request Lenses

allocateTransitVirtualInterface_connectionId :: Lens' AllocateTransitVirtualInterface Text Source #

The ID of the connection on which the transit virtual interface is provisioned.

allocateTransitVirtualInterface_ownerAccount :: Lens' AllocateTransitVirtualInterface Text Source #

The ID of the Amazon Web Services account that owns the transit virtual interface.

allocateTransitVirtualInterface_newTransitVirtualInterfaceAllocation :: Lens' AllocateTransitVirtualInterface NewTransitVirtualInterfaceAllocation Source #

Information about the transit virtual interface.

Destructuring the Response

data AllocateTransitVirtualInterfaceResponse Source #

See: newAllocateTransitVirtualInterfaceResponse smart constructor.

Constructors

AllocateTransitVirtualInterfaceResponse'
Fields virtualInterface :: Maybe VirtualInterface httpStatus :: Int The response's http status code.

Instances

Instances details

Eq AllocateTransitVirtualInterfaceResponse Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods (==) :: AllocateTransitVirtualInterfaceResponse -> AllocateTransitVirtualInterfaceResponse -> Bool # (/=) :: AllocateTransitVirtualInterfaceResponse -> AllocateTransitVirtualInterfaceResponse -> Bool #
Read AllocateTransitVirtualInterfaceResponse Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods readsPrec :: Int -> ReadS AllocateTransitVirtualInterfaceResponse # readList :: ReadS [AllocateTransitVirtualInterfaceResponse] # readPrec :: ReadPrec AllocateTransitVirtualInterfaceResponse # readListPrec :: ReadPrec [AllocateTransitVirtualInterfaceResponse] #
Show AllocateTransitVirtualInterfaceResponse Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods showsPrec :: Int -> AllocateTransitVirtualInterfaceResponse -> ShowS # show :: AllocateTransitVirtualInterfaceResponse -> String # showList :: [AllocateTransitVirtualInterfaceResponse] -> ShowS #
Generic AllocateTransitVirtualInterfaceResponse Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Associated Types type Rep AllocateTransitVirtualInterfaceResponse :: Type -> Type # Methods from :: AllocateTransitVirtualInterfaceResponse -> Rep AllocateTransitVirtualInterfaceResponse x # to :: Rep AllocateTransitVirtualInterfaceResponse x -> AllocateTransitVirtualInterfaceResponse #
NFData AllocateTransitVirtualInterfaceResponse Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface Methods rnf :: AllocateTransitVirtualInterfaceResponse -> () #
type Rep AllocateTransitVirtualInterfaceResponse Source #
Instance details Defined in Amazonka.DirectConnect.AllocateTransitVirtualInterface type Rep AllocateTransitVirtualInterfaceResponse = D1 ('MetaData "AllocateTransitVirtualInterfaceResponse" "Amazonka.DirectConnect.AllocateTransitVirtualInterface" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "AllocateTransitVirtualInterfaceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "virtualInterface") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VirtualInterface)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAllocateTransitVirtualInterfaceResponse Source #

Arguments

:: Int	`$sel:httpStatus:AllocateTransitVirtualInterfaceResponse'`
-> AllocateTransitVirtualInterfaceResponse

Create a value of AllocateTransitVirtualInterfaceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:virtualInterface:AllocateTransitVirtualInterfaceResponse', allocateTransitVirtualInterfaceResponse_virtualInterface - Undocumented member.

$sel:httpStatus:AllocateTransitVirtualInterfaceResponse', allocateTransitVirtualInterfaceResponse_httpStatus - The response's http status code.

Response Lenses

allocateTransitVirtualInterfaceResponse_virtualInterface :: Lens' AllocateTransitVirtualInterfaceResponse (Maybe VirtualInterface) Source #

Undocumented member.

allocateTransitVirtualInterfaceResponse_httpStatus :: Lens' AllocateTransitVirtualInterfaceResponse Int Source #

The response's http status code.