Service/Amazon/Ec2/Securitygroups.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service_Amazon
subpackage: Ec2
version: $Id: Securitygroups.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Service_Amazon_Ec2_Securitygroups

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Service_Amazon_Ec2_Securitygroups
jump to top

Extends from: Zend_Service_Amazon_Ec2_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service_Amazon
subpackage: Ec2
Methods: create; describe; delete; authorizeIp; authorizeGroup; revokeIp; revokeGroup

Description

An Amazon EC2 interface to create, delete, describe, grand and revoke sercurity permissions.

Methods

authorizeGroup
jump to class

authorizeGroup(
          string $name, string $groupName, string $ownerId
          )
        
        :
        boolean

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.

Arguments

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

Output

boolean

Details

visibility: public
final: false
static: false

authorizeIp
jump to class

authorizeIp(
          string $name, string $ipProtocol, integer $fromPort, integer $toPort, string $cidrIp
          )
        
        :
        boolean

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.

Arguments

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

Output

boolean

Details

visibility: public
final: false
static: false

create
jump to class

create(
          string $name, string $description
          )
        
        :
        boolean

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 {@link authorizeIp}, {@link authorizeGroup}, {@link revokeGroup} and {$link revokeIp} operations.

Arguments

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

Output

boolean

Details

visibility: public
final: false
static: false

delete
jump to class

delete(
          string $name
          )
        
        :
        boolean

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.

Arguments

$name: string
Name of the security group to delete.

Output

boolean

Details

visibility: public
final: false
static: false

describe
jump to class

describe(
          string|array $name
              =
              null
          )
        
        :
        array

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.

Arguments

$name: stringarray
List of security groups to describe

Output

array

Details

visibility: public
final: false
static: false

revokeGroup
jump to class

revokeGroup(
          string $name, string $groupName, string $ownerId
          )
        
        :
        boolean

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.

Arguments

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

Output

boolean

Details

visibility: public
final: false
static: false

revokeIp
jump to class

revokeIp(
          string $name, string $ipProtocol, integer $fromPort, integer $toPort, string $cidrIp
          )
        
        :
        boolean

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.

Arguments

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

Output

boolean

Details

visibility: public
final: false
static: false

API Documentation

Service/Amazon/Ec2/Securitygroups.php

Description

Zend_Service_Amazon_Ec2_Securitygroupsjump to top

Description

Methods

authorizeGroupjump to class

Arguments

Output

Details

authorizeIpjump to class

Arguments

Output

Details

createjump to class

Arguments

Output

Details

deletejump to class

Arguments

Output

Details

describejump to class

Arguments

Output

Details

revokeGroupjump to class

Arguments

Output

Details

revokeIpjump to class

Arguments

Output

Details

Zend_Service_Amazon_Ec2_Securitygroups
jump to top

authorizeGroup
jump to class

authorizeIp
jump to class

create
jump to class

delete
jump to class

describe
jump to class

revokeGroup
jump to class

revokeIp
jump to class