Class: Aws::IVSRealTime::Types::ParticipantTokenConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb

Overview

Object specifying a participant token configuration in a stage.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,String>

Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Returns:

  • (Hash<String,String>) 


1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1460

class ParticipantTokenConfiguration < Struct.new(
  :attributes,
  :capabilities,
  :duration,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#capabilities ⇒ Array<String>

Set of capabilities that the user is allowed to perform in the stage.

Returns:

  • (Array<String>) 


1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1460

class ParticipantTokenConfiguration < Struct.new(
  :attributes,
  :capabilities,
  :duration,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#duration ⇒ Integer

Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).

Returns:

  • (Integer) 


1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1460

class ParticipantTokenConfiguration < Struct.new(
  :attributes,
  :capabilities,
  :duration,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Returns:

  • (String) 


1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1460

class ParticipantTokenConfiguration < Struct.new(
  :attributes,
  :capabilities,
  :duration,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end