GatewayInstance

The settings for an instance in a gateway.

BroadcastingLive VideoMediaMedia Transport

Properties

Name Type Description
BridgePlacement object
ConnectionStatus object
GatewayArn object
GatewayInstanceArn object
InstanceId object
InstanceMessages object
InstanceState object
RunningBridgeCount object
View JSON Schema on GitHub

JSON Schema

mediaconnect-api-gateway-instance-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediaconnect/refs/heads/main/json-schema/mediaconnect-api-gateway-instance-schema.json",
  "title": "GatewayInstance",
  "description": "The settings for an instance in a gateway.",
  "type": "object",
  "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"
  ]
}