delete_vpn_gateway ( $vpn_gateway_id, $opt )

Deletes a VPN gateway. Use this when you want to delete a VPC and all its associated components because you no longer need them. We recommend that before you delete a VPN gateway, you detach it from the VPC and delete the VPN connection. Note that you don’t need to delete the VPN gateway if you just want to delete and re-create the VPN connection between your VPC and data center.

Access

public

Parameters

Parameter

Type

Required

Description

$vpn_gateway_id

string

Required

The ID of the VPN gateway to delete.

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • 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

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Delete a VPN gateway.

// Instantiate the class
$ec2 = new AmazonEC2();

// Delete the VPN gateway
$response = $ec2->delete_vpn_gateway('vgw-42ad482b');

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/ec2.class.php | Toggle source view (7 lines) | View on GitHub

public function delete_vpn_gateway($vpn_gateway_id, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['VpnGatewayId'] = $vpn_gateway_id;
    
    return $this->authenticate('DeleteVpnGateway', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback