{
  "$schema" : "https://json-schema.org/draft/2020-12/schema",
  "$id" : "https://voltdb.com/voltsp/schemas/resource/s3",
  "title" : "S3 Resource Configuration",
  "description" : "The `s3` resource configures and exposes the Amazon S3 client instance.\n\nAdvanced users that need direct access to Amazon S3 do not need to configure and\ninstantiate it manually. VoltSP uses built-in mechanisms to provide a production quality setup.\n\nUser can relay on VoltSP standard configuration options to customize this resource.\n\nThis resource provides access to Amazon S3 operations through the AWS SDK for Java.\n",
  "type" : "object",
  "properties" : {
    "s3" : {
      "type" : "object",
      "properties" : {
        "region" : {
          "type" : "string",
          "description" : "The AWS region where the S3 bucket is located (e.g., us-east-1).",
          "default" : "us-east-1"
        },
        "endpoint" : {
          "type" : "string",
          "description" : "The S3 endpoint URL. This is optional and can be used to specify a custom endpoint for S3 compatible services."
        },
        "credentials" : {
          "type" : "object",
          "description" : "Optional credential configuration for s3 client.\n\nVoltSP supports following ways of retrieving authentication credentials:\n- Using access key and secret key. This is the most basic way of authentication.\nIt is also the least secure way due to the need to store secret key in the VoltSP configuration.\n- Using a profile from the AWS credentials file.\n- Using EC2 instance profile credentials.\n- Using container credentials (for ECS).\n- Using web identity token credentials (for AWS STS).\n\nIf no credentials are configured then VoltSP will use the default credential provider chain\nas defined by AWS Java SDK. This will look for credentials in the following order:\n 1. Environment variables (AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY)\n 2. Java system properties (aws.accessKeyId and aws.secretKey)\n 3. Web Identity Token credentials from the environment or container\n 4. Credentials file at the default location (~/.aws/credentials)\n 5. ECS container credentials\n 6. EC2 Instance profile credentials\n",
          "properties" : {
            "accessKey" : {
              "type" : "string",
              "description" : "The AWS access key ID for authentication when using basic credentials."
            },
            "secretKey" : {
              "type" : "string",
              "description" : "The AWS secret access key for authentication when using basic credentials."
            },
            "profileName" : {
              "type" : "string",
              "description" : "The AWS profile name to use when using profile based authentication. This loads credentials from a profile file."
            },
            "fromContainer" : {
              "type" : "boolean",
              "description" : "Credentials will be read from the container metadata service"
            },
            "fromInstanceProfile" : {
              "type" : "boolean",
              "description" : "Credentials will be read from the instance metadata service"
            },
            "roleArn" : {
              "type" : "string",
              "description" : "The role ARN to assume when using web identity token based authentication."
            },
            "roleSessionName" : {
              "type" : "string",
              "description" : "The role session name to use when using web identity token based authentication."
            }
          },
          "additionalProperties" : false
        }
      },
      "additionalProperties" : false
    }
  },
  "required" : [ "s3" ],
  "additionalProperties" : false
}