pyrax
Python Bindings for the Rackspace Cloud
 All Classes Namespaces Files Functions Variables Properties
Public Member Functions | Public Attributes
ScalingGroup Class Reference
Inheritance diagram for ScalingGroup:
BaseResource

List of all members.

Public Member Functions

def __init__
def get_state
 Returns the current state of this scaling group.
def pause
 Pauses all execution of the policies for this scaling group.
def resume
 Resumes execution of the policies for this scaling group.
def update
 Updates this ScalingGroup.
def update_metadata
 Adds the given metadata dict to the existing metadata for this scaling group.
def get_configuration
 Returns the scaling group configuration in a dictionary.
def get_launch_config
 Returns the launch configuration for this scaling group.
def update_launch_config
 Updates the server launch configuration for this scaling group.
def update_launch_metadata
 Adds the given metadata dict to the existing metadata for this scaling group's launch configuration.
def add_policy
 Adds a policy with the given values to this scaling group.
def list_policies
 Returns a list of all policies defined for this scaling group.
def get_policy
 Gets the detail for the specified policy.
def update_policy
 Updates the specified policy.
def execute_policy
 Executes the specified policy for this scaling group.
def delete_policy
 Deletes the specified policy from this scaling group.
def add_webhook
 Adds a webhook to the specified policy.
def list_webhooks
 Returns a list of all webhooks for the specified policy.
def update_webhook
 Updates the specified webhook.
def update_webhook_metadata
 Adds the given metadata dict to the existing metadata for the specified webhook.
def delete_webhook
 Deletes the specified webhook from the specified policy.
def policy_count
def name
 The following property declarations allow access to the base attributes of the ScalingGroup held in the 'groupConfiguration' dict as if they were native attributes.
def name
def cooldown
def cooldown
def metadata
def metadata
def min_entities
def min_entities
def max_entities
def max_entities

Public Attributes

 policies

Constructor & Destructor Documentation

def __init__ (   self,
  args,
  kwargs 
)

Member Function Documentation

def add_policy (   self,
  name,
  policy_type,
  cooldown,
  change,
  is_percent = False 
)

Adds a policy with the given values to this scaling group.

The 'change' parameter is treated as an absolute amount, unless 'is_percent' is True, in which case it is treated as a percentage.

def add_webhook (   self,
  policy,
  name,
  metadata = None 
)

Adds a webhook to the specified policy.

def cooldown (   self)
def cooldown (   self,
  val 
)
def delete_policy (   self,
  policy 
)

Deletes the specified policy from this scaling group.

def delete_webhook (   self,
  policy,
  webhook 
)

Deletes the specified webhook from the specified policy.

def execute_policy (   self,
  policy 
)

Executes the specified policy for this scaling group.

def get_configuration (   self)

Returns the scaling group configuration in a dictionary.

def get_launch_config (   self)

Returns the launch configuration for this scaling group.

def get_policy (   self,
  policy 
)

Gets the detail for the specified policy.

def get_state (   self)

Returns the current state of this scaling group.

def list_policies (   self)

Returns a list of all policies defined for this scaling group.

def list_webhooks (   self,
  policy 
)

Returns a list of all webhooks for the specified policy.

def max_entities (   self)
def max_entities (   self,
  val 
)
def metadata (   self)
def metadata (   self,
  val 
)
def min_entities (   self)
def min_entities (   self,
  val 
)
def name (   self)

The following property declarations allow access to the base attributes of the ScalingGroup held in the 'groupConfiguration' dict as if they were native attributes.

def name (   self,
  val 
)
def pause (   self)

Pauses all execution of the policies for this scaling group.

def policy_count (   self)
def resume (   self)

Resumes execution of the policies for this scaling group.

def update (   self,
  name = None,
  cooldown = None,
  min_entities = None,
  max_entities = None,
  metadata = None 
)

Updates this ScalingGroup.

One or more of the attributes can be specified.

NOTE: if you specify metadata, it will *replace* any existing metadata. If you want to add to it, you either need to pass the complete dict of metadata, or call the update_metadata() method.

def update_launch_config (   self,
  server_name = None,
  image = None,
  flavor = None,
  disk_config = None,
  metadata = None,
  personality = None,
  networks = None,
  load_balancers = None 
)

Updates the server launch configuration for this scaling group.

One or more of the available attributes can be specified.

NOTE: if you specify metadata, it will *replace* any existing metadata. If you want to add to it, you either need to pass the complete dict of metadata, or call the update_launch_metadata() method.

def update_launch_metadata (   self,
  metadata 
)

Adds the given metadata dict to the existing metadata for this scaling group's launch configuration.

def update_metadata (   self,
  metadata 
)

Adds the given metadata dict to the existing metadata for this scaling group.

def update_policy (   self,
  policy,
  name = None,
  policy_type = None,
  cooldown = None,
  change = None,
  is_percent = False 
)

Updates the specified policy.

One or more of the parameters may be specified.

def update_webhook (   self,
  policy,
  webhook,
  name = None,
  metadata = None 
)

Updates the specified webhook.

One or more of the parameters may be specified.

def update_webhook_metadata (   self,
  policy,
  webhook,
  metadata 
)

Adds the given metadata dict to the existing metadata for the specified webhook.


Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Properties