Package CedarBackup3 :: Package extend :: Module amazons3 :: Class AmazonS3Config
[hide private]
[frames] | no frames]

Class AmazonS3Config

source code

object --+
         |
        AmazonS3Config

Class representing Amazon S3 configuration.

Amazon S3 configuration is used for storing backup data in Amazon's S3 cloud storage using the s3cmd tool.

The following restrictions exist on data in this class:

Instance Methods [hide private]
 
__init__(self, warnMidnite=None, s3Bucket=None, encryptCommand=None, fullBackupSizeLimit=None, incrementalBackupSizeLimit=None)
Constructor for the AmazonS3Config class.
source code
 
__repr__(self)
Official string representation for class instance.
source code
 
__str__(self)
Informal string representation for class instance.
source code
 
__cmp__(self, other)
Original Python 2 comparison operator.
source code
 
__eq__(self, other)
Equals operator, iplemented in terms of original Python 2 compare operator.
source code
 
__lt__(self, other)
Less-than operator, iplemented in terms of original Python 2 compare operator.
source code
 
__gt__(self, other)
Greater-than operator, iplemented in terms of original Python 2 compare operator.
source code
 
_setWarnMidnite(self, value)
Property target used to set the midnite warning flag.
source code
 
_getWarnMidnite(self)
Property target used to get the midnite warning flag.
source code
 
_setS3Bucket(self, value)
Property target used to set the S3 bucket.
source code
 
_getS3Bucket(self)
Property target used to get the S3 bucket.
source code
 
_setEncryptCommand(self, value)
Property target used to set the encrypt command.
source code
 
_getEncryptCommand(self)
Property target used to get the encrypt command.
source code
 
_setFullBackupSizeLimit(self, value)
Property target used to set the full backup size limit.
source code
 
_getFullBackupSizeLimit(self)
Property target used to get the full backup size limit.
source code
 
_setIncrementalBackupSizeLimit(self, value)
Property target used to set the incremental backup size limit.
source code
 
_getIncrementalBackupSizeLimit(self)
Property target used to get the incremental backup size limit.
source code
 
__ge__(x, y)
x>=y
 
__le__(x, y)
x<=y

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties [hide private]
  warnMidnite
Whether to generate warnings for crossing midnite.
  s3Bucket
Amazon S3 Bucket in which to store data
  encryptCommand
Command used to encrypt data before upload to S3
  fullBackupSizeLimit
Maximum size of a full backup, as a ByteQuantity
  incrementalBackupSizeLimit
Maximum size of an incremental backup, as a ByteQuantity

Inherited from object: __class__

Method Details [hide private]

__init__(self, warnMidnite=None, s3Bucket=None, encryptCommand=None, fullBackupSizeLimit=None, incrementalBackupSizeLimit=None)
(Constructor)

source code 

Constructor for the AmazonS3Config class.

Parameters:
  • warnMidnite - Whether to generate warnings for crossing midnite.
  • s3Bucket - Name of the Amazon S3 bucket in which to store the data
  • encryptCommand - Command used to encrypt backup data before upload to S3
  • fullBackupSizeLimit - Maximum size of a full backup, a ByteQuantity
  • incrementalBackupSizeLimit - Maximum size of an incremental backup, a ByteQuantity
Raises:
  • ValueError - If one of the values is invalid.
Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

Official string representation for class instance.

Overrides: object.__repr__

__str__(self)
(Informal representation operator)

source code 

Informal string representation for class instance.

Overrides: object.__str__

__cmp__(self, other)
(Comparison operator)

source code 

Original Python 2 comparison operator.

Parameters:
  • other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

_setWarnMidnite(self, value)

source code 

Property target used to set the midnite warning flag. No validations, but we normalize the value to True or False.

_setFullBackupSizeLimit(self, value)

source code 

Property target used to set the full backup size limit. The value must be an integer >= 0.

Raises:
  • ValueError - If the value is not valid.

_setIncrementalBackupSizeLimit(self, value)

source code 

Property target used to set the incremental backup size limit. The value must be an integer >= 0.

Raises:
  • ValueError - If the value is not valid.

Property Details [hide private]

warnMidnite

Whether to generate warnings for crossing midnite.

Get Method:
_getWarnMidnite(self) - Property target used to get the midnite warning flag.
Set Method:
_setWarnMidnite(self, value) - Property target used to set the midnite warning flag.

s3Bucket

Amazon S3 Bucket in which to store data

Get Method:
_getS3Bucket(self) - Property target used to get the S3 bucket.
Set Method:
_setS3Bucket(self, value) - Property target used to set the S3 bucket.

encryptCommand

Command used to encrypt data before upload to S3

Get Method:
_getEncryptCommand(self) - Property target used to get the encrypt command.
Set Method:
_setEncryptCommand(self, value) - Property target used to set the encrypt command.

fullBackupSizeLimit

Maximum size of a full backup, as a ByteQuantity

Get Method:
_getFullBackupSizeLimit(self) - Property target used to get the full backup size limit.
Set Method:
_setFullBackupSizeLimit(self, value) - Property target used to set the full backup size limit.

incrementalBackupSizeLimit

Maximum size of an incremental backup, as a ByteQuantity

Get Method:
_getIncrementalBackupSizeLimit(self) - Property target used to get the incremental backup size limit.
Set Method:
_setIncrementalBackupSizeLimit(self, value) - Property target used to set the incremental backup size limit.