Class: Aws::IVSRealTime::Types::IngestConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::IngestConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-ivsrealtime/types.rb

Overview

Object specifying an ingest configuration.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:stream_key]

Instance Attribute Summary

• #arn ⇒ String

  Ingest configuration ARN.

• #attributes ⇒ Hash<String,String>

  Application-provided attributes to to store in the IngestConfiguration and attach to a stage.

• #ingest_protocol ⇒ String

  Type of ingest protocol that the user employs for broadcasting.

• #name ⇒ String

  Ingest name.

• #participant_id ⇒ String

  ID of the participant within the stage.

• #stage_arn ⇒ String

  ARN of the stage with which the IngestConfiguration is associated.

• #state ⇒ String

  State of the ingest configuration.

• #stream_key ⇒ String

  Ingest-key value for the RTMP(S) protocol.

• #tags ⇒ Hash<String,String>

  Tags attached to the resource.

• #user_id ⇒ String

  Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems.

Instance Attribute Details

#arn ⇒ String

Ingest configuration ARN.

Returns:

• (String)

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

class IngestConfiguration < Struct.new(
  :name,
  :arn,
  :ingest_protocol,
  :stream_key,
  :stage_arn,
  :participant_id,
  :state,
  :user_id,
  :attributes,
  :tags)
  SENSITIVE = [:stream_key]
  include Aws::Structure
end

#attributes ⇒ Hash<String,String>

Application-provided attributes to to store in the IngestConfiguration 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 1229

class IngestConfiguration < Struct.new(
  :name,
  :arn,
  :ingest_protocol,
  :stream_key,
  :stage_arn,
  :participant_id,
  :state,
  :user_id,
  :attributes,
  :tags)
  SENSITIVE = [:stream_key]
  include Aws::Structure
end

#ingest_protocol ⇒ String

Type of ingest protocol that the user employs for broadcasting.

Returns:

• (String)

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

class IngestConfiguration < Struct.new(
  :name,
  :arn,
  :ingest_protocol,
  :stream_key,
  :stage_arn,
  :participant_id,
  :state,
  :user_id,
  :attributes,
  :tags)
  SENSITIVE = [:stream_key]
  include Aws::Structure
end

#name ⇒ String

Ingest name

Returns:

• (String)

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

class IngestConfiguration < Struct.new(
  :name,
  :arn,
  :ingest_protocol,
  :stream_key,
  :stage_arn,
  :participant_id,
  :state,
  :user_id,
  :attributes,
  :tags)
  SENSITIVE = [:stream_key]
  include Aws::Structure
end

#participant_id ⇒ String

ID of the participant within the stage.

Returns:

• (String)

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

class IngestConfiguration < Struct.new(
  :name,
  :arn,
  :ingest_protocol,
  :stream_key,
  :stage_arn,
  :participant_id,
  :state,
  :user_id,
  :attributes,
  :tags)
  SENSITIVE = [:stream_key]
  include Aws::Structure
end

#stage_arn ⇒ String

ARN of the stage with which the IngestConfiguration is associated.

Returns:

• (String)

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

class IngestConfiguration < Struct.new(
  :name,
  :arn,
  :ingest_protocol,
  :stream_key,
  :stage_arn,
  :participant_id,
  :state,
  :user_id,
  :attributes,
  :tags)
  SENSITIVE = [:stream_key]
  include Aws::Structure
end

#state ⇒ String

State of the ingest configuration. It is ‘ACTIVE` if a publisher currently is publishing to the stage associated with the ingest configuration.

Returns:

• (String)

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

class IngestConfiguration < Struct.new(
  :name,
  :arn,
  :ingest_protocol,
  :stream_key,
  :stage_arn,
  :participant_id,
  :state,
  :user_id,
  :attributes,
  :tags)
  SENSITIVE = [:stream_key]
  include Aws::Structure
end

#stream_key ⇒ String

Ingest-key value for the RTMP(S) protocol.

Returns:

• (String)

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

class IngestConfiguration < Struct.new(
  :name,
  :arn,
  :ingest_protocol,
  :stream_key,
  :stage_arn,
  :participant_id,
  :state,
  :user_id,
  :attributes,
  :tags)
  SENSITIVE = [:stream_key]
  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.

[1]: docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html

Returns:

• (Hash<String,String>)

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

class IngestConfiguration < Struct.new(
  :name,
  :arn,
  :ingest_protocol,
  :stream_key,
  :stage_arn,
  :participant_id,
  :state,
  :user_id,
  :attributes,
  :tags)
  SENSITIVE = [:stream_key]
  include Aws::Structure
end

#user_id ⇒ String

Customer-assigned name to help identify the participant using the IngestConfiguration; 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)

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

class IngestConfiguration < Struct.new(
  :name,
  :arn,
  :ingest_protocol,
  :stream_key,
  :stage_arn,
  :participant_id,
  :state,
  :user_id,
  :attributes,
  :tags)
  SENSITIVE = [:stream_key]
  include Aws::Structure
end