DocumentationAPI reference

Rust · 0.1.0

Storage_S3Config

Application protocol schema. Field names and inherited descriptions are kept in their original language.

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

Referenced by these component schemas:

Shape and fields

object

S3 configuration for an S3-compatible object store. Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/

FieldType / requirementDescription
accessKeyIdstring
accessKeySecretstring
endpointstring
regionstring
bucketstring
usePathStyleboolean
insecureSkipTlsVerifybooleaninsecure_skip_tls_verify disables TLS certificate verification when connecting to the S3 endpoint. Only enable this for trusted endpoints that use a self-signed certificate; it removes protection against man-in-the-middle attacks.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "accessKeyId": {
      "type": "string"
    },
    "accessKeySecret": {
      "writeOnly": true,
      "type": "string"
    },
    "endpoint": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "bucket": {
      "type": "string"
    },
    "usePathStyle": {
      "type": "boolean"
    },
    "insecureSkipTlsVerify": {
      "type": "boolean",
      "description": "insecure_skip_tls_verify disables TLS certificate verification when connecting\n to the S3 endpoint. Only enable this for trusted endpoints that use a self-signed\n certificate; it removes protection against man-in-the-middle attacks."
    }
  },
  "description": "S3 configuration for an S3-compatible object store.\n Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/"
}