delete_customer_gateway ( $customer_gateway_id, $opt )

Deletes a customer gateway. You must delete the VPN connection before deleting the customer gateway.

You can have a single active customer gateway per AWS account (active means that you’ve created a VPN connection with that customer gateway). AWS might delete any customer gateway you leave inactive for an extended period of time.

Access

public

Parameters

Parameter

Type

Required

Description

$customer_gateway_id

string

Required

The ID of the customer 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 customer gateway.

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

// Delete the customer gateway
$response = $ec2->delete_customer_gateway('cgw-10a84c79');

// 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_customer_gateway($customer_gateway_id, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['CustomerGatewayId'] = $customer_gateway_id;
    
    return $this->authenticate('DeleteCustomerGateway', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback