ivsrealtime/aws.sdk.kotlin.services.ivsrealtime.model/IngestConfiguration

IngestConfiguration

class IngestConfiguration

Object specifying an ingest configuration.

Types

object Companion

Properties

val arn: String

Ingest configuration ARN.

val attributes: Map<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.

val ingestProtocol: IngestProtocol

Type of ingest protocol that the user employs for broadcasting.

val name: String?

Ingest name

val participantId: String

ID of the participant within the stage.

val stageArn: String

ARN of the stage with which the IngestConfiguration is associated.

val state: IngestConfigurationState

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

val streamKey: String

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

val tags: Map<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.

val userId: 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.

Functions

inline fun copy(block: IngestConfiguration.Builder.() -> Unit = {}): IngestConfiguration

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String