Amazon OpenSearch Service API · JSON Structure

Openapi Auto Tune Options Structure

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

Type: object Properties: 3
AnalyticsElasticsearchSearch

AutoTuneOptions is a JSON Structure definition published by Amazon OpenSearch Service API, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

DesiredState RollbackOnDisable MaintenanceSchedules

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-structure/openapi-auto-tune-options-structure.json",
  "name": "AutoTuneOptions",
  "description": "Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.",
  "type": "object",
  "properties": {
    "DesiredState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AutoTuneDesiredState"
        },
        {
          "description": "Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. "
        }
      ]
    },
    "RollbackOnDisable": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RollbackOnDisable"
        },
        {
          "description": "Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK. "
        }
      ]
    },
    "MaintenanceSchedules": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AutoTuneMaintenanceScheduleList"
        },
        {
          "description": "Specifies list of maitenance schedules. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information."
        }
      ]
    }
  }
}