r2_enable_sippy_aws

APIs.ioEngineeringPlatform

Properties

Name Type Description
destination object R2 bucket to copy objects to
source object AWS S3 bucket to copy objects from
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-r2-enable-sippy-aws-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/r2_enable_sippy_aws",
  "title": "r2_enable_sippy_aws",
  "properties": {
    "destination": {
      "description": "R2 bucket to copy objects to",
      "properties": {
        "accessKeyId": {
          "description": "ID of a Cloudflare API token.\nThis is the value labelled \"Access Key ID\" when creating an API\ntoken from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).\n\nSippy will use this token when writing objects to R2, so it is\nbest to scope this token to the bucket you're enabling Sippy for.\n",
          "type": "string"
        },
        "provider": {
          "enum": [
            "r2"
          ],
          "type": "string"
        },
        "secretAccessKey": {
          "description": "Value of a Cloudflare API token.\nThis is the value labelled \"Secret Access Key\" when creating an API\ntoken from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).\n\nSippy will use this token when writing objects to R2, so it is\nbest to scope this token to the bucket you're enabling Sippy for.\n",
          "type": "string"
        }
      },
      "type": "object"
    },
    "source": {
      "description": "AWS S3 bucket to copy objects from",
      "properties": {
        "accessKeyId": {
          "description": "Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)",
          "type": "string"
        },
        "bucket": {
          "description": "Name of the AWS S3 bucket",
          "type": "string"
        },
        "provider": {
          "enum": [
            "aws"
          ],
          "type": "string"
        },
        "region": {
          "description": "Name of the AWS availability zone",
          "type": "string"
        },
        "secretAccessKey": {
          "description": "Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}