Interface AmazonDirectConnect
-
- All Known Subinterfaces:
AmazonDirectConnectAsync
- All Known Implementing Classes:
AbstractAmazonDirectConnect
,AbstractAmazonDirectConnectAsync
,AmazonDirectConnectAsyncClient
,AmazonDirectConnectClient
public interface AmazonDirectConnect
Interface for accessing AWS Direct Connect.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).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AllocateConnectionOnInterconnectResult
allocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest allocateConnectionOnInterconnectRequest)
Creates a hosted connection on an interconnect.AllocatePrivateVirtualInterfaceResult
allocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest allocatePrivateVirtualInterfaceRequest)
Provisions a private virtual interface to be owned by a different customer.AllocatePublicVirtualInterfaceResult
allocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest allocatePublicVirtualInterfaceRequest)
Provisions a public virtual interface to be owned by a different customer.ConfirmConnectionResult
confirmConnection(ConfirmConnectionRequest confirmConnectionRequest)
Confirm the creation of a hosted connection on an interconnect.ConfirmPrivateVirtualInterfaceResult
confirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest confirmPrivateVirtualInterfaceRequest)
Accept ownership of a private virtual interface created by another customer.ConfirmPublicVirtualInterfaceResult
confirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest confirmPublicVirtualInterfaceRequest)
Accept ownership of a public virtual interface created by another customer.CreateConnectionResult
createConnection(CreateConnectionRequest createConnectionRequest)
Creates a new connection between the customer network and a specific AWS Direct Connect location.CreateInterconnectResult
createInterconnect(CreateInterconnectRequest createInterconnectRequest)
Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.CreatePrivateVirtualInterfaceResult
createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest createPrivateVirtualInterfaceRequest)
Creates a new private virtual interface.CreatePublicVirtualInterfaceResult
createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest createPublicVirtualInterfaceRequest)
Creates a new public virtual interface.DeleteConnectionResult
deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
Deletes the connection.DeleteInterconnectResult
deleteInterconnect(DeleteInterconnectRequest deleteInterconnectRequest)
Deletes the specified interconnect.DeleteVirtualInterfaceResult
deleteVirtualInterface(DeleteVirtualInterfaceRequest deleteVirtualInterfaceRequest)
Deletes a virtual interface.DescribeConnectionsResult
describeConnections()
Simplified method form for invoking the DescribeConnections operation.DescribeConnectionsResult
describeConnections(DescribeConnectionsRequest describeConnectionsRequest)
Displays all connections in this region.DescribeConnectionsOnInterconnectResult
describeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest describeConnectionsOnInterconnectRequest)
Return a list of connections that have been provisioned on the given interconnect.DescribeInterconnectsResult
describeInterconnects()
Simplified method form for invoking the DescribeInterconnects operation.DescribeInterconnectsResult
describeInterconnects(DescribeInterconnectsRequest describeInterconnectsRequest)
Returns a list of interconnects owned by the AWS account.DescribeLocationsResult
describeLocations()
Simplified method form for invoking the DescribeLocations operation.DescribeLocationsResult
describeLocations(DescribeLocationsRequest describeLocationsRequest)
Returns the list of AWS Direct Connect locations in the current AWS region.DescribeVirtualGatewaysResult
describeVirtualGateways()
Simplified method form for invoking the DescribeVirtualGateways operation.DescribeVirtualGatewaysResult
describeVirtualGateways(DescribeVirtualGatewaysRequest describeVirtualGatewaysRequest)
Returns a list of virtual private gateways owned by the AWS account.DescribeVirtualInterfacesResult
describeVirtualInterfaces()
Simplified method form for invoking the DescribeVirtualInterfaces operation.DescribeVirtualInterfacesResult
describeVirtualInterfaces(DescribeVirtualInterfacesRequest describeVirtualInterfacesRequest)
Displays all virtual interfaces for an AWS account.ResponseMetadata
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.void
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://directconnect.us-east-1.amazonaws.com/").void
setRegion(Region region)
An alternative tosetEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.
-
-
-
Method Detail
-
setEndpoint
void setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://directconnect.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "directconnect.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://directconnect.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Parameters:
endpoint
- The endpoint (ex: "directconnect.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://directconnect.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
-
setRegion
void setRegion(Region region)
An alternative tosetEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
Region.getRegion(com.amazonaws.regions.Regions)
,Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,Region.isServiceSupported(String)
-
allocateConnectionOnInterconnect
AllocateConnectionOnInterconnectResult allocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest 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.
This is intended for use by AWS Direct Connect partners only.
- Parameters:
allocateConnectionOnInterconnectRequest
- Container for the parameters to the AllocateConnectionOnInterconnect operation.- Returns:
- Result of the AllocateConnectionOnInterconnect operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
allocatePrivateVirtualInterface
AllocatePrivateVirtualInterfaceResult allocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest 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.
- Parameters:
allocatePrivateVirtualInterfaceRequest
- Container for the parameters to the AllocatePrivateVirtualInterface operation.- Returns:
- Result of the AllocatePrivateVirtualInterface operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
allocatePublicVirtualInterface
AllocatePublicVirtualInterfaceResult allocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest 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.
- Parameters:
allocatePublicVirtualInterfaceRequest
- Container for the parameters to the AllocatePublicVirtualInterface operation.- Returns:
- Result of the AllocatePublicVirtualInterface operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
confirmConnection
ConfirmConnectionResult confirmConnection(ConfirmConnectionRequest 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.
- Parameters:
confirmConnectionRequest
- Container for the parameters to the ConfirmConnection operation.- Returns:
- Result of the ConfirmConnection operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
confirmPrivateVirtualInterface
ConfirmPrivateVirtualInterfaceResult confirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest 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.
- Parameters:
confirmPrivateVirtualInterfaceRequest
- Container for the parameters to the ConfirmPrivateVirtualInterface operation.- Returns:
- Result of the ConfirmPrivateVirtualInterface operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
confirmPublicVirtualInterface
ConfirmPublicVirtualInterfaceResult confirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest 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.
- Parameters:
confirmPublicVirtualInterfaceRequest
- Container for the parameters to the ConfirmPublicVirtualInterface operation.- Returns:
- Result of the ConfirmPublicVirtualInterface operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
createConnection
CreateConnectionResult createConnection(CreateConnectionRequest 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.
- Parameters:
createConnectionRequest
- Container for the parameters to the CreateConnection operation.- Returns:
- Result of the CreateConnection operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
createInterconnect
CreateInterconnectResult createInterconnect(CreateInterconnectRequest 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.
This is intended for use by AWS Direct Connect partners only.
- Parameters:
createInterconnectRequest
- Container for the parameters to the CreateInterconnect operation.- Returns:
- Result of the CreateInterconnect operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
createPrivateVirtualInterface
CreatePrivateVirtualInterfaceResult createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest 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).
- Parameters:
createPrivateVirtualInterfaceRequest
- Container for the parameters to the CreatePrivateVirtualInterface operation.- Returns:
- Result of the CreatePrivateVirtualInterface operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
createPublicVirtualInterface
CreatePublicVirtualInterfaceResult createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest 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).
- Parameters:
createPublicVirtualInterfaceRequest
- Container for the parameters to the CreatePublicVirtualInterface operation.- Returns:
- Result of the CreatePublicVirtualInterface operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
deleteConnection
DeleteConnectionResult deleteConnection(DeleteConnectionRequest 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.
- Parameters:
deleteConnectionRequest
- Container for the parameters to the DeleteConnection operation.- Returns:
- Result of the DeleteConnection operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
deleteInterconnect
DeleteInterconnectResult deleteInterconnect(DeleteInterconnectRequest deleteInterconnectRequest)
Deletes the specified interconnect.
This is intended for use by AWS Direct Connect partners only.
- Parameters:
deleteInterconnectRequest
- Container for the parameters to the DeleteInterconnect operation.- Returns:
- Result of the DeleteInterconnect operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
deleteVirtualInterface
DeleteVirtualInterfaceResult deleteVirtualInterface(DeleteVirtualInterfaceRequest deleteVirtualInterfaceRequest)
Deletes a virtual interface.
- Parameters:
deleteVirtualInterfaceRequest
- Container for the parameters to the DeleteVirtualInterface operation.- Returns:
- Result of the DeleteVirtualInterface operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
describeConnections
DescribeConnectionsResult describeConnections(DescribeConnectionsRequest describeConnectionsRequest)
Displays all connections in this region.
If a connection ID is provided, the call returns only that particular connection.
- Parameters:
describeConnectionsRequest
- Container for the parameters to the DescribeConnections operation.- Returns:
- Result of the DescribeConnections operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
describeConnections
DescribeConnectionsResult describeConnections()
Simplified method form for invoking the DescribeConnections operation.
-
describeConnectionsOnInterconnect
DescribeConnectionsOnInterconnectResult describeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest describeConnectionsOnInterconnectRequest)
Return a list of connections that have been provisioned on the given interconnect.
This is intended for use by AWS Direct Connect partners only.
- Parameters:
describeConnectionsOnInterconnectRequest
- Container for the parameters to the DescribeConnectionsOnInterconnect operation.- Returns:
- Result of the DescribeConnectionsOnInterconnect operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
describeInterconnects
DescribeInterconnectsResult describeInterconnects(DescribeInterconnectsRequest describeInterconnectsRequest)
Returns a list of interconnects owned by the AWS account.
If an interconnect ID is provided, it will only return this particular interconnect.
- Parameters:
describeInterconnectsRequest
- Container for the parameters to the DescribeInterconnects operation.- Returns:
- Result of the DescribeInterconnects operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
describeInterconnects
DescribeInterconnectsResult describeInterconnects()
Simplified method form for invoking the DescribeInterconnects operation.
-
describeLocations
DescribeLocationsResult describeLocations(DescribeLocationsRequest 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.
- Parameters:
describeLocationsRequest
-- Returns:
- Result of the DescribeLocations operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
describeLocations
DescribeLocationsResult describeLocations()
Simplified method form for invoking the DescribeLocations operation.
-
describeVirtualGateways
DescribeVirtualGatewaysResult describeVirtualGateways(DescribeVirtualGatewaysRequest 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.
- Parameters:
describeVirtualGatewaysRequest
-- Returns:
- Result of the DescribeVirtualGateways operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
describeVirtualGateways
DescribeVirtualGatewaysResult describeVirtualGateways()
Simplified method form for invoking the DescribeVirtualGateways operation.
-
describeVirtualInterfaces
DescribeVirtualInterfacesResult describeVirtualInterfaces(DescribeVirtualInterfacesRequest 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.
- Parameters:
describeVirtualInterfacesRequest
- Container for the parameters to the DescribeVirtualInterfaces operation.- Returns:
- Result of the DescribeVirtualInterfaces operation returned by the service.
- Throws:
DirectConnectServerException
- A server-side error occurred during the API call. The error message will contain additional details about the cause.DirectConnectClientException
- The API was called with invalid parameters. The error message will contain additional details about the cause.
-
describeVirtualInterfaces
DescribeVirtualInterfacesResult describeVirtualInterfaces()
Simplified method form for invoking the DescribeVirtualInterfaces operation.
-
shutdown
void shutdown()
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
-
getCachedResponseMetadata
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-