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 |
---|---|---|---|
|
Required |
The ID of the customer gateway to delete. |
|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
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