AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
Implementation for accessing DirectConnect AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to Amazon Web Services (AWS). Using AWS Direct Connect, you can establish private connectivity between AWS and your data center, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections.

The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the AWS Direct Connect API Reference:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.DirectConnect.AmazonDirectConnectClient

Namespace: Amazon.DirectConnect
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class AmazonDirectConnectClient : AmazonServiceClient
         IAmazonDirectConnect, IDisposable

The AmazonDirectConnectClient type exposes the following members

Constructors

NameDescription
Public Method AmazonDirectConnectClient() Constructs AmazonDirectConnectClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonDirectConnectClient(RegionEndpoint) Constructs AmazonDirectConnectClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonDirectConnectClient(AmazonDirectConnectConfig) Constructs AmazonDirectConnectClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonDirectConnectClient(AWSCredentials) Constructs AmazonDirectConnectClient with AWS Credentials
Public Method AmazonDirectConnectClient(AWSCredentials, RegionEndpoint) Constructs AmazonDirectConnectClient with AWS Credentials
Public Method AmazonDirectConnectClient(AWSCredentials, AmazonDirectConnectConfig) Constructs AmazonDirectConnectClient with AWS Credentials and an AmazonDirectConnectClient Configuration object.
Public Method AmazonDirectConnectClient(string, string) Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDirectConnectClient(string, string, RegionEndpoint) Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDirectConnectClient(string, string, AmazonDirectConnectConfig) Constructs AmazonDirectConnectClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectConnectClient Configuration object.
Public Method AmazonDirectConnectClient(string, string, string) Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDirectConnectClient(string, string, string, RegionEndpoint) Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDirectConnectClient(string, string, string, AmazonDirectConnectConfig) Constructs AmazonDirectConnectClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectConnectClient Configuration object.

Methods

NameDescription
Public Method AllocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest) Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.

Public Method AllocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest) 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.

Public Method AllocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest) 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.

