|
Did this page help you?Yes No Tell us about it... |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceClient
com.amazonaws.services.directconnect.AmazonDirectConnectClient
public class AmazonDirectConnectClient
Client for accessing AmazonDirectConnect. All service calls made using this client are blocking, and will not return until the service call completes.
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 :
Constructor Summary | |
---|---|
AmazonDirectConnectClient()
Constructs a new client to invoke service methods on AmazonDirectConnect. |
|
AmazonDirectConnectClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials. |
|
AmazonDirectConnectClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials and client configuration options. |
|
AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials provider. |
|
AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials provider and client configuration options. |
|
AmazonDirectConnectClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonDirectConnect. |
Method Summary | |
---|---|
CreateConnectionResult |
createConnection(CreateConnectionRequest createConnectionRequest)
Creates a new network connection between the customer network and a specific AWS Direct Connect location. |
CreatePrivateVirtualInterfaceResult |
createPrivateVirtualInterface()
Creates a new private virtual interface. |
CreatePrivateVirtualInterfaceResult |
createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest createPrivateVirtualInterfaceRequest)
Creates a new private virtual interface. |
CreatePublicVirtualInterfaceResult |
createPublicVirtualInterface()
Creates a new public virtual interface. |
CreatePublicVirtualInterfaceResult |
createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest createPublicVirtualInterfaceRequest)
Creates a new public virtual interface. |
DeleteConnectionResult |
deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
Deletes the connection. |
DeleteVirtualInterfaceResult |
deleteVirtualInterface()
Deletes a virtual interface. |
DeleteVirtualInterfaceResult |
deleteVirtualInterface(DeleteVirtualInterfaceRequest deleteVirtualInterfaceRequest)
Deletes a virtual interface. |
DescribeConnectionDetailResult |
describeConnectionDetail(DescribeConnectionDetailRequest describeConnectionDetailRequest)
Displays details about a specific connection including the order steps for the connection and the current state of the connection order. |
DescribeConnectionsResult |
describeConnections()
Displays all connections in this region. |
DescribeConnectionsResult |
describeConnections(DescribeConnectionsRequest describeConnectionsRequest)
Displays all connections in this region. |
DescribeOfferingDetailResult |
describeOfferingDetail(DescribeOfferingDetailRequest describeOfferingDetailRequest)
Displays additional ordering step details for a specified offering. |
DescribeOfferingsResult |
describeOfferings()
Describes one or more of the offerings that are currently available for creating new connections. |
DescribeOfferingsResult |
describeOfferings(DescribeOfferingsRequest describeOfferingsRequest)
Describes one or more of the offerings that are currently available for creating new connections. |
DescribeVirtualGatewaysResult |
describeVirtualGateways()
Returns a list of virtual private gateways owned by the AWS account. |
DescribeVirtualGatewaysResult |
describeVirtualGateways(DescribeVirtualGatewaysRequest describeVirtualGatewaysRequest)
Returns a list of virtual private gateways owned by the AWS account. |
DescribeVirtualInterfacesResult |
describeVirtualInterfaces()
Displays all virtual interfaces for an AWS account. |
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,
String serviceName,
String regionId)
Overrides the default endpoint for this client ("http://directConnect.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. |
Methods inherited from class com.amazonaws.AmazonWebServiceClient |
---|
addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.amazonaws.services.directconnect.AmazonDirectConnect |
---|
setEndpoint, setRegion, shutdown |
Constructor Detail |
---|
public AmazonDirectConnectClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProvider
public AmazonDirectConnectClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonDirectConnect
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProvider
public AmazonDirectConnectClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonDirectConnectClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonDirectConnect
(ex: proxy settings, retry counts, etc.).public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonDirectConnect
(ex: proxy settings, retry counts, etc.).Method Detail |
---|
public DescribeVirtualInterfacesResult describeVirtualInterfaces(DescribeVirtualInterfacesRequest describeVirtualInterfacesRequest) throws AmazonServiceException, AmazonClientException
Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also 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 Direct Connect location and the customer.
describeVirtualInterfaces
in interface AmazonDirectConnect
describeVirtualInterfacesRequest
- Container for the necessary
parameters to execute the DescribeVirtualInterfaces service method on
AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DescribeVirtualGatewaysResult describeVirtualGateways(DescribeVirtualGatewaysRequest describeVirtualGatewaysRequest) throws AmazonServiceException, AmazonClientException
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
in interface AmazonDirectConnect
describeVirtualGatewaysRequest
- Container for the necessary
parameters to execute the DescribeVirtualGateways service method on
AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DescribeConnectionDetailResult describeConnectionDetail(DescribeConnectionDetailRequest describeConnectionDetailRequest) throws AmazonServiceException, AmazonClientException
Displays details about a specific connection including the order steps for the connection and the current state of the connection order.
describeConnectionDetail
in interface AmazonDirectConnect
describeConnectionDetailRequest
- Container for the necessary
parameters to execute the DescribeConnectionDetail service method on
AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DescribeOfferingsResult describeOfferings(DescribeOfferingsRequest describeOfferingsRequest) throws AmazonServiceException, AmazonClientException
Describes one or more of the offerings that are currently available for creating new connections. The results include offerings for all regions.
To order a new connection you need to select a specific offering ID.
describeOfferings
in interface AmazonDirectConnect
describeOfferingsRequest
- Container for the necessary parameters
to execute the DescribeOfferings service method on
AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DescribeConnectionsResult describeConnections(DescribeConnectionsRequest describeConnectionsRequest) throws AmazonServiceException, AmazonClientException
Displays all connections in this region.
If a connection ID is provided, it will only return this particular connection.
describeConnections
in interface AmazonDirectConnect
describeConnectionsRequest
- Container for the necessary
parameters to execute the DescribeConnections service method on
AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DescribeOfferingDetailResult describeOfferingDetail(DescribeOfferingDetailRequest describeOfferingDetailRequest) throws AmazonServiceException, AmazonClientException
Displays additional ordering step details for a specified offering.
describeOfferingDetail
in interface AmazonDirectConnect
describeOfferingDetailRequest
- Container for the necessary
parameters to execute the DescribeOfferingDetail service method on
AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest) throws AmazonServiceException, AmazonClientException
Deletes the connection.
Deleting a connection only stops the AWS Direct Connect port and data transfer charges. You separately need to cancel any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location with the providers of those services.
deleteConnection
in interface AmazonDirectConnect
deleteConnectionRequest
- Container for the necessary parameters
to execute the DeleteConnection service method on AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public CreateConnectionResult createConnection(CreateConnectionRequest createConnectionRequest) throws AmazonServiceException, AmazonClientException
Creates a new network 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. A 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.
createConnection
in interface AmazonDirectConnect
createConnectionRequest
- Container for the necessary parameters
to execute the CreateConnection service method on AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public CreatePrivateVirtualInterfaceResult createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest createPrivateVirtualInterfaceRequest) throws AmazonServiceException, AmazonClientException
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).
createPrivateVirtualInterface
in interface AmazonDirectConnect
createPrivateVirtualInterfaceRequest
- Container for the
necessary parameters to execute the CreatePrivateVirtualInterface
service method on AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DeleteVirtualInterfaceResult deleteVirtualInterface(DeleteVirtualInterfaceRequest deleteVirtualInterfaceRequest) throws AmazonServiceException, AmazonClientException
Deletes a virtual interface.
deleteVirtualInterface
in interface AmazonDirectConnect
deleteVirtualInterfaceRequest
- Container for the necessary
parameters to execute the DeleteVirtualInterface service method on
AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public CreatePublicVirtualInterfaceResult createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest createPublicVirtualInterfaceRequest) throws AmazonServiceException, AmazonClientException
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).
createPublicVirtualInterface
in interface AmazonDirectConnect
createPublicVirtualInterfaceRequest
- Container for the necessary
parameters to execute the CreatePublicVirtualInterface service method
on AmazonDirectConnect.
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DescribeVirtualInterfacesResult describeVirtualInterfaces() throws AmazonServiceException, AmazonClientException
Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also 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 Direct Connect location and the customer.
describeVirtualInterfaces
in interface AmazonDirectConnect
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DescribeVirtualGatewaysResult describeVirtualGateways() throws AmazonServiceException, AmazonClientException
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
in interface AmazonDirectConnect
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DescribeOfferingsResult describeOfferings() throws AmazonServiceException, AmazonClientException
Describes one or more of the offerings that are currently available for creating new connections. The results include offerings for all regions.
To order a new connection you need to select a specific offering ID.
describeOfferings
in interface AmazonDirectConnect
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DescribeConnectionsResult describeConnections() throws AmazonServiceException, AmazonClientException
Displays all connections in this region.
If a connection ID is provided, it will only return this particular connection.
describeConnections
in interface AmazonDirectConnect
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public CreatePrivateVirtualInterfaceResult createPrivateVirtualInterface() throws AmazonServiceException, AmazonClientException
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).
createPrivateVirtualInterface
in interface AmazonDirectConnect
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public DeleteVirtualInterfaceResult deleteVirtualInterface() throws AmazonServiceException, AmazonClientException
Deletes a virtual interface.
deleteVirtualInterface
in interface AmazonDirectConnect
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public CreatePublicVirtualInterfaceResult createPublicVirtualInterface() throws AmazonServiceException, AmazonClientException
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).
createPublicVirtualInterface
in interface AmazonDirectConnect
DirectConnectServerException
DirectConnectClientException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AmazonDirectConnect indicating
either a problem with the data in the request, or a server side issue.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
This method is not threadsafe. Endpoints 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.
Callers can pass in just the endpoint (ex: "directConnect.us-east-1.amazonaws.com/") or a full
URL, including the protocol (ex: "http://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
endpoint
- The endpoint (ex: "directConnect.us-east-1.amazonaws.com/") or a full URL,
including the protocol (ex: "http://directConnect.us-east-1.amazonaws.com/") of
the region specific AWS endpoint this client will communicate
with.serviceName
- The name of the AWS service to use when signing requests.regionId
- The ID of the region in which this service resides.
IllegalArgumentException
- If any problems are detected with the specified endpoint.AmazonDynamoDB#setRegion(Region)
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AmazonDirectConnect
request
- The originally executed request
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |