Zend_Service_Amazon_Ec2_Securitygroups Class Reference

Inheritance diagram for Zend_Service_Amazon_Ec2_Securitygroups:

Collaboration diagram for Zend_Service_Amazon_Ec2_Securitygroups:

Public Member Functions
	create ($name, $description)
	describe ($name=null)
	delete ($name)
	authorizeIp ($name, $ipProtocol, $fromPort, $toPort, $cidrIp)
	authorizeGroup ($name, $groupName, $ownerId)
	revokeIp ($name, $ipProtocol, $fromPort, $toPort, $cidrIp)
	revokeGroup ($name, $groupName, $ownerId)

---

Detailed Description

Definition at line 37 of file Securitygroups.php.

---

Member Function Documentation

authorizeGroup	(	$	name,
		$	groupName,
		$	ownerId
	)

Adds permissions to a security group

When authorizing a user/group pair permission, GroupName, SourceSecurityGroupName and SourceSecurityGroupOwnerId must be specified.

Permission changes are propagated to instances within the security group as quickly as possible. However, depending on the number of instances, a small delay might occur.

Parameters:

string	$name	Name of the group to modify.
string	$groupName	Name of security group to authorize access to when operating on a user/group pair.
string	$ownerId	Owner of security group to authorize access to when operating on a user/group pair.

Returns:

boolean

Definition at line 214 of file Securitygroups.php.

Here is the call graph for this function:

authorizeIp	(	$	name,
		$	ipProtocol,
		$	fromPort,
		$	toPort,
		$	cidrIp
	)

Adds permissions to a security group

Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used as a wildcard in the type and code fields.

Permission changes are propagated to instances within the security group as quickly as possible. However, depending on the number of instances, a small delay might occur.

Parameters:

string	$name	Name of the group to modify.
string	$ipProtocol	IP protocol to authorize access to when operating on a CIDR IP.
integer	$fromPort	Bottom of port range to authorize access to when operating on a CIDR IP. This contains the ICMP type if ICMP is being authorized.
integer	$toPort	Top of port range to authorize access to when operating on a CIDR IP. This contains the ICMP code if ICMP is being authorized.
string	$cidrIp	CIDR IP range to authorize access to when operating on a CIDR IP.

Returns:

boolean

Definition at line 182 of file Securitygroups.php.

Here is the call graph for this function:

create	(	$	name,
		$	description
	)

Creates a new security group.

Every instance is launched in a security group. If no security group is specified during launch, the instances are launched in the default security group. Instances within the same security group have unrestricted network access to each other. Instances will reject network access attempts from other instances in a different security group. As the owner of instances you can grant or revoke specific permissions using the authorizeIp, authorizeGroup, revokeGroup and {$link revokeIp} operations.

Parameters:

string	$name	Name of the new security group.
string	$description	Description of the new security group.

Returns:

boolean

Definition at line 54 of file Securitygroups.php.

Here is the call graph for this function:

delete

(

$

name

)

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.

Parameters:

string

$name

Name of the security group to delete.

Returns:

boolean

Definition at line 148 of file Securitygroups.php.

Here is the call graph for this function:

describe

(

$

name = null

)

Returns information about security groups that you own.

If you specify security group names, information about those security group is returned. Otherwise, information for all security group is returned. If you specify a group that does not exist, a fault is returned.

Parameters:

string | array

$name

List of security groups to describe

Returns:

array

Definition at line 78 of file Securitygroups.php.

Here is the call graph for this function:

revokeGroup	(	$	name,
		$	groupName,
		$	ownerId
	)

Revokes permissions from a security group. The permissions used to revoke must be specified using the same values used to grant the permissions.

Permission changes are propagated to instances within the security group as quickly as possible. However, depending on the number of instances, a small delay might occur.

When revoking a user/group pair permission, GroupName, SourceSecurityGroupName and SourceSecurityGroupOwnerId must be specified.

Parameters:

string	$name	Name of the group to modify.
string	$groupName	Name of security group to revoke access to when operating on a user/group pair.
string	$ownerId	Owner of security group to revoke access to when operating on a user/group pair.

Returns:

boolean

Definition at line 285 of file Securitygroups.php.

Here is the call graph for this function:

revokeIp	(	$	name,
		$	ipProtocol,
		$	fromPort,
		$	toPort,
		$	cidrIp
	)

Revokes permissions from a security group. The permissions used to revoke must be specified using the same values used to grant the permissions.

Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used as a wildcard in the type and code fields.

Permission changes are propagated to instances within the security group as quickly as possible. However, depending on the number of instances, a small delay might occur.

Parameters:

string	$name	Name of the group to modify.
string	$ipProtocol	IP protocol to revoke access to when operating on a CIDR IP.
integer	$fromPort	Bottom of port range to revoke access to when operating on a CIDR IP. This contains the ICMP type if ICMP is being revoked.
integer	$toPort	Top of port range to revoked access to when operating on a CIDR IP. This contains the ICMP code if ICMP is being revoked.
string	$cidrIp	CIDR IP range to revoke access to when operating on a CIDR IP.

Returns:

boolean

Definition at line 253 of file Securitygroups.php.

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/zend/Zend/Service/Amazon/Ec2/Securitygroups.php