Amazon Direct Connect · JSON Structure

Amazon Direct Connect Virtual Gateway Structure

Information about a virtual private gateway for a private virtual interface.

Type: object Properties: 2
Dedicated ConnectionDirect ConnectHybrid CloudNetworking

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

Properties

virtualGatewayId virtualGatewayState

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-direct-connect/refs/heads/main/json-structure/amazon-direct-connect-virtual-gateway-structure.json",
  "description": "Information about a virtual private gateway for a private virtual interface.",
  "type": "object",
  "properties": {
    "virtualGatewayId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VirtualGatewayId"
        },
        {
          "description": "The ID of the virtual private gateway."
        }
      ]
    },
    "virtualGatewayState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VirtualGatewayState"
        },
        {
          "description": "<p>The state of the virtual private gateway. The following are the possible values:</p> <ul> <li> <p> <code>pending</code>: Initial state after creating the virtual private gateway.</p> </li> <li> <p> <code>available</code>: Ready for use by a private virtual interface.</p> </li> <li> <p> <code>deleting</code>: Initial state after deleting the virtual private gateway.</p> </li> <li> <p> <code>deleted</code>: The virtual private gateway is deleted. The private virtual interface is unable to send traffic over this gateway.</p> </li> </ul>"
        }
      ]
    }
  },
  "name": "VirtualGateway"
}