Class: Aws::IVSRealTime::Types::Stage

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::Stage

Defined in:

gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb

Overview

Object specifying a stage.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #active_session_id ⇒ String

  ID of the active session within the stage.

• #arn ⇒ String

  Stage ARN.

• #auto_participant_recording_configuration ⇒ Types::AutoParticipantRecordingConfiguration

  Configuration object for individual participant recording, attached to the stage.

• #endpoints ⇒ Types::StageEndpoints

  Summary information about various endpoints for a stage.

• #name ⇒ String

  Stage name.

• #tags ⇒ Hash<String,String>

  Tags attached to the resource.

Instance Attribute Details

#active_session_id ⇒ String

ID of the active session within the stage.

Returns:

• (String)

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

class Stage < Struct.new(
  :arn,
  :name,
  :active_session_id,
  :tags,
  :auto_participant_recording_configuration,
  :endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

Stage ARN.

Returns:

• (String)

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

class Stage < Struct.new(
  :arn,
  :name,
  :active_session_id,
  :tags,
  :auto_participant_recording_configuration,
  :endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#auto_participant_recording_configuration ⇒ Types::AutoParticipantRecordingConfiguration

Configuration object for individual participant recording, attached to the stage.

Returns:

• (Types::AutoParticipantRecordingConfiguration)

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

class Stage < Struct.new(
  :arn,
  :name,
  :active_session_id,
  :tags,
  :auto_participant_recording_configuration,
  :endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#endpoints ⇒ Types::StageEndpoints

Summary information about various endpoints for a stage.

Returns:

• (Types::StageEndpoints)

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

class Stage < Struct.new(
  :arn,
  :name,
  :active_session_id,
  :tags,
  :auto_participant_recording_configuration,
  :endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Stage name.

Returns:

• (String)

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

class Stage < Struct.new(
  :arn,
  :name,
  :active_session_id,
  :tags,
  :auto_participant_recording_configuration,
  :endpoints)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

• (Hash<String,String>)

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

class Stage < Struct.new(
  :arn,
  :name,
  :active_session_id,
  :tags,
  :auto_participant_recording_configuration,
  :endpoints)
  SENSITIVE = []
  include Aws::Structure
end