Class: Aws::IVSRealTime::Types::StartParticipantReplicationRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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 set on the replicated participant in the destination 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.*

These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.

Returns:

  • (Hash<String,String>) 


3065
3066
3067
3068
3069
3070
3071
3072
3073
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 3065

class StartParticipantReplicationRequest < Struct.new(
  :source_stage_arn,
  :destination_stage_arn,
  :participant_id,
  :reconnect_window_seconds,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#destination_stage_arn ⇒ String

ARN of the stage to which the participant will be replicated.

Returns:

  • (String) 


3065
3066
3067
3068
3069
3070
3071
3072
3073
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 3065

class StartParticipantReplicationRequest < Struct.new(
  :source_stage_arn,
  :destination_stage_arn,
  :participant_id,
  :reconnect_window_seconds,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#participant_id ⇒ String

Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by CreateParticipantToken or the ‘jti` (JWT ID) used to [create a self signed token].

[1]: docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed

Returns:

  • (String) 


3065
3066
3067
3068
3069
3070
3071
3072
3073
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 3065

class StartParticipantReplicationRequest < Struct.new(
  :source_stage_arn,
  :destination_stage_arn,
  :participant_id,
  :reconnect_window_seconds,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#reconnect_window_seconds ⇒ Integer

If the participant disconnects and then reconnects within the specified interval, replication will continue to be ‘ACTIVE`. Default: 0.

Returns:

  • (Integer) 


3065
3066
3067
3068
3069
3070
3071
3072
3073
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 3065

class StartParticipantReplicationRequest < Struct.new(
  :source_stage_arn,
  :destination_stage_arn,
  :participant_id,
  :reconnect_window_seconds,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#source_stage_arn ⇒ String

ARN of the stage where the participant is publishing.

Returns:

  • (String) 


3065
3066
3067
3068
3069
3070
3071
3072
3073
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 3065

class StartParticipantReplicationRequest < Struct.new(
  :source_stage_arn,
  :destination_stage_arn,
  :participant_id,
  :reconnect_window_seconds,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end