Gives you information about your VPN gateways. You can filter the results to return information
only about VPN gateways that match criteria you specify.
For example, you could ask to get information about a particular VPN gateway (or all) only if
the gateway’s state is pending or available. You can specify multiple filters (e.g., the VPN
gateway is in a particular Availability Zone and the gateway’s state is pending or available).
The result includes information for a particular VPN gateway only if the gateway 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
Parameters
Parameter |
Type |
Required |
Description |
$opt
|
array
|
Optional
|
An associative array of parameters that can have the following keys:
VpnGatewayId - string|array - Optional - A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. Pass a string for a single value, or an indexed array for multiple values.Filter - array - Optional - A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. x - array - Optional - This represents a simple array index. Name - string - Optional - Specifies the name of the filter.Value - string|array - Optional - Contains one or more values for the filter. Pass a string for a single value, or an indexed array for multiple values.
curlopts - array - Optional - A set of values to pass directly into curl_setopt() , where the key is a pre-defined CURLOPT_* constant.returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests. |
Returns
Examples
Describe all VPN gateways.
$ec2 = new AmazonEC2();
$response = $ec2->describe_vpn_gateways();
var_dump($response->isOK());
Result:
bool(true)
Describe all VPN gateways.
$ec2 = new AmazonEC2();
$response = $ec2->describe_vpn_gateways(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
public function describe_vpn_gateways($opt = null)
{
if (!$opt) $opt = array();
// Optional list (non-map)
if (isset($opt['VpnGatewayId']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'VpnGatewayId' => (is_array($opt['VpnGatewayId']) ? $opt['VpnGatewayId'] : array($opt['VpnGatewayId']))
)));
unset($opt['VpnGatewayId']);
}
// Optional list + map
if (isset($opt['Filter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Filter' => $opt['Filter']
)));
unset($opt['Filter']);
}
return $this->authenticate('DescribeVpnGateways', $opt);
}