Gives you information about your VPN connections.
We strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.
You can filter the results to return information only about VPN connections that match criteria you specify. For example, you could ask to get information about a particular VPN connection (or all) only if the VPN’s state is pending or available. You can specify multiple filters (e.g., the VPN connection is associated with a particular VPN gateway, and the gateway’s state is pending or available). The result includes information for a particular VPN connection only if the VPN connection matches all your filters. If there’s no match, no special message is returned; the response is simply empty. The following table shows the available filters.
Access
public
Parameters
Parameter |
Type |
Required |
Description |
---|---|---|---|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
Examples
Describe all VPN connections.
$ec2 = new AmazonEC2(); $response = $ec2->describe_vpn_connections(); var_dump($response->isOK());Result:
bool(true)
Filter VPN connections by available state.
$ec2 = new AmazonEC2(); $response = $ec2->describe_vpn_connections(array( 'Filter' => array( array('Name' => 'state', 'Value' => 'available') ), )); var_dump($response->isOK());Result:
bool(true)
Related Methods
Source
Method defined in services/ec2.class.php | Toggle source view (24 lines) | View on GitHub