Amazon OpenSearch Service API · JSON Structure

Openapi Vpc Options Structure

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

Type: object Properties: 2
AnalyticsElasticsearchSearch

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

Properties

SubnetIds SecurityGroupIds

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-vpc-options-structure.json",
  "name": "VPCOptions",
  "description": "Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html\" target=\"_blank\"> VPC Endpoints for Amazon Elasticsearch Service Domains</a>.",
  "type": "object",
  "properties": {
    "SubnetIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringList"
        },
        {
          "description": "Specifies the subnets for VPC endpoint."
        }
      ]
    },
    "SecurityGroupIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringList"
        },
        {
          "description": "Specifies the security groups for VPC endpoint."
        }
      ]
    }
  }
}