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

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::CreateParticipantTokenRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ivsrealtime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes ⇒ Hash<String,String>

  Application-provided attributes to encode into the token and attach to a stage.

• #capabilities ⇒ Array<String>

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

• #duration ⇒ Integer

  Duration (in minutes), after which the token expires.

• #stage_arn ⇒ String

  ARN of the stage to which this token is scoped.

• #user_id ⇒ String

  Name that can be specified to help identify the token.

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>)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 383

class CreateParticipantTokenRequest < Struct.new(
  :stage_arn,
  :duration,
  :user_id,
  :attributes,
  :capabilities)
  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>)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 383

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

#duration ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 383

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

#stage_arn ⇒ String

ARN of the stage to which this token is scoped.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 383

class CreateParticipantTokenRequest < Struct.new(
  :stage_arn,
  :duration,
  :user_id,
  :attributes,
  :capabilities)
  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)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 383

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