hyper-adapter-namespaced-s3

A Storage port adapter that uses a single AWS S3 Bucket for object storage in the hyper service framework

---

Note: this adapter utilizes a single S3 bucket to store all objects, across all hyper storage services, where each hyper Storage service is a prefix in that single bucket. This makes it a great option if you're concerned about surpassing AWS' S3 Bucket Count Restrictions If you'd like an S3 bucket created for each hyper Storage service created, consider using the hyper-adapter-s3 adapter.

Table of Contents

• Getting Started
• Installation
• Features
• Methods
• Contributing
• License

Getting Started

hyper.config.js

import { default as s3 } from 'https://x.nest.land/[email protected]/mod.js'

export default {
  app: opine,
  adapter: [
    { port: 'storage', plugins: [s3('UNIQUE_NAME')] },
  ],
}

When you configure the hyper service with this adapter, you must provide a unique bucket prefix. This helps ensure your bucket name is globally unique

The unique name is an alphanumeric string that contains identifing information, this will enable you to identify the bucket which will be prefixed by 'hyper-storage-' and whatever name you provide.

In order to use this adapter you will need to have an AWS Account and will need the following information:

• IAM User with access to s3 (AWS_ACCESS_KEY_ID, AWS_ACCESS_SECRET_KEY)
• AWS Region (default: us-east-1)

The AWS User will need the ability to manage s3 and s3 resources

Credentials

This adapter will attempt to read AWS_ACCESS_KEY_ID and AWS_ACCESS_SECRET_KEY from Deno.env. Alternatively, you can provide the access key, secret key, and region as arguments to the adapter factory function:

import { default as s3 } from 'https://x.nest.land/[email protected]/mod.js'

export default {
  app: opine,
  adapter: [
    {
      port: 'storage',
      plugins: [
        s3('UNIQUE_NAME', {
          awsAccessKeyId: 'foo',
          awsSecretKey: 'bar',
          awsRegion: 'us-east-1', // defaults to 'us-east-1`
        }),
      ],
    },
  ],
}

Credentials from ENV VARS

You may set envrionment variables like so, and the adapter will use them:

AWS_ACCESS_KEY_ID=XXXXX
AWS_SECRET_ACCESS_KEY=XXXX
AWS_REGION=XXXXX

Installation

This is a Deno module available to import from nest.land

deps.js

export { default as s3 } from 'https://x.nest.land/[email protected]/mod.js'

Features

• Create an s3 bucket
• Remove an s3 bucket
• List s3 buckets
• Put an object into an s3 bucket
• Remove an object from an s3 bucket
• Get an object from an s3 bucket
• List objects in an s3 bucket

Methods

This adapter fully implements the Search port and can be used as the hyper Storage service adapter

See the full port here

Contributing

Contributions are welcome! See the hyper contribution guide

Testing

deno task test

To lint, check formatting, and run unit tests

License

Apache-2.0