Public Method BeginAllocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest, AsyncCallback, object) Initiates the asynchronous execution of the AllocateConnectionOnInterconnect operation.
Public Method BeginAllocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest, AsyncCallback, object) Initiates the asynchronous execution of the AllocatePrivateVirtualInterface operation.
Public Method BeginAllocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest, AsyncCallback, object) Initiates the asynchronous execution of the AllocatePublicVirtualInterface operation.
Public Method BeginConfirmConnection(ConfirmConnectionRequest, AsyncCallback, object) Initiates the asynchronous execution of the ConfirmConnection operation.
Public Method BeginConfirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest, AsyncCallback, object) Initiates the asynchronous execution of the ConfirmPrivateVirtualInterface operation.
Public Method BeginConfirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest, AsyncCallback, object) Initiates the asynchronous execution of the ConfirmPublicVirtualInterface operation.
Public Method BeginCreateConnection(CreateConnectionRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateConnection operation.
Public Method BeginCreateInterconnect(CreateInterconnectRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateInterconnect operation.
Public Method BeginCreatePrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreatePrivateVirtualInterface operation.
Public Method BeginCreatePublicVirtualInterface(CreatePublicVirtualInterfaceRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreatePublicVirtualInterface operation.
Public Method BeginDeleteConnection(DeleteConnectionRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteConnection operation.
Public Method BeginDeleteInterconnect(DeleteInterconnectRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteInterconnect operation.
Public Method BeginDeleteVirtualInterface(DeleteVirtualInterfaceRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteVirtualInterface operation.
Public Method BeginDescribeConnections(DescribeConnectionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeConnections operation.
Public Method BeginDescribeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeConnectionsOnInterconnect operation.
Public Method BeginDescribeInterconnects(DescribeInterconnectsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeInterconnects operation.
Public Method BeginDescribeLocations(DescribeLocationsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLocations operation.
Public Method BeginDescribeVirtualGateways(DescribeVirtualGatewaysRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeVirtualGateways operation.
Public Method BeginDescribeVirtualInterfaces(DescribeVirtualInterfacesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeVirtualInterfaces operation.
Public Method ConfirmConnection(ConfirmConnectionRequest) Confirm the creation of a hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.

Public Method ConfirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest) Accept ownership of a private virtual interface created by another customer.

After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.

Public Method ConfirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest) Accept ownership of a public virtual interface created by another customer.

After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.

Public Method CreateConnection(CreateConnectionRequest) Creates a new connection between the customer network and a specific AWS Direct Connect location.

A connection 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. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.

Public Method CreateInterconnect(CreateInterconnectRequest) Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.

An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.

For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.

Public Method CreatePrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest) Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).
Public Method CreatePublicVirtualInterface(CreatePublicVirtualInterfaceRequest) Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).
Public Method DeleteConnection(DeleteConnectionRequest) Deletes the connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.

Public Method DeleteInterconnect(DeleteInterconnectRequest) Deletes the specified interconnect.
Public Method DeleteVirtualInterface(DeleteVirtualInterfaceRequest) Deletes a virtual interface.
Public Method DescribeConnections() Displays all connections in this region.

If a connection ID is provided, the call returns only that particular connection.

Public Method DescribeConnections(DescribeConnectionsRequest) Displays all connections in this region.

If a connection ID is provided, the call returns only that particular connection.

Public Method DescribeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest) Return a list of connections that have been provisioned on the given interconnect.
Public Method DescribeInterconnects() Returns a list of interconnects owned by the AWS account.

If an interconnect ID is provided, it will only return this particular interconnect.

Public Method DescribeInterconnects(DescribeInterconnectsRequest) Returns a list of interconnects owned by the AWS account.

If an interconnect ID is provided, it will only return this particular interconnect.

Public Method DescribeLocations() Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.
Public Method DescribeLocations(DescribeLocationsRequest) Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.
Public Method DescribeVirtualGateways() Returns a list of virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

Public Method DescribeVirtualGateways(DescribeVirtualGatewaysRequest) Returns a list of virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

Public Method DescribeVirtualInterfaces() Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.

Public Method DescribeVirtualInterfaces(DescribeVirtualInterfacesRequest) Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EndAllocateConnectionOnInterconnect(IAsyncResult) Finishes the asynchronous execution of the AllocateConnectionOnInterconnect operation.
Public Method EndAllocatePrivateVirtualInterface(IAsyncResult) Finishes the asynchronous execution of the AllocatePrivateVirtualInterface operation.
Public Method EndAllocatePublicVirtualInterface(IAsyncResult) Finishes the asynchronous execution of the AllocatePublicVirtualInterface operation.
Public Method EndConfirmConnection(IAsyncResult) Finishes the asynchronous execution of the ConfirmConnection operation.
Public Method EndConfirmPrivateVirtualInterface(IAsyncResult) Finishes the asynchronous execution of the ConfirmPrivateVirtualInterface operation.
Public Method EndConfirmPublicVirtualInterface(IAsyncResult) Finishes the asynchronous execution of the ConfirmPublicVirtualInterface operation.
Public Method EndCreateConnection(IAsyncResult) Finishes the asynchronous execution of the CreateConnection operation.
Public Method EndCreateInterconnect(IAsyncResult) Finishes the asynchronous execution of the CreateInterconnect operation.
Public Method EndCreatePrivateVirtualInterface(IAsyncResult) Finishes the asynchronous execution of the CreatePrivateVirtualInterface operation.
Public Method EndCreatePublicVirtualInterface(IAsyncResult) Finishes the asynchronous execution of the CreatePublicVirtualInterface operation.
Public Method EndDeleteConnection(IAsyncResult) Finishes the asynchronous execution of the DeleteConnection operation.
Public Method EndDeleteInterconnect(IAsyncResult) Finishes the asynchronous execution of the DeleteInterconnect operation.
Public Method EndDeleteVirtualInterface(IAsyncResult) Finishes the asynchronous execution of the DeleteVirtualInterface operation.
Public Method EndDescribeConnections(IAsyncResult) Finishes the asynchronous execution of the DescribeConnections operation.
Public Method EndDescribeConnectionsOnInterconnect(IAsyncResult) Finishes the asynchronous execution of the DescribeConnectionsOnInterconnect operation.
Public Method EndDescribeInterconnects(IAsyncResult) Finishes the asynchronous execution of the DescribeInterconnects operation.
Public Method EndDescribeLocations(IAsyncResult) Finishes the asynchronous execution of the DescribeLocations operation.
Public Method EndDescribeVirtualGateways(IAsyncResult) Finishes the asynchronous execution of the DescribeVirtualGateways operation.
Public Method EndDescribeVirtualInterfaces(IAsyncResult) Finishes the asynchronous execution of the DescribeVirtualInterfaces operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8