Amazon MediaConnect · JSON Structure

Mediaconnect Api Gateway Structure

The settings for a gateway, including its networks.

Type: object Properties: 6 Required: 4
BroadcastingLive VideoMediaMedia Transport

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

Properties

EgressCidrBlocks GatewayArn GatewayMessages GatewayState Name Networks

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-structure.json",
  "name": "Gateway",
  "type": "object",
  "description": "The settings for a gateway, including its networks.",
  "properties": {
    "EgressCidrBlocks": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOf__string"
        },
        {
          "xml": {
            "name": "egressCidrBlocks"
          },
          "description": "The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."
        }
      ]
    },
    "GatewayArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "gatewayArn"
          },
          "description": "The Amazon Resource Name (ARN) of the gateway."
        }
      ]
    },
    "GatewayMessages": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOfMessageDetail"
        },
        {
          "xml": {
            "name": "gatewayMessages"
          }
        }
      ]
    },
    "GatewayState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GatewayState"
        },
        {
          "xml": {
            "name": "gatewayState"
          },
          "description": "The current status of the gateway."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "name"
          },
          "description": "The name of the gateway. This name can not be modified after the gateway is created."
        }
      ]
    },
    "Networks": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOfGatewayNetwork"
        },
        {
          "xml": {
            "name": "networks"
          },
          "description": "The list of networks in the gateway."
        }
      ]
    }
  },
  "required": [
    "GatewayArn",
    "Networks",
    "EgressCidrBlocks",
    "Name"
  ]
}