org.jimmutable.aws.s3

Class BucketPuppet

java.lang.Object

org.jimmutable.aws.s3.BucketPuppet

public class BucketPuppet
extends Object

The bucket puppet class is meant to be an analog to the puppet tool but for S3 buckets. The user of this class creates a simple (and easy to understand) desired bucket configuration (BucketConfiguration) Calling the execute method causes BucketPuppet to examine the current configuration of the bucket in S3 and take whatever steps are required to modify the bucket configuration to match the desired configuration specified. Because of the way that bucket puppet focuses on making S3's configuration match a desired target configuration, it is very safe to call. If you call the execute functions multiple times with the same configuration, bucket puppet won't do anything (just examine the config and say "hey all good" and change nothing)

Author:

jim.kane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BucketPuppet.BucketConfiguration This class is used to specify the desired configuration of a bucket

Constructor Summary

Constructors

Constructor and Description
BucketPuppet()

Method Summary

Modifier and Type	Method and Description
static void	execute(com.amazonaws.services.s3.AmazonS3 client, BucketPuppet.BucketConfiguration desired_configuration) Take whatever steps are required to make S3 have a bucket in the desired configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BucketPuppet

public BucketPuppet()

Method Detail

execute

public static void execute(com.amazonaws.services.s3.AmazonS3 client,
                           BucketPuppet.BucketConfiguration desired_configuration)
                    throws Exception

Take whatever steps are required to make S3 have a bucket in the desired configuration. This may include: Doing nothing (if the bucket already exists and is properly configured) Creating a bucket Setting the bucket's versioning configuration Setting the bucket's lifecyle rules Setting the bucket's policy (to make it web accessible or not)

Parameters:

client - The AmazonS3 client to use

desired_configuration - The desired bucket configuration

Throws:

Exception - If something goes wrong