@datafire/amazonaws_directconnect
Client library for AWS Direct Connect
Installation and Usage
npm install --save @datafire/amazonaws_directconnect
let amazonaws_directconnect = require('@datafire/amazonaws_directconnect').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_directconnect.AllocateConnectionOnInterconnect({
"bandwidth": "",
"connectionName": "",
"ownerAccount": "",
"interconnectId": "",
"vlan": 0
}).then(data => {
console.log(data);
});
Description
AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. With this connection in place, you can create virtual interfaces directly to the AWS cloud (for example, to Amazon Elastic Compute Cloud (Amazon EC2) and Amazon Simple Storage Service (Amazon S3)) and to Amazon Virtual Private Cloud (Amazon VPC), bypassing Internet service providers in your network path. An AWS Direct Connect location provides access to AWS in the region it is associated with, as well as access to other US regions. For example, you can provision a single connection to any AWS Direct Connect location in the US and use it to access public AWS services in all US Regions and AWS GovCloud (US).
Actions
AllocateConnectionOnInterconnect
amazonaws_directconnect.AllocateConnectionOnInterconnect({
"bandwidth": "",
"connectionName": "",
"ownerAccount": "",
"interconnectId": "",
"vlan": 0
}, context)
Input
- input
object
- bandwidth required Bandwidth
- connectionName required ConnectionName
- interconnectId required InterconnectId
- ownerAccount required OwnerAccount
- vlan required VLAN
Output
- output Connection
AllocateHostedConnection
amazonaws_directconnect.AllocateHostedConnection({
"connectionId": "",
"ownerAccount": "",
"bandwidth": "",
"connectionName": "",
"vlan": 0
}, context)
Input
- input
object
- bandwidth required Bandwidth
- connectionId required ConnectionId
- connectionName required ConnectionName
- ownerAccount required OwnerAccount
- vlan required VLAN
Output
- output Connection
AllocatePrivateVirtualInterface
amazonaws_directconnect.AllocatePrivateVirtualInterface({
"connectionId": "",
"ownerAccount": "",
"newPrivateVirtualInterfaceAllocation": {
"virtualInterfaceName": "",
"vlan": 0,
"asn": 0
}
}, context)
Input
- input
object
- connectionId required ConnectionId
- newPrivateVirtualInterfaceAllocation required NewPrivateVirtualInterfaceAllocation
- ownerAccount required OwnerAccount
Output
- output VirtualInterface
AllocatePublicVirtualInterface
amazonaws_directconnect.AllocatePublicVirtualInterface({
"connectionId": "",
"ownerAccount": "",
"newPublicVirtualInterfaceAllocation": {
"virtualInterfaceName": "",
"vlan": 0,
"asn": 0
}
}, context)
Input
- input
object
- connectionId required ConnectionId
- newPublicVirtualInterfaceAllocation required NewPublicVirtualInterfaceAllocation
- ownerAccount required OwnerAccount
Output
- output VirtualInterface
AssociateConnectionWithLag
amazonaws_directconnect.AssociateConnectionWithLag({
"connectionId": "",
"lagId": ""
}, context)
Input
- input
object
- connectionId required ConnectionId
- lagId required LagId
Output
- output Connection
AssociateHostedConnection
amazonaws_directconnect.AssociateHostedConnection({
"connectionId": "",
"parentConnectionId": ""
}, context)
Input
- input
object
- connectionId required ConnectionId
- parentConnectionId required ConnectionId
Output
- output Connection
AssociateVirtualInterface
amazonaws_directconnect.AssociateVirtualInterface({
"virtualInterfaceId": "",
"connectionId": ""
}, context)
Input
- input
object
- connectionId required ConnectionId
- virtualInterfaceId required VirtualInterfaceId
Output
- output VirtualInterface
ConfirmConnection
amazonaws_directconnect.ConfirmConnection({
"connectionId": ""
}, context)
Input
- input
object
- connectionId required ConnectionId
Output
- output ConfirmConnectionResponse
ConfirmPrivateVirtualInterface
amazonaws_directconnect.ConfirmPrivateVirtualInterface({
"virtualInterfaceId": ""
}, context)
Input
- input
object
- directConnectGatewayId DirectConnectGatewayId
- virtualGatewayId VirtualGatewayId
- virtualInterfaceId required VirtualInterfaceId
Output
ConfirmPublicVirtualInterface
amazonaws_directconnect.ConfirmPublicVirtualInterface({
"virtualInterfaceId": ""
}, context)
Input
- input
object
- virtualInterfaceId required VirtualInterfaceId
Output
CreateBGPPeer
amazonaws_directconnect.CreateBGPPeer({}, context)
Input
- input
object
- newBGPPeer NewBGPPeer
- virtualInterfaceId VirtualInterfaceId
Output
- output CreateBGPPeerResponse
CreateConnection
amazonaws_directconnect.CreateConnection({
"location": "",
"bandwidth": "",
"connectionName": ""
}, context)
Input
- input
object
- bandwidth required Bandwidth
- connectionName required ConnectionName
- lagId LagId
- location required LocationCode
Output
- output Connection
CreateDirectConnectGateway
amazonaws_directconnect.CreateDirectConnectGateway({
"directConnectGatewayName": ""
}, context)
Input
- input
object
- amazonSideAsn LongAsn
- directConnectGatewayName required DirectConnectGatewayName
Output
CreateDirectConnectGatewayAssociation
amazonaws_directconnect.CreateDirectConnectGatewayAssociation({
"directConnectGatewayId": "",
"virtualGatewayId": ""
}, context)
Input
- input
object
- directConnectGatewayId required DirectConnectGatewayId
- virtualGatewayId required VirtualGatewayId
Output
CreateInterconnect
amazonaws_directconnect.CreateInterconnect({
"interconnectName": "",
"bandwidth": "",
"location": ""
}, context)
Input
- input
object
- bandwidth required Bandwidth
- interconnectName required InterconnectName
- lagId LagId
- location required LocationCode
Output
- output Interconnect
CreateLag
amazonaws_directconnect.CreateLag({
"numberOfConnections": 0,
"location": "",
"connectionsBandwidth": "",
"lagName": ""
}, context)
Input
- input
object
- connectionId ConnectionId
- connectionsBandwidth required Bandwidth
- lagName required LagName
- location required LocationCode
- numberOfConnections required Count
Output
- output Lag
CreatePrivateVirtualInterface
amazonaws_directconnect.CreatePrivateVirtualInterface({
"connectionId": "",
"newPrivateVirtualInterface": {
"virtualInterfaceName": "",
"vlan": 0,
"asn": 0
}
}, context)
Input
- input
object
- connectionId required ConnectionId
- newPrivateVirtualInterface required NewPrivateVirtualInterface
Output
- output VirtualInterface
CreatePublicVirtualInterface
amazonaws_directconnect.CreatePublicVirtualInterface({
"connectionId": "",
"newPublicVirtualInterface": {
"virtualInterfaceName": "",
"vlan": 0,
"asn": 0
}
}, context)
Input
- input
object
- connectionId required ConnectionId
- newPublicVirtualInterface required NewPublicVirtualInterface
Output
- output VirtualInterface
DeleteBGPPeer
amazonaws_directconnect.DeleteBGPPeer({}, context)
Input
- input
object
- asn ASN
- customerAddress CustomerAddress
- virtualInterfaceId VirtualInterfaceId
Output
- output DeleteBGPPeerResponse
DeleteConnection
amazonaws_directconnect.DeleteConnection({
"connectionId": ""
}, context)
Input
- input
object
- connectionId required ConnectionId
Output
- output Connection
DeleteDirectConnectGateway
amazonaws_directconnect.DeleteDirectConnectGateway({
"directConnectGatewayId": ""
}, context)
Input
- input
object
- directConnectGatewayId required DirectConnectGatewayId
Output
DeleteDirectConnectGatewayAssociation
amazonaws_directconnect.DeleteDirectConnectGatewayAssociation({
"directConnectGatewayId": "",
"virtualGatewayId": ""
}, context)
Input
- input
object
- directConnectGatewayId required DirectConnectGatewayId
- virtualGatewayId required VirtualGatewayId
Output
DeleteInterconnect
amazonaws_directconnect.DeleteInterconnect({
"interconnectId": ""
}, context)
Input
- input
object
- interconnectId required InterconnectId
Output
- output DeleteInterconnectResponse
DeleteLag
amazonaws_directconnect.DeleteLag({
"lagId": ""
}, context)
Input
- input
object
- lagId required LagId
Output
- output Lag
DeleteVirtualInterface
amazonaws_directconnect.DeleteVirtualInterface({
"virtualInterfaceId": ""
}, context)
Input
- input
object
- virtualInterfaceId required VirtualInterfaceId
Output
DescribeConnectionLoa
amazonaws_directconnect.DescribeConnectionLoa({
"connectionId": ""
}, context)
Input
- input
object
- connectionId required ConnectionId
- loaContentType LoaContentType
- providerName ProviderName
Output
DescribeConnections
amazonaws_directconnect.DescribeConnections({}, context)
Input
- input
object
- connectionId ConnectionId
Output
- output Connections
DescribeConnectionsOnInterconnect
amazonaws_directconnect.DescribeConnectionsOnInterconnect({
"interconnectId": ""
}, context)
Input
- input
object
- interconnectId required InterconnectId
Output
- output Connections
DescribeDirectConnectGatewayAssociations
amazonaws_directconnect.DescribeDirectConnectGatewayAssociations({}, context)
Input
- input
object
- directConnectGatewayId DirectConnectGatewayId
- maxResults MaxResultSetSize
- nextToken PaginationToken
- virtualGatewayId VirtualGatewayId
Output
DescribeDirectConnectGatewayAttachments
amazonaws_directconnect.DescribeDirectConnectGatewayAttachments({}, context)
Input
- input
object
- directConnectGatewayId DirectConnectGatewayId
- maxResults MaxResultSetSize
- nextToken PaginationToken
- virtualInterfaceId VirtualInterfaceId
Output
DescribeDirectConnectGateways
amazonaws_directconnect.DescribeDirectConnectGateways({}, context)
Input
- input
object
- directConnectGatewayId DirectConnectGatewayId
- maxResults MaxResultSetSize
- nextToken PaginationToken
Output
DescribeHostedConnections
amazonaws_directconnect.DescribeHostedConnections({
"connectionId": ""
}, context)
Input
- input
object
- connectionId required ConnectionId
Output
- output Connections
DescribeInterconnectLoa
amazonaws_directconnect.DescribeInterconnectLoa({
"interconnectId": ""
}, context)
Input
- input
object
- interconnectId required InterconnectId
- loaContentType LoaContentType
- providerName ProviderName
Output
DescribeInterconnects
amazonaws_directconnect.DescribeInterconnects({}, context)
Input
- input
object
- interconnectId InterconnectId
Output
- output Interconnects
DescribeLags
amazonaws_directconnect.DescribeLags({}, context)
Input
- input
object
- lagId LagId
Output
- output Lags
DescribeLoa
amazonaws_directconnect.DescribeLoa({
"connectionId": ""
}, context)
Input
- input
object
- connectionId required ConnectionId
- loaContentType LoaContentType
- providerName ProviderName
Output
- output Loa
DescribeLocations
amazonaws_directconnect.DescribeLocations({}, context)
Input
- input
object
Output
- output Locations
DescribeTags
amazonaws_directconnect.DescribeTags({
"resourceArns": []
}, context)
Input
- input
object
- resourceArns required ResourceArnList
Output
- output DescribeTagsResponse
DescribeVirtualGateways
amazonaws_directconnect.DescribeVirtualGateways({}, context)
Input
- input
object
Output
- output VirtualGateways
DescribeVirtualInterfaces
amazonaws_directconnect.DescribeVirtualInterfaces({}, context)
Input
- input
object
- connectionId ConnectionId
- virtualInterfaceId VirtualInterfaceId
Output
- output VirtualInterfaces
DisassociateConnectionFromLag
amazonaws_directconnect.DisassociateConnectionFromLag({
"connectionId": "",
"lagId": ""
}, context)
Input
- input
object
- connectionId required ConnectionId
- lagId required LagId
Output
- output Connection
TagResource
amazonaws_directconnect.TagResource({
"resourceArn": "",
"tags": []
}, context)
Input
- input
object
- resourceArn required ResourceArn
- tags required TagList
Output
- output TagResourceResponse
UntagResource
amazonaws_directconnect.UntagResource({
"resourceArn": "",
"tagKeys": []
}, context)
Input
- input
object
- resourceArn required ResourceArn
- tagKeys required TagKeyList
Output
- output UntagResourceResponse
UpdateLag
amazonaws_directconnect.UpdateLag({
"lagId": ""
}, context)
Input
Output
- output Lag
Definitions
ASN
- ASN
integer
:The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
AddressFamily
- AddressFamily
string
(values: ipv4, ipv6):Indicates the address family for the BGP peer.
-
ipv4: IPv4 address family
-
ipv6: IPv6 address family
-
AllocateConnectionOnInterconnectRequest
- AllocateConnectionOnInterconnectRequest
object
: Container for the parameters to the AllocateConnectionOnInterconnect operation.- bandwidth required Bandwidth
- connectionName required ConnectionName
- interconnectId required InterconnectId
- ownerAccount required OwnerAccount
- vlan required VLAN
AllocateHostedConnectionRequest
- AllocateHostedConnectionRequest
object
: Container for the parameters to theHostedConnection operation.- bandwidth required Bandwidth
- connectionId required ConnectionId
- connectionName required ConnectionName
- ownerAccount required OwnerAccount
- vlan required VLAN
AllocatePrivateVirtualInterfaceRequest
- AllocatePrivateVirtualInterfaceRequest
object
: Container for the parameters to the AllocatePrivateVirtualInterface operation.- connectionId required ConnectionId
- newPrivateVirtualInterfaceAllocation required NewPrivateVirtualInterfaceAllocation
- ownerAccount required OwnerAccount
AllocatePublicVirtualInterfaceRequest
- AllocatePublicVirtualInterfaceRequest
object
: Container for the parameters to the AllocatePublicVirtualInterface operation.- connectionId required ConnectionId
- newPublicVirtualInterfaceAllocation required NewPublicVirtualInterfaceAllocation
- ownerAccount required OwnerAccount
AmazonAddress
- AmazonAddress
string
:IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
AssociateConnectionWithLagRequest
- AssociateConnectionWithLagRequest
object
: Container for the parameters to the AssociateConnectionWithLag operation.- connectionId required ConnectionId
- lagId required LagId
AssociateHostedConnectionRequest
- AssociateHostedConnectionRequest
object
: Container for the parameters to the AssociateHostedConnection operation.- connectionId required ConnectionId
- parentConnectionId required ConnectionId
AssociateVirtualInterfaceRequest
- AssociateVirtualInterfaceRequest
object
: Container for the parameters to the AssociateVirtualInterface operation.- connectionId required ConnectionId
- virtualInterfaceId required VirtualInterfaceId
AwsDevice
- AwsDevice
string
:An abstract ID for the physical Direct Connect endpoint.
Example: EQC50-abcdef123456
BGPAuthKey
- BGPAuthKey
string
:The authentication key for BGP configuration.
Example: asdf34example
BGPPeer
- BGPPeer
object
: A structure containing information about a BGP peer.- addressFamily AddressFamily
- amazonAddress AmazonAddress
- asn ASN
- authKey BGPAuthKey
- bgpPeerState BGPPeerState
- bgpStatus BGPStatus
- customerAddress CustomerAddress
BGPPeerList
- BGPPeerList
array
: A list of the BGP peers configured on this virtual interface.- items BGPPeer
BGPPeerState
- BGPPeerState
string
(values: verifying, pending, available, deleting, deleted):The state of the BGP peer.
-
Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.
-
Pending: The BGP peer has been created, and is in this state until it is ready to be established.
-
Available: The BGP peer can be established.
-
Deleting: The BGP peer is in the process of being deleted.
-
Deleted: The BGP peer has been deleted and cannot be established.
-
BGPStatus
- BGPStatus
string
(values: up, down):The Up/Down state of the BGP peer.
-
Up: The BGP peer is established.
-
Down: The BGP peer is down.
-
Bandwidth
- Bandwidth
string
:Bandwidth of the connection.
Example: 1Gbps
Default: None
BooleanFlag
- BooleanFlag
boolean
CIDR
- CIDR
string
ConfirmConnectionRequest
- ConfirmConnectionRequest
object
: Container for the parameters to the ConfirmConnection operation.- connectionId required ConnectionId
ConfirmConnectionResponse
- ConfirmConnectionResponse
object
: The response received when ConfirmConnection is called.- connectionState ConnectionState
ConfirmPrivateVirtualInterfaceRequest
- ConfirmPrivateVirtualInterfaceRequest
object
: Container for the parameters to the ConfirmPrivateVirtualInterface operation.- directConnectGatewayId DirectConnectGatewayId
- virtualGatewayId VirtualGatewayId
- virtualInterfaceId required VirtualInterfaceId
ConfirmPrivateVirtualInterfaceResponse
- ConfirmPrivateVirtualInterfaceResponse
object
: The response received when ConfirmPrivateVirtualInterface is called.- virtualInterfaceState VirtualInterfaceState
ConfirmPublicVirtualInterfaceRequest
- ConfirmPublicVirtualInterfaceRequest
object
: Container for the parameters to the ConfirmPublicVirtualInterface operation.- virtualInterfaceId required VirtualInterfaceId
ConfirmPublicVirtualInterfaceResponse
- ConfirmPublicVirtualInterfaceResponse
object
: The response received when ConfirmPublicVirtualInterface is called.- virtualInterfaceState VirtualInterfaceState
Connection
- Connection
object
: A connection represents the physical network connection between the AWS Direct Connect location and the customer.- awsDevice AwsDevice
- bandwidth Bandwidth
- connectionId ConnectionId
- connectionName ConnectionName
- connectionState ConnectionState
- lagId LagId
- loaIssueTime LoaIssueTime
- location LocationCode
- ownerAccount OwnerAccount
- partnerName PartnerName
- region Region
- vlan VLAN
ConnectionId
- ConnectionId
string
:The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).
Example: dxcon-fg5678gh
Default: None
ConnectionList
- ConnectionList
array
: A list of connections.- items Connection
ConnectionName
- ConnectionName
string
:The name of the connection.
Example: "My Connection to AWS"
Default: None
ConnectionState
- ConnectionState
string
(values: ordering, requested, pending, available, down, deleting, deleted, rejected):State of the connection.
-
Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
-
Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
-
Pending: The connection has been approved, and is being initialized.
-
Available: The network link is up, and the connection is ready for use.
-
Down: The network link is down.
-
Deleting: The connection is in the process of being deleted.
-
Deleted: The connection has been deleted.
-
Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
-
Connections
- Connections
object
: A structure containing a list of connections.- connections ConnectionList
Count
- Count
integer
CreateBGPPeerRequest
- CreateBGPPeerRequest
object
: Container for the parameters to the CreateBGPPeer operation.- newBGPPeer NewBGPPeer
- virtualInterfaceId VirtualInterfaceId
CreateBGPPeerResponse
- CreateBGPPeerResponse
object
: The response received when CreateBGPPeer is called.- virtualInterface VirtualInterface
CreateConnectionRequest
- CreateConnectionRequest
object
: Container for the parameters to the CreateConnection operation.- bandwidth required Bandwidth
- connectionName required ConnectionName
- lagId LagId
- location required LocationCode
CreateDirectConnectGatewayAssociationRequest
- CreateDirectConnectGatewayAssociationRequest
object
: Container for the parameters to the CreateDirectConnectGatewayAssociation operation.- directConnectGatewayId required DirectConnectGatewayId
- virtualGatewayId required VirtualGatewayId
CreateDirectConnectGatewayAssociationResult
- CreateDirectConnectGatewayAssociationResult
object
: Container for the response from the CreateDirectConnectGatewayAssociation API call- directConnectGatewayAssociation DirectConnectGatewayAssociation
CreateDirectConnectGatewayRequest
- CreateDirectConnectGatewayRequest
object
: Container for the parameters to the CreateDirectConnectGateway operation.- amazonSideAsn LongAsn
- directConnectGatewayName required DirectConnectGatewayName
CreateDirectConnectGatewayResult
- CreateDirectConnectGatewayResult
object
: Container for the response from the CreateDirectConnectGateway API call- directConnectGateway DirectConnectGateway
CreateInterconnectRequest
- CreateInterconnectRequest
object
: Container for the parameters to the CreateInterconnect operation.- bandwidth required Bandwidth
- interconnectName required InterconnectName
- lagId LagId
- location required LocationCode
CreateLagRequest
- CreateLagRequest
object
: Container for the parameters to the CreateLag operation.- connectionId ConnectionId
- connectionsBandwidth required Bandwidth
- lagName required LagName
- location required LocationCode
- numberOfConnections required Count
CreatePrivateVirtualInterfaceRequest
- CreatePrivateVirtualInterfaceRequest
object
: Container for the parameters to the CreatePrivateVirtualInterface operation.- connectionId required ConnectionId
- newPrivateVirtualInterface required NewPrivateVirtualInterface
CreatePublicVirtualInterfaceRequest
- CreatePublicVirtualInterfaceRequest
object
: Container for the parameters to the CreatePublicVirtualInterface operation.- connectionId required ConnectionId
- newPublicVirtualInterface required NewPublicVirtualInterface
CustomerAddress
- CustomerAddress
string
:IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
DeleteBGPPeerRequest
- DeleteBGPPeerRequest
object
: Container for the parameters to the DeleteBGPPeer operation.- asn ASN
- customerAddress CustomerAddress
- virtualInterfaceId VirtualInterfaceId
DeleteBGPPeerResponse
- DeleteBGPPeerResponse
object
: The response received when DeleteBGPPeer is called.- virtualInterface VirtualInterface
DeleteConnectionRequest
- DeleteConnectionRequest
object
: Container for the parameters to the DeleteConnection operation.- connectionId required ConnectionId
DeleteDirectConnectGatewayAssociationRequest
- DeleteDirectConnectGatewayAssociationRequest
object
: Container for the parameters to the DeleteDirectConnectGatewayAssociation operation.- directConnectGatewayId required DirectConnectGatewayId
- virtualGatewayId required VirtualGatewayId
DeleteDirectConnectGatewayAssociationResult
- DeleteDirectConnectGatewayAssociationResult
object
: Container for the response from the DeleteDirectConnectGatewayAssociation API call- directConnectGatewayAssociation DirectConnectGatewayAssociation
DeleteDirectConnectGatewayRequest
- DeleteDirectConnectGatewayRequest
object
: Container for the parameters to the DeleteDirectConnectGateway operation.- directConnectGatewayId required DirectConnectGatewayId
DeleteDirectConnectGatewayResult
- DeleteDirectConnectGatewayResult
object
: Container for the response from the DeleteDirectConnectGateway API call- directConnectGateway DirectConnectGateway
DeleteInterconnectRequest
- DeleteInterconnectRequest
object
: Container for the parameters to the DeleteInterconnect operation.- interconnectId required InterconnectId
DeleteInterconnectResponse
- DeleteInterconnectResponse
object
: The response received when DeleteInterconnect is called.- interconnectState InterconnectState
DeleteLagRequest
- DeleteLagRequest
object
: Container for the parameters to the DeleteLag operation.- lagId required LagId
DeleteVirtualInterfaceRequest
- DeleteVirtualInterfaceRequest
object
: Container for the parameters to the DeleteVirtualInterface operation.- virtualInterfaceId required VirtualInterfaceId
DeleteVirtualInterfaceResponse
- DeleteVirtualInterfaceResponse
object
: The response received when DeleteVirtualInterface is called.- virtualInterfaceState VirtualInterfaceState
DescribeConnectionLoaRequest
- DescribeConnectionLoaRequest
object
: Container for the parameters to the DescribeConnectionLoa operation.- connectionId required ConnectionId
- loaContentType LoaContentType
- providerName ProviderName
DescribeConnectionLoaResponse
- DescribeConnectionLoaResponse
object
: The response received when DescribeConnectionLoa is called.- loa Loa
DescribeConnectionsOnInterconnectRequest
- DescribeConnectionsOnInterconnectRequest
object
: Container for the parameters to the DescribeConnectionsOnInterconnect operation.- interconnectId required InterconnectId
DescribeConnectionsRequest
- DescribeConnectionsRequest
object
: Container for the parameters to the DescribeConnections operation.- connectionId ConnectionId
DescribeDirectConnectGatewayAssociationsRequest
- DescribeDirectConnectGatewayAssociationsRequest
object
: Container for the parameters to the DescribeDirectConnectGatewayAssociations operation.- directConnectGatewayId DirectConnectGatewayId
- maxResults MaxResultSetSize
- nextToken PaginationToken
- virtualGatewayId VirtualGatewayId
DescribeDirectConnectGatewayAssociationsResult
- DescribeDirectConnectGatewayAssociationsResult
object
: Container for the response from the DescribeDirectConnectGatewayAssociations API call- directConnectGatewayAssociations DirectConnectGatewayAssociationList
- nextToken PaginationToken
DescribeDirectConnectGatewayAttachmentsRequest
- DescribeDirectConnectGatewayAttachmentsRequest
object
: Container for the parameters to the DescribeDirectConnectGatewayAttachments operation.- directConnectGatewayId DirectConnectGatewayId
- maxResults MaxResultSetSize
- nextToken PaginationToken
- virtualInterfaceId VirtualInterfaceId
DescribeDirectConnectGatewayAttachmentsResult
- DescribeDirectConnectGatewayAttachmentsResult
object
: Container for the response from the DescribeDirectConnectGatewayAttachments API call- directConnectGatewayAttachments DirectConnectGatewayAttachmentList
- nextToken PaginationToken
DescribeDirectConnectGatewaysRequest
- DescribeDirectConnectGatewaysRequest
object
: Container for the parameters to the DescribeDirectConnectGateways operation.- directConnectGatewayId DirectConnectGatewayId
- maxResults MaxResultSetSize
- nextToken PaginationToken
DescribeDirectConnectGatewaysResult
- DescribeDirectConnectGatewaysResult
object
: Container for the response from the DescribeDirectConnectGateways API call- directConnectGateways DirectConnectGatewayList
- nextToken PaginationToken
DescribeHostedConnectionsRequest
- DescribeHostedConnectionsRequest
object
: Container for the parameters to the DescribeHostedConnections operation.- connectionId required ConnectionId
DescribeInterconnectLoaRequest
- DescribeInterconnectLoaRequest
object
: Container for the parameters to the DescribeInterconnectLoa operation.- interconnectId required InterconnectId
- loaContentType LoaContentType
- providerName ProviderName
DescribeInterconnectLoaResponse
- DescribeInterconnectLoaResponse
object
: The response received when DescribeInterconnectLoa is called.- loa Loa
DescribeInterconnectsRequest
- DescribeInterconnectsRequest
object
: Container for the parameters to the DescribeInterconnects operation.- interconnectId InterconnectId
DescribeLagsRequest
- DescribeLagsRequest
object
: Container for the parameters to the DescribeLags operation.- lagId LagId
DescribeLoaRequest
- DescribeLoaRequest
object
: Container for the parameters to the DescribeLoa operation.- connectionId required ConnectionId
- loaContentType LoaContentType
- providerName ProviderName
DescribeTagsRequest
- DescribeTagsRequest
object
: Container for the parameters to the DescribeTags operation.- resourceArns required ResourceArnList
DescribeTagsResponse
- DescribeTagsResponse
object
: The response received when DescribeTags is called.- resourceTags ResourceTagList
DescribeVirtualInterfacesRequest
- DescribeVirtualInterfacesRequest
object
: Container for the parameters to the DescribeVirtualInterfaces operation.- connectionId ConnectionId
- virtualInterfaceId VirtualInterfaceId
DirectConnectClientException
- DirectConnectClientException
object
: The API was called with invalid parameters. The error message will contain additional details about the cause.- message ErrorMessage
DirectConnectGateway
- DirectConnectGateway
object
: A direct connect gateway is an intermediate object that enables you to connect virtual interfaces and virtual private gateways.- amazonSideAsn LongAsn
- directConnectGatewayId DirectConnectGatewayId
- directConnectGatewayName DirectConnectGatewayName
- directConnectGatewayState DirectConnectGatewayState
- ownerAccount OwnerAccount
- stateChangeError StateChangeError
DirectConnectGatewayAssociation
- DirectConnectGatewayAssociation
object
: The association between a direct connect gateway and virtual private gateway.- associationState DirectConnectGatewayAssociationState
- directConnectGatewayId DirectConnectGatewayId
- stateChangeError StateChangeError
- virtualGatewayId VirtualGatewayId
- virtualGatewayOwnerAccount OwnerAccount
- virtualGatewayRegion VirtualGatewayRegion
DirectConnectGatewayAssociationList
- DirectConnectGatewayAssociationList
array
: A list of direct connect gateway associations.
DirectConnectGatewayAssociationState
- DirectConnectGatewayAssociationState
string
(values: associating, associated, disassociating, disassociated):State of the direct connect gateway association.
-
Associating: The initial state after calling CreateDirectConnectGatewayAssociation.
-
Associated: The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.
-
Disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.
-
Disassociated: The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.
-
DirectConnectGatewayAttachment
- DirectConnectGatewayAttachment
object
: The association between a direct connect gateway and virtual interface.- attachmentState DirectConnectGatewayAttachmentState
- directConnectGatewayId DirectConnectGatewayId
- stateChangeError StateChangeError
- virtualInterfaceId VirtualInterfaceId
- virtualInterfaceOwnerAccount OwnerAccount
- virtualInterfaceRegion VirtualInterfaceRegion
DirectConnectGatewayAttachmentList
- DirectConnectGatewayAttachmentList
array
: A list of direct connect gateway attachments.
DirectConnectGatewayAttachmentState
- DirectConnectGatewayAttachmentState
string
(values: attaching, attached, detaching, detached):State of the direct connect gateway attachment.
-
Attaching: The initial state after a virtual interface is created using the direct connect gateway.
-
Attached: The direct connect gateway and virtual interface are successfully attached and ready to pass traffic.
-
Detaching: The initial state after calling DeleteVirtualInterface on a virtual interface that is attached to a direct connect gateway.
-
Detached: The virtual interface is successfully detached from the direct connect gateway. Traffic flow between the direct connect gateway and virtual interface stops.
-
DirectConnectGatewayId
- DirectConnectGatewayId
string
:The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
DirectConnectGatewayList
- DirectConnectGatewayList
array
: A list of direct connect gateways.- items DirectConnectGateway
DirectConnectGatewayName
- DirectConnectGatewayName
string
:The name of the direct connect gateway.
Example: "My direct connect gateway"
Default: None
DirectConnectGatewayState
- DirectConnectGatewayState
string
(values: pending, available, deleting, deleted):State of the direct connect gateway.
-
Pending: The initial state after calling CreateDirectConnectGateway.
-
Available: The direct connect gateway is ready for use.
-
Deleting: The initial state after calling DeleteDirectConnectGateway.
-
Deleted: The direct connect gateway is deleted and cannot pass traffic.
-
DirectConnectServerException
- DirectConnectServerException
object
: A server-side error occurred during the API call. The error message will contain additional details about the cause.- message ErrorMessage
DisassociateConnectionFromLagRequest
- DisassociateConnectionFromLagRequest
object
: Container for the parameters to the DisassociateConnectionFromLag operation.- connectionId required ConnectionId
- lagId required LagId
DuplicateTagKeysException
- DuplicateTagKeysException
object
: A tag key was specified more than once.
ErrorMessage
- ErrorMessage
string
Interconnect
- Interconnect
object
:An interconnect is a connection that can host other connections.
Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.
The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.
- awsDevice AwsDevice
- bandwidth Bandwidth
- interconnectId InterconnectId
- interconnectName InterconnectName
- interconnectState InterconnectState
- lagId LagId
- loaIssueTime LoaIssueTime
- location LocationCode
- region Region
InterconnectId
- InterconnectId
string
:The ID of the interconnect.
Example: dxcon-abc123
InterconnectList
- InterconnectList
array
: A list of interconnects.- items Interconnect
InterconnectName
- InterconnectName
string
:The name of the interconnect.
Example: "1G Interconnect to AWS"
InterconnectState
- InterconnectState
string
(values: requested, pending, available, down, deleting, deleted):State of the interconnect.
-
Requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
-
Pending: The interconnect has been approved, and is being initialized.
-
Available: The network link is up, and the interconnect is ready for use.
-
Down: The network link is down.
-
Deleting: The interconnect is in the process of being deleted.
-
Deleted: The interconnect has been deleted.
-
Interconnects
- Interconnects
object
: A structure containing a list of interconnects.- interconnects InterconnectList
Lag
- Lag
object
: Describes a link aggregation group (LAG). A LAG is a connection that uses the Link Aggregation Control Protocol (LACP) to logically aggregate a bundle of physical connections. Like an interconnect, it can host other connections. All connections in a LAG must terminate on the same physical AWS Direct Connect endpoint, and must be the same bandwidth.- allowsHostedConnections BooleanFlag
- awsDevice AwsDevice
- connections ConnectionList
- connectionsBandwidth Bandwidth
- lagId LagId
- lagName LagName
- lagState LagState
- location LocationCode
- minimumLinks Count
- numberOfConnections Count
- ownerAccount OwnerAccount
- region Region
LagId
- LagId
string
:The ID of the LAG.
Example: dxlag-fg5678gh
LagList
- LagList
array
: A list of LAGs.- items Lag
LagName
- LagName
string
LagState
- LagState
string
(values: requested, pending, available, down, deleting, deleted):The state of the LAG.
-
Requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
-
Pending: The LAG has been approved, and is being initialized.
-
Available: The network link is established, and the LAG is ready for use.
-
Down: The network link is down.
-
Deleting: The LAG is in the process of being deleted.
-
Deleted: The LAG has been deleted.
-
Lags
- Lags
object
: A structure containing a list of LAGs.- lags LagList
Loa
- Loa
object
: A structure containing the Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.- loaContent LoaContent
- loaContentType LoaContentType
LoaContent
- LoaContent
string
: The binary contents of the LOA-CFA document.
LoaContentType
- LoaContentType
string
(values: application/pdf):A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is "application/pdf".
Default: application/pdf
LoaIssueTime
- LoaIssueTime
string
Location
- Location
object
: An AWS Direct Connect location where connections and interconnects can be requested.- locationCode LocationCode
LocationCode
- LocationCode
string
:Where the connection is located.
Example: EqSV5
Default: None
LocationList
- LocationList
array
- items Location
LocationName
- LocationName
string
Locations
- Locations
object
: A location is a network facility where AWS Direct Connect routers are available to be connected. Generally, these are colocation hubs where many network providers have equipment, and where cross connects can be delivered. Locations include a name and facility code, and must be provided when creating a connection.- locations LocationList
LongAsn
- LongAsn
integer
MaxResultSetSize
- MaxResultSetSize
integer
: Maximum number of objects to return per page.
NewBGPPeer
- NewBGPPeer
object
: A structure containing information about a new BGP peer.- addressFamily AddressFamily
- amazonAddress AmazonAddress
- asn ASN
- authKey BGPAuthKey
- customerAddress CustomerAddress
NewPrivateVirtualInterface
- NewPrivateVirtualInterface
object
: A structure containing information about a new private virtual interface.- addressFamily AddressFamily
- amazonAddress AmazonAddress
- asn required ASN
- authKey BGPAuthKey
- customerAddress CustomerAddress
- directConnectGatewayId DirectConnectGatewayId
- virtualGatewayId VirtualGatewayId
- virtualInterfaceName required VirtualInterfaceName
- vlan required VLAN
NewPrivateVirtualInterfaceAllocation
- NewPrivateVirtualInterfaceAllocation
object
: A structure containing information about a private virtual interface that will be provisioned on a connection.- addressFamily AddressFamily
- amazonAddress AmazonAddress
- asn required ASN
- authKey BGPAuthKey
- customerAddress CustomerAddress
- virtualInterfaceName required VirtualInterfaceName
- vlan required VLAN
NewPublicVirtualInterface
- NewPublicVirtualInterface
object
: A structure containing information about a new public virtual interface.- addressFamily AddressFamily
- amazonAddress AmazonAddress
- asn required ASN
- authKey BGPAuthKey
- customerAddress CustomerAddress
- routeFilterPrefixes RouteFilterPrefixList
- virtualInterfaceName required VirtualInterfaceName
- vlan required VLAN
NewPublicVirtualInterfaceAllocation
- NewPublicVirtualInterfaceAllocation
object
: A structure containing information about a public virtual interface that will be provisioned on a connection.- addressFamily AddressFamily
- amazonAddress AmazonAddress
- asn required ASN
- authKey BGPAuthKey
- customerAddress CustomerAddress
- routeFilterPrefixes RouteFilterPrefixList
- virtualInterfaceName required VirtualInterfaceName
- vlan required VLAN
OwnerAccount
- OwnerAccount
string
PaginationToken
- PaginationToken
string
: Token to retrieve the next page of the result.
PartnerName
- PartnerName
string
ProviderName
- ProviderName
string
Region
- Region
string
:The AWS region where the connection is located.
Example: us-east-1
Default: None
ResourceArn
- ResourceArn
string
ResourceArnList
- ResourceArnList
array
- items ResourceArn
ResourceTag
- ResourceTag
object
: The tags associated with a Direct Connect resource.- resourceArn ResourceArn
- tags TagList
ResourceTagList
- ResourceTagList
array
- items ResourceTag
RouteFilterPrefix
- RouteFilterPrefix
object
: A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.- cidr CIDR
RouteFilterPrefixList
- RouteFilterPrefixList
array
: A list of routes to be advertised to the AWS network in this region (public virtual interface).- items RouteFilterPrefix
RouterConfig
- RouterConfig
string
StateChangeError
- StateChangeError
string
: Error message when the state of an object fails to advance.
Tag
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items TagKey
TagList
- TagList
array
- items Tag
TagResourceRequest
- TagResourceRequest
object
: Container for the parameters to the TagResource operation.- resourceArn required ResourceArn
- tags required TagList
TagResourceResponse
- TagResourceResponse
object
: The response received when TagResource is called.
TagValue
- TagValue
string
TooManyTagsException
- TooManyTagsException
object
: You have reached the limit on the number of tags that can be assigned to a Direct Connect resource.
UntagResourceRequest
- UntagResourceRequest
object
: Container for the parameters to the UntagResource operation.- resourceArn required ResourceArn
- tagKeys required TagKeyList
UntagResourceResponse
- UntagResourceResponse
object
: The response received when UntagResource is called.
UpdateLagRequest
- UpdateLagRequest
object
: Container for the parameters to the UpdateLag operation.
VLAN
- VLAN
integer
:The VLAN ID.
Example: 101
VirtualGateway
- VirtualGateway
object
:You can create one or more AWS Direct Connect private virtual interfaces linking to your virtual private gateway.
Virtual private gateways can be managed using the Amazon Virtual Private Cloud (Amazon VPC) console or the Amazon EC2 CreateVpnGateway action.
- virtualGatewayId VirtualGatewayId
- virtualGatewayState VirtualGatewayState
VirtualGatewayId
- VirtualGatewayId
string
:The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
VirtualGatewayList
- VirtualGatewayList
array
: A list of virtual private gateways.- items VirtualGateway
VirtualGatewayRegion
- VirtualGatewayRegion
string
:The region in which the virtual private gateway is located.
Example: us-east-1
VirtualGatewayState
- VirtualGatewayState
string
:State of the virtual private gateway.
-
Pending: This is the initial state after calling CreateVpnGateway.
-
Available: Ready for use by a private virtual interface.
-
Deleting: This is the initial state after calling DeleteVpnGateway.
-
Deleted: In this state, a private virtual interface is unable to send traffic over this gateway.
-
VirtualGateways
- VirtualGateways
object
: A structure containing a list of virtual private gateways.- virtualGateways VirtualGatewayList
VirtualInterface
- VirtualInterface
object
: A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.- addressFamily AddressFamily
- amazonAddress AmazonAddress
- amazonSideAsn LongAsn
- asn ASN
- authKey BGPAuthKey
- bgpPeers BGPPeerList
- connectionId ConnectionId
- customerAddress CustomerAddress
- customerRouterConfig RouterConfig
- directConnectGatewayId DirectConnectGatewayId
- location LocationCode
- ownerAccount OwnerAccount
- routeFilterPrefixes RouteFilterPrefixList
- virtualGatewayId VirtualGatewayId
- virtualInterfaceId VirtualInterfaceId
- virtualInterfaceName VirtualInterfaceName
- virtualInterfaceState VirtualInterfaceState
- virtualInterfaceType VirtualInterfaceType
- vlan VLAN
VirtualInterfaceId
- VirtualInterfaceId
string
:The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
VirtualInterfaceList
- VirtualInterfaceList
array
: A list of virtual interfaces.- items VirtualInterface
VirtualInterfaceName
- VirtualInterfaceName
string
:The name of the virtual interface assigned by the customer.
Example: "My VPC"
VirtualInterfaceRegion
- VirtualInterfaceRegion
string
:The region in which the virtual interface is located.
Example: us-east-1
VirtualInterfaceState
- VirtualInterfaceState
string
(values: confirming, verifying, pending, available, down, deleting, deleted, rejected):State of the virtual interface.
-
Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
-
Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
-
Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
-
Available: A virtual interface that is able to forward traffic.
-
Down: A virtual interface that is BGP down.
-
Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
-
Deleted: A virtual interface that cannot forward traffic.
-
Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
-
VirtualInterfaceType
- VirtualInterfaceType
string
:The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
VirtualInterfaces
- VirtualInterfaces
object
: A structure containing a list of virtual interfaces.- virtualInterfaces VirtualInterfaceList