@am92/aws-s3

Table of Content

• Installation
• Environment Variables
• Creating an OtpSdk Instance
• Contributors
• Resources
• License

Installation

$ npm install --save @am92/aws-s3

Environment Variables

The following environment variables need to be set to work with this package:

##### AWS S3 SDK Config
export S3_ENABLED='false'
export S3_REGION='ap-south-1'
export S3_BUCKET=''
export S3_PRESIGNED_EXPIRY_IN_SECS='300'
export S3_CLOUDFRONT_URL=''

Note:

• If 'S3_ENABLED' is set to 'true', 'S3_BUCKET' is required
• Variables where values have been defined can be omitted from being defined as the mentioned values are internally defaulted.

Creating an OtpSdk Instance

import { S3Sdk } from '@am92/aws-s3'

const s3Sdk = new S3Sdk()
export default s3Sdk

In this case, configuration values are read from environment variables.

If you wish to pass your custom 'config' to OtpSdk Class, then you can build it as follows:

import { S3Sdk } from '@am92/aws-s3'

const config = {
  BUCKET: '',
  PRESIGNED_EXPIRY_IN_SECS: 300,
  CONNECTION_CONFIG: {
    region: ''
  }
}

const s3Sdk = new S3Sdk(config)
export default s3Sdk

In this case, configuration values are defaulted from environment variables. Thus partial config can be passed to the S3Sdk Class.

Contributors

Ankit Gandhi

Mehul Agarwal

Resources

• AWS S3 Client
• AWS S3 Request Presigner

License

• MIT