You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KinesisVideoSignalingChannels::Types::GetIceServerConfigRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetIceServerConfigRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  channel_arn: "ResourceARN", # required
  client_id: "ClientId",
  service: "TURN", # accepts TURN
  username: "Username",
}

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arnString

The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.

Returns:

  • (String)

    The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.

#client_idString

Unique identifier for the viewer. Must be unique within the signaling channel.

Returns:

  • (String)

    Unique identifier for the viewer.

#serviceString

Specifies the desired service. Currently, TURN is the only valid value.

Possible values:

  • TURN

Returns:

  • (String)

    Specifies the desired service.

#usernameString

An optional user ID to be associated with the credentials.

Returns:

  • (String)

    An optional user ID to be associated with the credentials.