Class: Aws::IVSRealTime::Types::CreateParticipantTokenRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,String>

Application-provided attributes to encode into the 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>) 


247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 247

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

#capabilities ⇒ Array<String>

Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Returns:

  • (Array<String>) 


247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 247

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

#duration ⇒ Integer

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

Returns:

  • (Integer) 


247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 247

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

#stage_arn ⇒ String

ARN of the stage to which this token is scoped.

Returns:

  • (String) 


247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 247

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

#user_id ⇒ String

Name that can be specified to help identify the token. 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) 


247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 247

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