ToolJet/plugins/packages/s3/lib/manifest.json

{
  "$schema": "https://raw.githubusercontent.com/ToolJet/ToolJet/develop/plugins/schemas/manifest.schema.json",
  "title": "AWS S3 datasource",
  "description": "A schema defining AWS S3 datasource",
  "type": "cloud-storage",
  "source": {
    "name": "AWS S3",
    "kind": "s3",
    "exposedVariables": {
      "isLoading": false,
      "data": {},
      "rawData": {}
    },
    "options": {
      "access_key": {
        "type": "string"
      },
      "secret_key": {
        "type": "string",
        "encrypted": true
      },
      "region": {
        "type": "string"
      },
      "endpoint": {
        "type": "string"
      }
    }
  },
  "defaults": {
    "access_key": {
      "value": ""
    },
    "secret_key": {
      "value": ""
    },
    "region": {
      "value": ""
    },
    "endpoint": {
      "value": ""
    },
    "endpoint_enabled": {
      "value": false
    },
    "instance_metadata_credentials": {
      "value": "iam_access_keys"
    }
  },
  "properties": {
    "credentials": {
      "label": "Authentication",
      "key": "instance_metadata_credentials",
      "type": "dropdown-component-flip",
      "description": "Single select dropdown for choosing credentials",
      "list": [
        {
          "value": "iam_access_keys",
          "name": "Use IAM Access Keys"
        }, 
        {
          "value": "aws_instance_credentials",
          "name": "Use AWS Instance Credentials"
        },
        {
          "value": "aws_arn_role",
          "name": "Use AWS ARN Role"
        }
      ],
      "commonFields": {
        "region": {
          "label": "Region",
          "key": "region",
          "type": "dropdown",
          "description": "Single select dropdown for region",
          "list": [
            {
              "name": "US East (Ohio)",
              "value": "us-east-2"
            },
            {
              "name": "US East (N. Virginia)",
              "value": "us-east-1"
            },
            {
              "name": "US West (N. California)",
              "value": "us-west-1"
            },
            {
              "name": "US West (Oregon)",
              "value": "us-west-2"
            },
            {
              "name": "Africa (Cape Town)",
              "value": "af-south-1"
            },
            {
              "name": "Asia Pacific (Hong Kong)",
              "value": "ap-east-1"
            },
            {
              "name": "Asia Pacific (Mumbai)",
              "value": "ap-south-1"
            },
            {
              "name": "Asia Pacific (Osaka)",
              "value": "ap-northeast-3"
            },
            {
              "name": "Asia Pacific (Seoul)",
              "value": "ap-northeast-2"
            },
            {
              "name": "Asia Pacific (Singapore)",
              "value": "ap-southeast-1"
            },
            {
              "name": "Asia Pacific (Sydney)",
              "value": "ap-southeast-2"
            },
            {
              "name": "Asia Pacific (Tokyo)",
              "value": "ap-northeast-1"
            },
            {
              "name": "Canada (Central)",
              "value": "ca-central-1"
            },
            {
              "name": "China (Beijing)",
              "value": "cn-north-1"
            },
            {
              "name": "China (Ningxia)",
              "value": "cn-northwest-1"
            },
            {
              "name": "Europe (Frankfurt)",
              "value": "eu-central-1"
            },
            {
              "name": "Europe (Ireland)",
              "value": "eu-west-1"
            },
            {
              "name": "Europe (London)",
              "value": "eu-west-2"
            },
            {
              "name": "Europe (Milan)",
              "value": "eu-south-1"
            },
            {
              "name": "Europe (Paris)",
              "value": "eu-west-3"
            },
            {
              "name": "Europe (Stockholm)",
              "value": "eu-north-1"
            },
            {
              "name": "Middle East (Bahrain)",
              "value": "me-south-1"
            },
            {
              "name": "South America (São Paulo)",
              "value": "sa-east-1"
            },
            {
              "name": "AWS GovCloud (US-East)",
              "value": "us-gov-east-1"
            },
            {
              "name": "AWS GovCloud (US-West)",
              "value": "us-gov-west-1"
            }
          ]
        }
      }
     
    },
    "iam_access_keys": {
      "access_key": {
        "label": "Access key",
        "key": "access_key",
        "type": "text",
        "description": "Enter access key"
      },
      "secret_key": {
        "label": "Secret key",
        "key": "secret_key",
        "type": "password",
        "description": "Enter secret key"
      },
      "endpoint_enabled": {
        "label": "Custom Endpoint",
        "key": "endpoint_enabled",
        "type": "toggle",
        "description": "Toggle for endpoint_enabled"
      },
      "endpoint": {
        "key": "endpoint",
        "type": "text",
        "description": "Enter custom endpoint",
        "controller": "endpoint_enabled"
      } 
    },
    "aws_arn_role": {
      "role_arn": {
        "label": "Role ARN",
        "key": "role_arn",
        "type": "text",
        "description": "Enter role ARN, e.g. arn:aws:iam::123456789012:role/role-name"
      }
    }
  },
  "required": [
    "access_key",
    "secret_key",
    "region"
  ]
}