Data Types

S3Storage

Storage layer used for storing files in custom S3 buckets, as opposed to Bytescale's built-in storage.

This is a read/write storage layer.

{
"bucketName": String,
"bucketRegion": String,
},
"awsAccessKey": String,
},
"type": String,
}
{
"bucket": {
"bucketName": "my-bucket",
"bucketRegion": "us-east-1",
"objectKeyPrefix": "an/example/key"
},
"credentials": {
"awsAccessKey": "AKIAIOSFODNN7EXAMPLE",
"awsSecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
},
"type": "S3",
"useAbsolutePaths": true,
"useTransferAcceleration": true
}

AWS S3 Bucket Name.

Example: "my-bucket"

Type: String

Min Length: 1

Max Length: 61

AWS Region.

Example: "us-east-1"

Type: String

Allowed Values: "af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ca-central-1", "ca-west-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2"

Min Length: 1

Max Length: 20

AWS S3 Object Key.

Example: "an/example/key"

Type: String

Min Length: 0

Max Length: 1024

AWS Access Key.

Example: "AKIAIOSFODNN7EXAMPLE"

Type: String

Min Length: 16

Max Length: 128

AWS Secret Access Key.

Example: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"

Type: String

Min Length: 30

Max Length: 128

The type of this storage layer.

Type: String

Value: "S3"

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

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

Type: Boolean

Enables S3 transfer acceleration, providing improved file upload speeds for larger files.

Note: this setting must also be enabled on the S3 bucket.

Type: Boolean

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: