AddOutputRequest

{
  "$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-add-output-request-schema.json",
  "title": "AddOutputRequest",
  "description": "The output that you want to add to this flow.",
  "type": "object",
  "properties": {
    "CidrAllowList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOf__string"
        },
        {
          "xml": {
            "name": "cidrAllowList"
          },
          "description": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "description"
          },
          "description": "A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user."
        }
      ]
    },
    "Destination": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "destination"
          },
          "description": "The IP address from which video will be sent to output destinations."
        }
      ]
    },
    "Encryption": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Encryption"
        },
        {
          "xml": {
            "name": "encryption"
          },
          "description": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key."
        }
      ]
    },
    "MaxLatency": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "maxLatency"
          },
          "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams."
        }
      ]
    },
    "MediaStreamOutputConfigurations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOfMediaStreamOutputConfigurationRequest"
        },
        {
          "xml": {
            "name": "mediaStreamOutputConfigurations"
          },
          "description": "The media streams that are associated with the output, and the parameters for those associations."
        }
      ]
    },
    "MinLatency": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "minLatency"
          },
          "description": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "name"
          },
          "description": "The name of the output. This value must be unique within the current flow."
        }
      ]
    },
    "Port": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "port"
          },
          "description": "The port to use when content is distributed to this output."
        }
      ]
    },
    "Protocol": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Protocol"
        },
        {
          "xml": {
            "name": "protocol"
          },
          "description": "The protocol to use for the output."
        }
      ]
    },
    "RemoteId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "remoteId"
          },
          "description": "The remote ID for the Zixi-pull output stream."
        }
      ]
    },
    "SenderControlPort": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "senderControlPort"
          },
          "description": "The port that the flow uses to send outbound requests to initiate connection with the sender."
        }
      ]
    },
    "SmoothingLatency": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "smoothingLatency"
          },
          "description": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams."
        }
      ]
    },
    "StreamId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "streamId"
          },
          "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams."
        }
      ]
    },
    "VpcInterfaceAttachment": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VpcInterfaceAttachment"
        },
        {
          "xml": {
            "name": "vpcInterfaceAttachment"
          },
          "description": "The name of the VPC interface attachment to use for this output."
        }
      ]
    }
  },
  "required": [
    "Protocol"
  ]
}