Amazonka.KinesisVideo.Types.SingleMasterChannelEndpointConfiguration

Documentation

data SingleMasterChannelEndpointConfiguration

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

See: newSingleMasterChannelEndpointConfiguration smart constructor.

Constructors

SingleMasterChannelEndpointConfiguration'

Fields

• protocols :: Maybe (NonEmpty ChannelProtocol)

  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.

• role' :: Maybe ChannelRole

  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.

Instances

ToJSON SingleMasterChannelEndpointConfiguration

Defined in Amazonka.KinesisVideo.Types.SingleMasterChannelEndpointConfiguration

Methods

toJSON :: SingleMasterChannelEndpointConfiguration -> Value

toEncoding :: SingleMasterChannelEndpointConfiguration -> Encoding

toJSONList :: [SingleMasterChannelEndpointConfiguration] -> Value

toEncodingList :: [SingleMasterChannelEndpointConfiguration] -> Encoding

Generic SingleMasterChannelEndpointConfiguration

Defined in Amazonka.KinesisVideo.Types.SingleMasterChannelEndpointConfiguration

Associated Types

type Rep SingleMasterChannelEndpointConfiguration :: Type -> Type

Methods

from :: SingleMasterChannelEndpointConfiguration -> Rep SingleMasterChannelEndpointConfiguration x

to :: Rep SingleMasterChannelEndpointConfiguration x -> SingleMasterChannelEndpointConfiguration

Read SingleMasterChannelEndpointConfiguration

Defined in Amazonka.KinesisVideo.Types.SingleMasterChannelEndpointConfiguration

Methods

readsPrec :: Int -> ReadS SingleMasterChannelEndpointConfiguration

readList :: ReadS [SingleMasterChannelEndpointConfiguration]

readPrec :: ReadPrec SingleMasterChannelEndpointConfiguration

readListPrec :: ReadPrec [SingleMasterChannelEndpointConfiguration]

Show SingleMasterChannelEndpointConfiguration

Defined in Amazonka.KinesisVideo.Types.SingleMasterChannelEndpointConfiguration

Methods

showsPrec :: Int -> SingleMasterChannelEndpointConfiguration -> ShowS

show :: SingleMasterChannelEndpointConfiguration -> String

showList :: [SingleMasterChannelEndpointConfiguration] -> ShowS

NFData SingleMasterChannelEndpointConfiguration

Defined in Amazonka.KinesisVideo.Types.SingleMasterChannelEndpointConfiguration

Methods

rnf :: SingleMasterChannelEndpointConfiguration -> ()

Eq SingleMasterChannelEndpointConfiguration

Defined in Amazonka.KinesisVideo.Types.SingleMasterChannelEndpointConfiguration

Methods

(==) :: SingleMasterChannelEndpointConfiguration -> SingleMasterChannelEndpointConfiguration -> Bool

(/=) :: SingleMasterChannelEndpointConfiguration -> SingleMasterChannelEndpointConfiguration -> Bool

Hashable SingleMasterChannelEndpointConfiguration

Defined in Amazonka.KinesisVideo.Types.SingleMasterChannelEndpointConfiguration

Methods

hashWithSalt :: Int -> SingleMasterChannelEndpointConfiguration -> Int

hash :: SingleMasterChannelEndpointConfiguration -> Int

type Rep SingleMasterChannelEndpointConfiguration

Defined in Amazonka.KinesisVideo.Types.SingleMasterChannelEndpointConfiguration

type Rep SingleMasterChannelEndpointConfiguration = D1 ('MetaData "SingleMasterChannelEndpointConfiguration" "Amazonka.KinesisVideo.Types.SingleMasterChannelEndpointConfiguration" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "SingleMasterChannelEndpointConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "protocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ChannelProtocol))) :*: S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelRole))))

newSingleMasterChannelEndpointConfiguration :: SingleMasterChannelEndpointConfiguration

Create a value of SingleMasterChannelEndpointConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:protocols:SingleMasterChannelEndpointConfiguration', singleMasterChannelEndpointConfiguration_protocols - 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.

$sel:role':SingleMasterChannelEndpointConfiguration', singleMasterChannelEndpointConfiguration_role - 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.

singleMasterChannelEndpointConfiguration_protocols :: Lens' SingleMasterChannelEndpointConfiguration (Maybe (NonEmpty ChannelProtocol))

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.

singleMasterChannelEndpointConfiguration_role :: Lens' SingleMasterChannelEndpointConfiguration (Maybe ChannelRole)

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.