GenericS3Storage

Structure

{
  "bucket": {
    "bucketEndpoint": String,
    "bucketName": String,
    "bucketRegion": String,
    "forcePathStyle": Boolean,
    "objectKeyPrefix": String,
    "unsupportedOperations": String[]
  },
  "credentials": {
    "accessKey": String,
    "secretKey": String
  },
  "type": String,
  "useAbsolutePaths": Boolean
}

Example

{
  "bucket": {
    "bucketEndpoint": "https://example.com/foo",
    "bucketName": "my-bucket",
    "bucketRegion": "auto",
    "forcePathStyle": true,
    "objectKeyPrefix": "an/example/key",
    "unsupportedOperations": [
      "DeleteObjects"
    ]
  },
  "credentials": {
    "accessKey": "AKIAIOSFODNN7EXAMPLE",
    "secretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  },
  "type": "GenericS3",
  "useAbsolutePaths": true
}

Properties

bucket.bucketEndpoint Required

URL for an http(s) resource.

Example: "https://example.com/foo"

Type: String

Min Length: 1

Max Length: 255

bucket.bucketName Required

AWS S3 Bucket Name.

Example: "my-bucket"

Type: String

Min Length: 1

Max Length: 61

bucket.bucketRegion Required

Generic S3 Region.

Example: "auto"

Type: String

Min Length: 1

Max Length: 50

bucket.forcePathStyle Required

Controls how URLs are constructed when making HTTP requests to the S3-compatible API hosted at bucketEndpoint.

•If true then bucketName will be added to the URL path.

•If false then bucketName will be added as a subdomain of bucketEndpoint, assuming bucketName does not contain '.' and is DNS-compatible, else it will be added to the URL path.

Type: Boolean

bucket.objectKeyPrefix Required

AWS S3 Object Key.

Example: "an/example/key"

Type: String

Min Length: 0

Max Length: 1024

bucket.unsupportedOperations Required

Type: String[]

Value: "DeleteObjects"

credentials.accessKey Required

AWS Access Key.

Example: "AKIAIOSFODNN7EXAMPLE"

Type: String

Min Length: 16

Max Length: 128

credentials.secretKey Required

AWS Secret Access Key.

Example: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"

Type: String

Min Length: 30

Max Length: 128

type Required

Type: String

Value: "GenericS3"

useAbsolutePaths Required

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

GenericS3Storage

Structure

Example

Properties

bucket.bucketEndpoint Required

bucket.bucketName Required

bucket.bucketRegion Required

bucket.forcePathStyle Required

bucket.objectKeyPrefix Required

bucket.unsupportedOperations Required

credentials.accessKey Required

credentials.secretKey Required

type Required

useAbsolutePaths Required

Used by

You are using an outdated browser.