delete_security_group ( $opt )

The DeleteSecurityGroup operation deletes a security group.

If you attempt to delete a security group that contains instances, a fault is returned.

If you attempt to delete a security group that is referenced by another security group, a fault is returned. For example, if security group B has a rule that allows access from security group A, security group A cannot be deleted until the allow rule is removed.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • GroupName - string - Optional - The name of the Amazon EC2 security group to delete.
  • GroupId - string - Optional - The ID of the Amazon EC2 security group to delete.
  • 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 security group.

$ec2 = new AmazonEC2();

$response = $ec2->delete_security_group(array('GroupName' => 'my-security-group'));

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

Related Methods

Source

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

public function delete_security_group($opt = null)
{
    if (!$opt) $opt = array();
            
    return $this->authenticate('DeleteSecurityGroup', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback