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.
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:
Namespace: Amazon.DirectConnect
Assembly: AWSSDK.dll
Version: (assembly version)
public class AmazonDirectConnectClient : AmazonServiceClient IAmazonDirectConnect, IDisposable
The AmazonDirectConnectClient type exposes the following members
Name | Description | |
---|---|---|
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> |
|
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> |
|
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> |
|
AmazonDirectConnectClient(AWSCredentials) | Constructs AmazonDirectConnectClient with AWS Credentials | |
AmazonDirectConnectClient(AWSCredentials, RegionEndpoint) | Constructs AmazonDirectConnectClient with AWS Credentials | |
AmazonDirectConnectClient(AWSCredentials, AmazonDirectConnectConfig) | Constructs AmazonDirectConnectClient with AWS Credentials and an AmazonDirectConnectClient Configuration object. | |
AmazonDirectConnectClient(string, string) | Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key | |
AmazonDirectConnectClient(string, string, RegionEndpoint) | Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key | |
AmazonDirectConnectClient(string, string, AmazonDirectConnectConfig) | Constructs AmazonDirectConnectClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectConnectClient Configuration object. | |
AmazonDirectConnectClient(string, string, string) | Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key | |
AmazonDirectConnectClient(string, string, string, RegionEndpoint) | Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key | |
AmazonDirectConnectClient(string, string, string, AmazonDirectConnectConfig) | Constructs AmazonDirectConnectClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectConnectClient Configuration object. |
Name | Description | |
---|---|---|
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. |
|
AllocateConnectionOnInterconnectAsync(AllocateConnectionOnInterconnectRequest, CancellationToken) | Initiates the asynchronous execution of the AllocateConnectionOnInterconnect operation. | |
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. |
|
AllocatePrivateVirtualInterfaceAsync(AllocatePrivateVirtualInterfaceRequest, CancellationToken) | Initiates the asynchronous execution of the AllocatePrivateVirtualInterface operation. | |
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. |
|
AllocatePublicVirtualInterfaceAsync(AllocatePublicVirtualInterfaceRequest, CancellationToken) | Initiates the asynchronous execution of the AllocatePublicVirtualInterface operation. | |
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. |
|
ConfirmConnectionAsync(ConfirmConnectionRequest, CancellationToken) | Initiates the asynchronous execution of the ConfirmConnection operation. | |
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. |
|
ConfirmPrivateVirtualInterfaceAsync(ConfirmPrivateVirtualInterfaceRequest, CancellationToken) | Initiates the asynchronous execution of the ConfirmPrivateVirtualInterface operation. | |
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. |
|
ConfirmPublicVirtualInterfaceAsync(ConfirmPublicVirtualInterfaceRequest, CancellationToken) | Initiates the asynchronous execution of the ConfirmPublicVirtualInterface operation. | |
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. |
|
CreateConnectionAsync(CreateConnectionRequest, CancellationToken) | Initiates the asynchronous execution of the CreateConnection operation. | |
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. |
|
CreateInterconnectAsync(CreateInterconnectRequest, CancellationToken) | Initiates the asynchronous execution of the CreateInterconnect operation. | |
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). | |
CreatePrivateVirtualInterfaceAsync(CreatePrivateVirtualInterfaceRequest, CancellationToken) | Initiates the asynchronous execution of the CreatePrivateVirtualInterface operation. | |
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). | |
CreatePublicVirtualInterfaceAsync(CreatePublicVirtualInterfaceRequest, CancellationToken) | Initiates the asynchronous execution of the CreatePublicVirtualInterface operation. | |
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. |
|
DeleteConnectionAsync(DeleteConnectionRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteConnection operation. | |
DeleteInterconnect(DeleteInterconnectRequest) | Deletes the specified interconnect. | |
DeleteInterconnectAsync(DeleteInterconnectRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteInterconnect operation. | |
DeleteVirtualInterface(DeleteVirtualInterfaceRequest) | Deletes a virtual interface. | |
DeleteVirtualInterfaceAsync(DeleteVirtualInterfaceRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteVirtualInterface operation. | |
DescribeConnections() |
Displays all connections in this region.
If a connection ID is provided, the call returns only that particular connection. |
|
DescribeConnections(DescribeConnectionsRequest) |
Displays all connections in this region.
If a connection ID is provided, the call returns only that particular connection. |
|
DescribeConnectionsAsync(DescribeConnectionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeConnections operation. | |
DescribeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest) | Return a list of connections that have been provisioned on the given interconnect. | |
DescribeConnectionsOnInterconnectAsync(DescribeConnectionsOnInterconnectRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeConnectionsOnInterconnect operation. | |
DescribeInterconnects() |
Returns a list of interconnects owned by the AWS account.
If an interconnect ID is provided, it will only return this particular interconnect. |
|
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. |
|
DescribeInterconnectsAsync(DescribeInterconnectsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeInterconnects operation. | |
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. | |
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. | |
DescribeLocationsAsync(DescribeLocationsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeLocations operation. | |
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. |
|
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. |
|
DescribeVirtualGatewaysAsync(DescribeVirtualGatewaysRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeVirtualGateways operation. | |
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. |
|
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. |
|
DescribeVirtualInterfacesAsync(DescribeVirtualInterfacesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeVirtualInterfaces operation. | |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8