SYNOPSIS

s3mkbucket [options] [bucket ...]

 Options:
   --access-key    AWS Access Key ID
   --secret-key    AWS Secret Access Key
   --acl-short     private|public-read|public-read-write|authenticated-read
 Environment:
   AWS_ACCESS_KEY_ID
   AWS_ACCESS_KEY_SECRET

OPTIONS

--help

Print a brief help message and exits.

--man

Prints the manual page and exits.

--verbose

Print a message for each created bucket.

--access-key and --secret-key

Specify the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R" for the \s-1AWS\s0 account. --access-key is the \*(L"Access Key \s-1ID\s0\*(R", and --secret-key is the \*(L"Secret Access Key\*(R". These are effectively the \*(L"username\*(R" and \*(L"password\*(R" to the \s-1AWS\s0 account, and should be kept confidential. The access keys \s-1MUST\s0 be specified, either via these command line parameters, or via the \s-1AWS_ACCESS_KEY_ID\s0 and \s-1AWS_ACCESS_KEY_SECRET\s0 environment variables. Specifying them on the command line overrides the environment variables.

--secure

Uses \s-1SSL/TLS\s0 \s-1HTTPS\s0 to communicate with the \s-1AWS\s0 service, instead of \s-1HTTP\s0.

--acl-short

Apply a \*(L"canned \s-1ACL\s0\*(R" to the bucket when it is created. To set a more complex \s-1ACL\s0, use the \*(C`s3acl\*(C' tool after the bucket is created. The following canned ACLs are currently defined by S3:

private

Owner gets \*(C`FULL_CONTROL\*(C'. No one else has any access rights. This is the default.

public-read

Owner gets \*(C`FULL_CONTROL\*(C'. The anonymous principal is granted \*(C`READ\*(C' access.

public-read-write

Owner gets \*(C`FULL_CONTROL\*(C'. The anonymous principal is granted \*(C`READ\*(C' and \*(C`WRITE\*(C' access. This is a useful policy to apply to a bucket, if you intend for any anonymous user to \s-1PUT\s0 objects into the bucket.

authenticated-read

Owner gets \*(C`FULL_CONTROL\*(C' . Any principal authenticated as a registered Amazon S3 user is granted \*(C`READ\*(C' access.

bucket

One or more bucket names. As many as possible will be created. A user may have no more than 100 buckets. Bucket names must be between 3 and 255 characters long, and can only contain alphanumeric characters, underscore, period, and dash. Bucket names are case sensitive. Buckets with names containing uppercase characters or underscores are not accessible using the virtual hosting method. Buckets are unique in a global namespace. That means if someone has created a bucket with a given name, someone else cannot create another bucket with the same name. If a bucket name begins with one or more dashes, it might be mistaken for a command line option. If this is the case, separate the command line options from the bucket names with two dashes, like so: s3mkbucket --verbose -- --bucketname

ENVIRONMENT VARIABLES

\s-1AWS_ACCESS_KEY_ID\s0 and \s-1AWS_ACCESS_KEY_SECRET\s0

Specify the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R" for the \s-1AWS\s0 account. \s-1AWS_ACCESS_KEY_ID\s0 contains the \*(L"Access Key \s-1ID\s0\*(R", and \s-1AWS_ACCESS_KEY_SECRET\s0 contains the \*(L"Secret Access Key\*(R". These are effectively the \*(L"username\*(R" and \*(L"password\*(R" to the \s-1AWS\s0 service, and should be kept confidential. The access keys \s-1MUST\s0 be specified, either via these environment variables, or via the --access-key and --secret-key command line parameters. If the command line parameters are set, they override these environment variables.

CONFIGURATION FILE

The configuration options will be read from the file \*(C`~/.s3-tools\*(C' if it exists. The format is the same as the command line options with one option per line. For example, the file could contain:

--access-key <AWS access key> --secret-key <AWS secret key> --secure

This example configuration file would specify the \s-1AWS\s0 access keys and that a secure connection using \s-1HTTPS\s0 should be used for all communications.

DESCRIPTION

Create buckets in the Amazon Simple Storage Service (S3).

BUGS

Report bugs to Mark Atwood [email protected].

Making a bucket that already exists and is owned by the user does not fail. It is unclear whether this is a bug or not.

Occasionally the S3 service will randomly fail for no externally apparent reason. When that happens, this tool should retry, with a delay and a backoff.

Access to the S3 service can be authenticated with a X.509 certificate, instead of via the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R". This tool should support that.

It might be useful to be able to specify the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R" in the user's \*(C`~/.netrc\*(C' file. This tool should support that.

Errors and warnings are very \*(L"Perl-ish\*(R", and can be confusing.

AUTHOR

Written by Mark Atwood [email protected].

Many thanks to Wotan \s-1LLC\s0 <http://wotanllc.com>, for supporting the development of these S3 tools.

Many thanks to the Amazon \s-1AWS\s0 engineers for developing S3.

RELATED TO s3mkbucket…

These tools use the Net::Amazon:S3 Perl module.

The Amazon Simple Storage Service (S3) is documented at <http://aws.amazon.com/s3>.