CONTENTS OF THIS FILE
- Introduction
- Installation
- Example
- Command Line Parameters
INTRODUCTION
Current Maintainer: Jordan de Laune, (*1)
AWS EC2 Snapshot Management is a php script which prunes EC2 snapshots as if they were backups. It's meant to be run from the command line, but can be called by other PHP scripts if you so desire. As well as cleaning up snapshots it can also be used to take new snapshots., (*2)
The cleanup function will keep snapshots made in the last seven days (Daily), one per week for the last month (Weekly) and one per month (Monthly)., (*3)
It will always keep at least one snapshot even if it was made a year ago., (*4)
This script took inspiration from 'EC2 Manage Snapshots' made by Erik Dasque and previously Oren Solomianik. It however requires the AWS PHP SDK., (*5)
This script is provided under the MIT License., (*6)
INSTALLATION
Use Composer by adding this requirement to your existing composer.json file or by creating one and adding this:, (*7)
{
"require": {
"jdelaune/aws-ec2-snapshot-management": "2.0.*"
}
}
The run composer update or composer install, alternatively you can just run composer update jdelaune/aws-ec2-snapshot-management., (*8)
EC2 Snapshot Management uses the AWS PHP SDK. You will needed to setup your credentials by following the instructions given here:, (*9)
http://docs.aws.amazon.com/aws-sdk-php/guide/latest/credentials.html#credential-profiles, (*10)
It expects a profile called ec2snapshot., (*11)
EXAMPLE
You will need to create a sample script like the one below, uncomment as needed:, (*12)
<?php
// myScript.php
require 'vendor/autoload.php';
use EC2SnapshotManagement\Manager;
/**
* Create a new EC2 Snapshot Manager
*
* You don't need to supply any arguments if calling from the command line.
*
* @param string $volume EC2 Volume Identifier
* @param string $region EC2 Region Identifier
* @param boolean $quiet Quiet mode, no output
* @param boolean $noOperation No operation mode, nothing will get deleted
* @param boolean $verbose Verbose, tells you exactly what it's doing
* @param string $description Description of new snapshot if creating one
*/
$manager = new Manager('vol-abcdefgh', 'eu-west-1', false, true, true, 'My Data Backup');
/**
* Cleans up existing old snapshots
*/
$manager->cleanupSnapshots();
/**
* Take a new snapshot
*/
$manager->takeSnapshot();
Or you can call the script you just created from the command line:, (*13)
php myScript.php -v=vol-abcdefgh -r=eu-west-1 -n -o -d="My Server Backup"
You will probably want to create two scripts to call each function independently!, (*14)
COMMAND LINE PARAMETERS
| Parameter |
Value |
| v |
EC2 volume identifier (Required). |
| r |
EC2 region (Optional). Defaults to us-east-1.
|
- us-east-1
- us-west-1
- us-west-2
- eu-west-1
- eu-central-1
- ap-southeast-1
- ap-southeast-2
- ap-northeast-1
- sa-east-1
d | Description, used when creating a snapshot (Optional).
o | Verbose mode. Tells you what it's doing (Optional).
q | Quiet mode. No output (Optional).
n | No operation mode. It won't actually delete or create any snapshots. Useful along with verbose mode to see what it will do the first time you run it (Optional)., (*15)
Wallogit.com
