Amazon MediaConnect · JSON Structure

Mediaconnect Api Gateway Instance Structure

The settings for an instance in a gateway.

Type: object Properties: 8 Required: 7
BroadcastingLive VideoMediaMedia Transport

GatewayInstance is a JSON Structure definition published by Amazon MediaConnect, describing 8 properties, of which 7 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

BridgePlacement ConnectionStatus GatewayArn GatewayInstanceArn InstanceId InstanceMessages InstanceState RunningBridgeCount

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-mediaconnect/refs/heads/main/json-structure/mediaconnect-api-gateway-instance-structure.json",
  "name": "GatewayInstance",
  "type": "object",
  "description": "The settings for an instance in a gateway.",
  "properties": {
    "BridgePlacement": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BridgePlacement"
        },
        {
          "xml": {
            "name": "bridgePlacement"
          },
          "description": "The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance."
        }
      ]
    },
    "ConnectionStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConnectionStatus"
        },
        {
          "xml": {
            "name": "connectionStatus"
          },
          "description": "The connection state of the instance."
        }
      ]
    },
    "GatewayArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "gatewayArn"
          },
          "description": "The Amazon Resource Name (ARN) of the instance."
        }
      ]
    },
    "GatewayInstanceArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "gatewayInstanceArn"
          },
          "description": "The Amazon Resource Name (ARN) of the gateway."
        }
      ]
    },
    "InstanceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "instanceId"
          },
          "description": "The managed instance ID generated by the SSM install. This will begin with \"mi-\"."
        }
      ]
    },
    "InstanceMessages": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOfMessageDetail"
        },
        {
          "xml": {
            "name": "instanceMessages"
          }
        }
      ]
    },
    "InstanceState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InstanceState"
        },
        {
          "xml": {
            "name": "instanceState"
          },
          "description": "The status of the instance."
        }
      ]
    },
    "RunningBridgeCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "runningBridgeCount"
          },
          "description": "The running bridge count."
        }
      ]
    }
  },
  "required": [
    "GatewayArn",
    "InstanceState",
    "GatewayInstanceArn",
    "InstanceId",
    "RunningBridgeCount",
    "BridgePlacement",
    "ConnectionStatus"
  ]
}