R2Storage

Storage layer used for storing files in Cloudflare R2, as opposed to Bytescale's built-in storage.

This is a read/write storage layer.

Structure

{
  "bucket": {
    "bucketName": String,
    "objectKeyPrefix": String
  },
  "cloudflareAccountId": String,
  "credentials": {
    "r2AccessKey": String,
    "r2SecretKey": String
  },
  "type": String,
  "useAbsolutePaths": Boolean
}

Example

{
  "bucket": {
    "bucketName": "my-bucket",
    "objectKeyPrefix": "an/example/key"
  },
  "cloudflareAccountId": "4137fa2e8211774677c5b708463dcb1a",
  "credentials": {
    "r2AccessKey": "AKIAIOSFODNN7EXAMPLE",
    "r2SecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  },
  "type": "R2",
  "useAbsolutePaths": true
}

Properties

bucket.bucketName Required

AWS S3 Bucket Name.

Example: "my-bucket"

Type: String

Min Length: 1

Max Length: 61

bucket.objectKeyPrefix Required

AWS S3 Object Key.

Example: "an/example/key"

Type: String

Min Length: 0

Max Length: 1024

cloudflareAccountId Required

Cloudflare Account ID.

Example: "4137fa2e8211774677c5b708463dcb1a"

Type: String

Min Length: 1

Max Length: 64

credentials.r2AccessKey Required

AWS Access Key.

Example: "AKIAIOSFODNN7EXAMPLE"

Type: String

Min Length: 16

Max Length: 128

credentials.r2SecretKey Required

AWS Secret Access Key.

Example: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"

Type: String

Min Length: 30

Max Length: 128

type Required

The type of this storage layer.

Type: String

Value: "R2"

useAbsolutePaths Required

If true then writes Google Storage objects with full filePath as key, prefixed with the objectKeyPrefix.

If false then writes Google Storage objects using a relative filePath in relation to folder's path, prefixed with the objectKeyPrefix.

Type: Boolean

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

R2Storage

Structure

Example

Properties

bucket.bucketName Required

bucket.objectKeyPrefix Required

cloudflareAccountId Required

credentials.r2AccessKey Required

credentials.r2SecretKey Required

type Required

useAbsolutePaths Required

Used by

You are using an outdated browser.