PHP Class Scalr_Governance

ファイルを表示 Open project: scalr/scalr Class Usage Examples

Public Methods

Method Description
__construct ( $envId )
clearCache ( ) Clears governance cache
convertAsteriskPatternToRegexp ( string $pattern ) : string Converts astrisk(*) pattern to regular expression
getEc2SecurityGroupPolicyNameForService ( string $serviceName ) : string Returns Security group policy name for service
getValue ( string $category, string $name, string $option = 'value' ) : array Returns enabled policy settings.
getValues ( boolean $enabledOnly = false ) : array Returns all governace policies settings.
isEnabled ( string $category, string $name ) : boolean Returns policy status.
isInstanceTypeAllowed ( string $platform, string $cloudLocation, string $instanceType ) : boolean Checks if instance type is allowed
isSecurityGroupNameAllowed ( string $sgName, Array $patterns ) : boolean Checks if security group is allowed
prepareSecurityGroupsPatterns ( string $list ) : Array Prepare governance security groups patterns
setValue ( string $category, string $name, integer $enabled, array $value ) Sets policy settings.

Private Methods

Method Description
loadValue ( string $category, string $name ) : array Returns policy settings with caching.

Method Details

__construct() public method

public __construct ( $envId )

clearCache() public static method

Clears governance cache
public static clearCache ( )

convertAsteriskPatternToRegexp() public static method

Converts astrisk(*) pattern to regular expression
public static convertAsteriskPatternToRegexp ( string $pattern ) : string
$pattern string Pattern with asterisk
return string Regular expression

getEc2SecurityGroupPolicyNameForService() public static method

Returns Security group policy name for service
public static getEc2SecurityGroupPolicyNameForService ( string $serviceName ) : string
$serviceName string Service name (rds, elb ...)
return string Policy name

getValue() public method

Returns enabled policy settings.
public getValue ( string $category, string $name, string $option = 'value' ) : array
$category string Governance category name
$name string Governance policy name
$option string Default option is 'value'
return array Policy settings

getValues() public method

Returns all governace policies settings.
public getValues ( boolean $enabledOnly = false ) : array
$enabledOnly boolean If true - returns only enabled governance policies
return array Returns array of policies

isEnabled() public method

Returns policy status.
public isEnabled ( string $category, string $name ) : boolean
$category string Governance category name
$name string Governance policy name
return boolean Returns true if policy is enabled

isInstanceTypeAllowed() public method

Checks if instance type is allowed
public isInstanceTypeAllowed ( string $platform, string $cloudLocation, string $instanceType ) : boolean
$platform string Platform
$cloudLocation string Cloud location
$instanceType string Instance type
return boolean Returns true if instance type is allowed

isSecurityGroupNameAllowed() public static method

Checks if security group is allowed
public static isSecurityGroupNameAllowed ( string $sgName, Array $patterns ) : boolean
$sgName string Security group name
$patterns Array List of patterns
return boolean Returns true if security matches at list one pattern

prepareSecurityGroupsPatterns() public static method

Prepare governance security groups patterns
public static prepareSecurityGroupsPatterns ( string $list ) : Array
$list string List of security groups, separated by comma
return Array Security groups patterns

setValue() public method

Sets policy settings.
public setValue ( string $category, string $name, integer $enabled, array $value )
$category string Governance category name
$name string Governance policy name
$enabled integer Possible values: 1 - Enable policy, 0 - disable policy
$value array Governance policy settings to set