aws-sdk-js

You must generate an Access Key before getting started. All examples will utilize access_key_id and access_key_secret variables which represent the Access Key ID and Secret Access Key values you generated.

AWS JavaScript SDKの新しいバージョンに興味がある場合は、この専用のaws-sdk-js-v3の例ページを訪れてください。

JavaScriptまたはTypeScriptのユーザーは、通常通りaws-sdk ↗ npmパッケージを使用し続けることができます。S3サービスクライアントをインスタンス化する際には、R2の設定資格情報を渡す必要があります：

import S3 from "aws-sdk/clients/s3.js";

const s3 = new S3({
  endpoint: `https://${accountid}.r2.cloudflarestorage.com`,
  accessKeyId: `${access_key_id}`,
  secretAccessKey: `${access_key_secret}`,
  signatureVersion: "v4",
});

console.log(await s3.listBuckets().promise());
//=> {
//=>   Buckets: [
//=>     { Name: 'user-uploads', CreationDate: 2022-04-13T21:23:47.102Z },
//=>     { Name: 'my-bucket-name', CreationDate: 2022-05-07T02:46:49.218Z }
//=>   ],
//=>   Owner: {
//=>     DisplayName: '...',
//=>     ID: '...'
//=>   }
//=> }

console.log(await s3.listObjects({ Bucket: "my-bucket-name" }).promise());
//=> {
//=>   IsTruncated: false,
//=>   Name: 'my-bucket-name',
//=>   CommonPrefixes: [],
//=>   MaxKeys: 1000,
//=>   Contents: [
//=>     {
//=>       Key: 'cat.png',
//=>       LastModified: 2022-05-07T02:50:45.616Z,
//=>       ETag: '"c4da329b38467509049e615c11b0c48a"',
//=>       ChecksumAlgorithm: [],
//=>       Size: 751832,
//=>       Owner: [Object]
//=>     },
//=>     {
//=>       Key: 'todos.txt',
//=>       LastModified: 2022-05-07T21:37:17.150Z,
//=>       ETag: '"29d911f495d1ba7cb3a4d7d15e63236a"',
//=>       ChecksumAlgorithm: [],
//=>       Size: 279,
//=>       Owner: [Object]
//=>     }
//=>   ]
//=> }

プレサインドURLの生成

一時的にバケットへの公開読み取りまたは書き込みアクセスを共有するために使用できるプレサインドリンクを生成することもできます。

// expiresプロパティを使用して、プレサインドリンクが有効な期間を決定します。
console.log(
  await s3.getSignedUrlPromise("getObject", {
    Bucket: "my-bucket-name",
    Key: "dog.png",
    Expires: 3600,
  }),
);
// https://my-bucket-name.<accountid>.r2.cloudflarestorage.com/dog.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=<credential>&X-Amz-Date=<timestamp>&X-Amz-Expires=3600&X-Amz-Signature=<signature>&X-Amz-SignedHeaders=host

// putObjectなどの操作のためのリンクを作成して、特定のキーへの一時的な書き込みアクセスを許可することもできます。
console.log(
  await s3.getSignedUrlPromise("putObject", {
    Bucket: "my-bucket-name",
    Key: "dog.png",
    Expires: 3600,
  }),
);

putObjectの例で生成されたリンクを使用して、指定されたバケットとキーにアップロードできます。プレサインドリンクが期限切れになるまで使用できます。

curl -X PUT https://my-bucket-name.<accountid>.r2.cloudflarestorage.com/dog.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=<credential>&X-Amz-Date=<timestamp>&X-Amz-Expires=3600&X-Amz-Signature=<signature>&X-Amz-SignedHeaders=host --data-binary @dog.png