Search code examples
node.jsamazon-web-servicesamazon-s3aws-sdk-js

S3 getSignedUrl v2 equivalent in AWS Javascript SDK v3


I just started using aws-sdk on my app to upload files to S3, and i'm debating whether to use aws-sdk v2 or v3.

V2 is the whole package, which is super bloated considering i only need the s3 services, not the myriad of other options. However, the documentation is very cryptic and im having a really hard time getting the equivalent getSignedUrl function to work in v3.

In v2, i have this code to sign the url and it works fine. I am using express on the server

import aws from 'aws-sdk';

const signS3URL = (req,res,next) => {
    const s3 = new aws.S3({region:'us-east-2'});
    const {fileName,fileType} = req.query;
    const s3Params = {
        Bucket : process.env.S3_BUCKET,
        Key : fileName,
        ContentType:fileType,
        Expires: 60,
    };

    s3.getSignedUrl('putObject',s3Params,(err,data)=>{
        if(err){
            next(err);
        }
        res.json(data);
    });
}

Now I've been reading documentation and examples trying to get the v3 equivalent to work, but i cant find any working example of how to use it. Here is how I have set it up so far

import {S3Client,PutObjectCommand} from '@aws-sdk/client-s3';
import {getSignedUrl} from '@aws-sdk/s3-request-presigner';

export const signS3URL = async(req,res,next) => {
    console.log('Sign')
    const {fileName,fileType} = req.query;
    const s3Params = {
        Bucket : process.env.S3_BUCKET,
        Key : fileName,
        ContentType:fileType,
        Expires: 60,
        // ACL: 'public-read'
    };

    const s3 = new S3Client()
    s3.config.region = 'us-east-2'
    const command = new PutObjectCommand(s3Params)
    console.log(command)


    await getSignedUrl(s3,command).then(signature =>{
        console.log(signature)
        res.json(signature)
    }).catch(e=>next(e))
}

There are some errors in this code, and the first I can identify is creating the command variable using the PutObjectCommand function provided by the SDK. The documentation does not clarify to me what i need to pass it as the "input" https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/putobjectcommandinput.html

Does anyone with experience using aws-sdk v3 know how to do this?

Also a side-question, where can i find the api reference for v2???? cuz all i find is the sdk docs that say "v3 now available" and i cant seem to find the reference to v2....

thanks for your time


Solution

  • The following code would give you a signedUrl in a JSON body with the key as signedUrl.

    const signS3URL = async (req, res, next) => {
        const { fileName, fileType } = req.query;
        const s3Params = {
            Bucket: process.env.S3_BUCKET,
            Key: fileName,
            ContentType: fileType,
            // ACL: 'bucket-owner-full-control'
        };
        const s3 = new S3Client({ region: 'us-east-2' })
        const command = new PutObjectCommand(s3Params);
    
        try {
            const signedUrl = await getSignedUrl(s3, command, { expiresIn: 60 });
            console.log(signedUrl);
            res.json({ signedUrl })
        } catch (err) {
            console.error(err);
            next(err);
        }
    }
    

    Keep the ACL as bucket-owner-full-control if you want the AWS account owning the Bucket to access the files.

    You can go to the API Reference for both the JS SDK versions from here