ClickHouseIntegrationS3Fsxn

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/instaclustr/main/json-schema/instaclustr-click-house-integration-s3-fsxn-schema.json",
  "title": "ClickHouseIntegrationS3Fsxn",
  "description": "ClickHouse integration with FSx ONTAP file system.",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/instaclustr-openapi.yml#/components/schemas/ClickHouseIntegrationS3Fsxn",
  "required": [
    "clusterId",
    "fsxnFilesystem"
  ],
  "type": "object",
  "properties": {
    "fsxnFilesystem": {
      "required": [
        "fsxnId"
      ],
      "type": "object",
      "properties": {
        "accessKeyId": {
          "type": "string",
          "description": "S3 access key ID.",
          "format": "password",
          "x-terraform-sensitive": true,
          "x-terraform-write-only": true
        },
        "secretAccessKey": {
          "type": "string",
          "description": "S3 secret access key.",
          "format": "password",
          "x-terraform-sensitive": true,
          "x-terraform-write-only": true
        },
        "endpointAddress": {
          "type": "string",
          "description": "S3 endpoint address.",
          "x-terraform-computed": true
        },
        "fsxnId": {
          "type": "string",
          "description": "AWS ID of the FSx ONTAP file system.",
          "x-terraform-force-new": true
        },
        "httpsEnabled": {
          "type": "boolean",
          "description": "Whether HTTPS is enabled for communication with the FSxN S3 endpoint. Defaults to true when not specified."
        },
        "vpcId": {
          "type": "string",
          "description": "AWS VPC ID where the FSx ONTAP file system is located.",
          "x-terraform-computed": true
        },
        "endpointDns": {
          "type": "string",
          "description": "S3 endpoint DNS.",
          "x-terraform-computed": true
        },
        "region": {
          "type": "string",
          "description": "AWS region where the FSx ONTAP file system is located.",
          "x-terraform-computed": true
        },
        "caCertificate": {
          "type": "string",
          "description": "PEM-encoded root CA certificate for the FSxN SVM endpoint. Required when httpsEnabled is true."
        },
        "providerAccountName": {
          "type": "string",
          "description": "Provider account name where the FSx ONTAP file system is located. Not required when selfManagedNetwork is true.",
          "x-terraform-computed": true
        },
        "selfManagedNetwork": {
          "type": "boolean",
          "description": "When true, the customer manages all cross-account network connectivity (VPC peering, route tables, FSxN-side security group).",
          "x-terraform-computed": true,
          "x-terraform-force-new": true
        }
      },
      "description": "FSx ONTAP file system for the S3 FSxN integration."
    },
    "namedCollection": {
      "type": "string",
      "description": "A convenience named collection for query use.",
      "readOnly": true
    },
    "clusterId": {
      "type": "string",
      "description": "ID of the ClickHouse cluster.",
      "format": "uuid",
      "x-terraform-force-new": true
    },
    "id": {
      "type": "string",
      "description": "ID of the S3 FSxN integration.",
      "format": "uuid",
      "readOnly": true
    },
    "status": {
      "type": "string",
      "description": "Status of the S3 FSxN Integration.",
      "readOnly": true,
      "x-terraform-field-status": true
    }
  }
}