Class: Aws::KinesisVideo::Types::SingleMasterChannelEndpointConfiguration

Inherits:

Struct

Object
Struct
Aws::KinesisVideo::Types::SingleMasterChannelEndpointConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-kinesisvideo/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#protocols ⇒ Array<String>

This property is used to determine the nature of communication over this ‘SINGLE_MASTER` signaling channel.
#role ⇒ String

This property is used to determine messaging permissions in this ‘SINGLE_MASTER` signaling channel.

Instance Attribute Details

#protocols ⇒ `Array<String>`

This property is used to determine the nature of communication over this ‘SINGLE_MASTER` signaling channel. If `WSS` is specified, this API returns a websocket endpoint. If `HTTPS` is specified, this API returns an `HTTPS` endpoint.

Returns:

(Array<String>)

# File 'lib/aws-sdk-kinesisvideo/types.rb', line 1593

class SingleMasterChannelEndpointConfiguration < Struct.new(
  :protocols,
  :role)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ `String`

This property is used to determine messaging permissions in this ‘SINGLE_MASTER` signaling channel. If `MASTER` 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 `VIEWER` is specified, this API returns an endpoint that a client can use only to send offers to another `MASTER` client on this signaling channel.