EBSOptions

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.

AnalyticsElasticsearchSearch

Properties

Name Type Description
EBSEnabled object
VolumeType object
VolumeSize object
Iops object
Throughput object
View JSON Schema on GitHub

JSON Schema

openapi-ebs-options-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-schema/openapi-ebs-options-schema.json",
  "title": "EBSOptions",
  "description": "Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs\" target=\"_blank\"> Configuring EBS-based Storage</a>.",
  "type": "object",
  "properties": {
    "EBSEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Specifies whether EBS-based storage is enabled."
        }
      ]
    },
    "VolumeType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VolumeType"
        },
        {
          "description": " Specifies the volume type for EBS-based storage."
        }
      ]
    },
    "VolumeSize": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IntegerClass"
        },
        {
          "description": " Integer to specify the size of an EBS volume."
        }
      ]
    },
    "Iops": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IntegerClass"
        },
        {
          "description": "Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD)."
        }
      ]
    },
    "Throughput": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IntegerClass"
        },
        {
          "description": "Specifies the Throughput for GP3 EBS volume (SSD)."
        }
      ]
    }
  }
}