AWS Kinesis · Schema

SingleMasterChannelEndpointConfiguration

An object that contains the endpoint configuration for the SINGLE_MASTER channel type.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
Protocols object
Role object
View JSON Schema on GitHub

JSON Schema

kinesis-singlemasterchannelendpointconfiguration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SingleMasterChannelEndpointConfiguration",
  "title": "SingleMasterChannelEndpointConfiguration",
  "type": "object",
  "properties": {
    "Protocols": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfProtocols"
        },
        {
          "description": "This property is used to determine the nature of communication over this <code>SINGLE_MASTER</code> signaling channel. If <code>WSS</code> is specified, this API returns a websocket endpoint. If <code>HTTPS</code> is specified, this API returns an <code>HTTPS</code> endpoint."
        }
      ]
    },
    "Role": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChannelRole"
        },
        {
          "description": "This property is used to determine messaging permissions in this <code>SINGLE_MASTER</code> signaling channel. If <code>MASTER</code> is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If <code>VIEWER</code> is specified, this API returns an endpoint that a client can use only to send offers to another <code>MASTER</code> client on this signaling channel. "
        }
      ]
    }
  },
  "description": "An object that contains the endpoint configuration for the <code>SINGLE_MASTER</code> channel type. "
}