{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/instaclustr/main/json-schema/instaclustr-open-search-cluster-v2-schema.json", "title": "OpenSearchClusterV2", "description": "Definition of a managed OpenSearch cluster that can be provisioned in Instaclustr.", "x-generated": "2026-10-13", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/instaclustr-openapi.yml#/components/schemas/OpenSearchClusterV2", "required": [ "clusterManagerNodes", "dataCentres", "name", "pciComplianceMode", "privateNetworkCluster", "slaTier" ], "type": "object", "properties": { "publicEndpoint": { "type": "string", "description": "Public endpoint to connect clients to the cluster. Not applicable to Private IP only clusters.", "readOnly": true }, "dataNodes": { "maxItems": 1, "type": "array", "description": "List of data node settings.", "items": { "$ref": "#/$defs/OpenSearchDataNodeV2" }, "x-terraform-ignore-order": true }, "opensearchVersion": { "pattern": "([0-9]+\\.){2}[0-9]+", "type": "string", "description": "Version of OpenSearch to run on the cluster. Must be provided if `opensearchMajorVersion` is not provided. Available versions: ", "x-terraform-computed": true, "x-terraform-force-new": true }, "leaderClusterAccount": { "type": "string", "description": "The leader cluster account ID for a Cross Cluster Replication enabled follower cluster. This requires crossClusterReplicationPlugin to be set to true.", "readOnly": true }, "searchableSnapshots": { "type": "boolean", "description": "Enable searchable snapshots. Available only for OpenSearch versions 2.7.0 or higher.", "x-terraform-computed": true, "x-terraform-force-new": true }, "asynchronousSearchPlugin": { "type": "boolean", "description": "Enable asynchronous search plugin", "x-terraform-computed": true, "x-terraform-force-new": true }, "description": { "type": "string", "description": "A description of the cluster", "x-terraform-computed": true }, "privateEndpoint": { "pattern": "private-search.ae9ea530db48478cbc42bdac51075179.cu.dev.instaclustr.com", "type": "string", "description": "Private endpoint to connect clients to the cluster.", "readOnly": true }, "knnPlugin": { "type": "boolean", "description": "Enable the k-NN plugin", "x-terraform-computed": true, "x-terraform-force-new": true }, "mapperSizePlugin": { "type": "boolean", "description": "Enable Mapper Size plugin", "readOnly": true }, "opensearchDashboards": { "maxItems": 1, "type": "array", "description": "List of openSearch dashboards settings", "items": { "$ref": "#/$defs/OpenSearchDashboardV2" } }, "vectorIndexBuilder": { "maxItems": 1, "type": "array", "description": "Remote Vector Index Builder settings. When provided, a dedicated GPU host is provisioned.", "items": { "$ref": "#/$defs/OpenSearchVectorIndexBuilderV2" }, "x-terraform-computed": true }, "reportingPlugin": { "type": "boolean", "description": "Enable reporting plugin", "x-terraform-computed": true, "x-terraform-force-new": true }, "ingestNodesLoadBalancerConnectionUrl": { "type": "string", "description": "URL of the Ingest Nodes specific Network Load Balancer if a load balancer is enabled for the cluster. Balances request loads against nodes with the ingest role. Recommended for clusters with dedicated ingest nodes.", "readOnly": true }, "sqlPlugin": { "type": "boolean", "description": "Enable sql plugin", "x-terraform-computed": true, "x-terraform-force-new": true }, "notificationsPlugin": { "type": "boolean", "description": "Enables notifications plugin. For OpenSearch 2.x and later, if you want to enable this plugin you must also enable the Alerting plugin.", "x-terraform-computed": true, "x-terraform-force-new": true }, "nodeTypeAttributesEnabled": { "type": "boolean", "description": "Enable managed node_type attributes. Requires the OPENSEARCH_NODE_TYPE_ATTRIBUTES account feature. Exactly one data-role node per rack is assigned node_type=metadata and all remaining data-role nodes are assigned node_type=data.", "x-terraform-computed": true, "x-terraform-force-new": true }, "currentClusterOperationStatus": { "$ref": "#/$defs/CurrentClusterOperationStatusV2" }, "anomalyDetectionPlugin": { "type": "boolean", "description": "Enable anomaly detection plugin", "x-terraform-computed": true, "x-terraform-force-new": true }, "leaderClusterId": { "type": "string", "description": "Specifies the leader cluster ID for a Cross Cluster Replication enabled follower cluster. This requires crossClusterReplicationPlugin to be set to true. Not defining this will make the cluster a leader cluster if crossClusterReplicationPlugin is set to true.", "format": "uuid", "x-terraform-computed": true, "x-terraform-force-new": true }, "loadBalancer": { "type": "boolean", "description": "Enable Load Balancer", "x-terraform-computed": true, "x-terraform-force-new": true }, "privateNetworkCluster": { "type": "boolean", "description": "Creates the cluster with private network only, see [Private Network Clusters](https://www.instaclustr.com/support/documentation/useful-information/private-network-clusters/).", "x-terraform-force-new": true }, "bundledUseOnly": { "type": "boolean", "description": "Provision this cluster for [Bundled Use only](https://www.instaclustr.com/support/documentation/cadence/getting-started-with-cadence/bundled-use-only-cluster-deployments/).", "x-terraform-computed": true, "x-terraform-force-new": true }, "restoreSettings": { "maxItems": 1, "type": "array", "description": "Triggers a restore operation when provided during cluster creation. Contains the settings for the restore request.", "items": { "$ref": "#/$defs/OpenSearchClusterRestoreSettingsV2" }, "x-terraform-write-only": true }, "resizeSettings": { "maxItems": 1, "type": "array", "description": "Settings to determine how resize requests will be performed for the cluster.", "items": { "$ref": "#/$defs/ResizeSettingsV2" }, "x-terraform-write-only": true }, "id": { "type": "string", "description": "ID of the cluster.", "readOnly": true }, "slaTier": { "$ref": "#/$defs/SlaTierV2" }, "pciComplianceMode": { "type": "boolean", "description": "Creates a PCI compliant cluster, see [PCI Compliance](https://www.instaclustr.com/support/documentation/useful-information/pci-compliance/).", "x-terraform-force-new": true }, "icuPlugin": { "type": "boolean", "description": "Enable icu plugin", "x-terraform-computed": true, "x-terraform-force-new": true }, "anonymousAuthEnabled": { "type": "boolean", "description": "Enable anonymous authentication. Allows unauthenticated requests with restricted permissions. Requires Private Network Cluster. Not available when PCI compliance mode is enabled.", "x-terraform-computed": true, "x-terraform-force-new": true }, "twoFactorDelete": { "maxItems": 1, "type": "array", "description": "", "items": { "$ref": "#/$defs/TwoFactorDeleteSettingsV2" }, "x-terraform-computed": true }, "opensearchMajorVersion": { "maximum": 3, "minimum": 1, "type": "integer", "description": "Major version of OpenSearch to run on the cluster. Must be provided if `opensearchVersion` is not provided.", "x-terraform-computed": true, "x-terraform-force-new": true }, "enableBidirectionalReplication": { "type": "boolean", "description": "When true, provisions the new follower with bi-directional OpenSearch cross-cluster replication against the specified leader. Requires `leaderClusterId` and `crossClusterReplicationPlugin` to be set to true. The account must have the OpenSearch bi-directional CCR feature enabled. On GET, true when this cluster is a bi-directional follower of its leader.", "x-terraform-computed": true, "x-terraform-force-new": true }, "crossClusterReplicationPlugin": { "type": "boolean", "description": "Enable cross cluster replication plugin", "x-terraform-computed": true, "x-terraform-force-new": true }, "defaultUserPassword": { "type": "string", "description": "Password of the default user created for the OpenSearch cluster.", "readOnly": true, "x-terraform-sensitive": true }, "aiSearchPlugin": { "type": "boolean", "description": "Enable AI Search plugin", "x-terraform-computed": true, "x-terraform-force-new": true }, "dataCentres": { "maxItems": 1, "minItems": 1, "type": "array", "description": "List of data centre settings.", "items": { "$ref": "#/$defs/OpenSearchDataCentreV2" }, "x-terraform-field-name": "data_centre" }, "ingestNodes": { "maxItems": 1, "type": "array", "description": "Ingest nodes settings.", "items": { "$ref": "#/$defs/OpenSearchIngestNodeV2" }, "x-terraform-computed": true }, "loadBalancerConnectionUrl": { "type": "string", "description": "URL of the Network Load Balancer if a load balancer is enabled for the cluster. Balances request loads against all nodes in the cluster except for ingest nodes.", "readOnly": true }, "defaultUsername": { "type": "string", "description": "Username of the default user created for the OpenSearch cluster.", "readOnly": true, "x-terraform-sensitive": true }, "observabilityPlugin": { "type": "boolean", "description": "Enable observability plugin", "x-terraform-computed": true, "x-terraform-force-new": true }, "name": { "maxLength": 48, "minLength": 3, "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*", "type": "string", "description": "Name of the cluster.", "x-terraform-force-new": true }, "clusterManagerNodes": { "maxItems": 1, "minItems": 1, "type": "array", "description": "List of cluster managers node settings", "items": { "$ref": "#/$defs/OpenSearchClusterManagerNodeV2" } }, "indexManagementPlugin": { "type": "boolean", "description": "Enable index management plugin", "x-terraform-computed": true, "x-terraform-force-new": true }, "portal26Plugin": { "type": "boolean", "description": "Whether or not the Portal26 plugin is enabled for this cluster.", "readOnly": true }, "alertingPlugin": { "type": "boolean", "description": "Enables alerting plugin. For OpenSearch 2.x and later, if you want to enable this plugin you must also enable the Notifications plugin.", "x-terraform-computed": true, "x-terraform-force-new": true }, "status": { "type": "string", "description": "Status of the cluster.", "readOnly": true } }, "$defs": { "BackupCompatibleProviderAwsSettingsV2": { "type": "object", "properties": { "backupBucket": { "type": "string", "description": "Specify the S3 bucket to use for storing backup data for the cluster data centre. Only available for customers running in their own cloud provider accounts.", "x-insta-unchangeable": true, "x-terraform-computed": true, "x-terraform-force-new": true }, "ebsEncryptionKey": { "type": "string", "description": "ID of a KMS encryption key to encrypt data on nodes. KMS encryption key must be set in Cluster Resources through the Instaclustr Console before provisioning an encrypted Data Centre.", "format": "uuid", "x-insta-unchangeable": true }, "customVirtualNetworkId": { "type": "string", "description": "VPC ID into which the Data Centre will be provisioned. The Data Centre's network allocation must match the IPv4 CIDR block of the specified VPC.", "x-insta-unchangeable": true, "x-terraform-computed": true }, "storageNetwork": { "type": "string", "description": "The private network address block to be used for the storage network. This is only used for certain node sizes, currently limited to those which use AWS FSx ONTAP: for all other node sizes, this field should not be provided. The network must have a prefix length between /16 and /28, and must be part of a private address range.", "x-insta-unchangeable": true } }, "description": "" }, "BackupCompatibleProviderAzureSettingsV2": { "type": "object", "properties": { "resourceGroup": { "type": "string", "description": "The name of the Azure Resource Group into which the Data Centre will be provisioned.", "x-insta-unchangeable": true }, "customVirtualNetworkId": { "type": "string", "description": "VNet ID into which the Data Centre will be provisioned. The VNet must have an available address space for the Data Centre's network allocation to be appended to the VNet. Currently supported for PostgreSQL clusters only.", "x-insta-unchangeable": true }, "storageNetwork": { "type": "string", "description": "The private network address block to be used for the storage network. This is only used for certain node sizes, currently limited to those which use Azure NetApp Files: for all other node sizes, this field should not be provided. The network must have a prefix length between /16 and /28, and must be part of a private address range.", "x-insta-unchangeable": true }, "backupStorageAccount": { "type": "string", "description": "Specify the Storage Account to use for storing backup data for the cluster data centre. Only available for customers running in their own cloud provider accounts.", "x-insta-unchangeable": true, "x-terraform-computed": true, "x-terraform-force-new": true } }, "description": "" }, "BackupCompatibleProviderGcpSettingsV2": { "type": "object", "properties": { "disableSnapshotAutoExpiry": { "type": "boolean", "description": "This field is accepted but ignored. All GCP OpenSearch clusters now use backup buckets with no expiry policy regardless of this setting. Previously controlled whether the GCS backup bucket should automatically expire data after 7 days.", "x-insta-unchangeable": true, "x-terraform-computed": true, "x-terraform-force-new": true }, "customVirtualNetworkId": { "type": "string", "description": "Network name or a relative Network or Subnetwork URI.\nThe Data Centre's network allocation must match the IPv4 CIDR block of the specified subnet.\n\nExamples:\n- Network URI: projects/{riyoa-gcp-project-name}/global/networks/{network-name}.\n- Network name: {network-name}, equivalent to projects/{riyoa-gcp-project-name}/global/networks/{network-name}.\n- Same-project subnetwork URI: projects/{riyoa-gcp-project-name}/regions/{region-id}/subnetworks/{subnetwork-name}.\n- Shared VPC subnetwork URI: projects/{riyoa-gcp-host-project-name}/regions/{region-id}/subnetworks/{subnetwork-name}.\n\n", "x-insta-unchangeable": true } }, "description": "" }, "CdcNetworkDetailsV2": { "type": "object", "properties": { "cidr": { "type": "string", "description": "Network CIDR in notation, for example 10.0.0.0/16.", "readOnly": true }, "primary": { "type": "boolean", "description": "True when this entry is the data centre primary network.", "readOnly": true }, "status": { "type": "string", "description": "Provisioning status of the network registration.", "readOnly": true } }, "description": "A network CIDR associated with the data centre (primary or expanded secondary)." }, "CloudProviderEnumV2": { "type": "string", "description": "Name of a cloud provider service.", "enum": [ "AWS_VPC", "GCP", "AZURE", "AZURE_AZ", "ONPREMISES" ], "x-insta-unchangeable": true }, "CommonClusterRestoreModeEnumV2": { "type": "string", "description": "Determines the target VPC for restored cluster. Accepted values are:\n