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

Builder

Properties

var arn: String?

Ingest configuration ARN.

var 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.

var ingestProtocol: IngestProtocol?

Type of ingest protocol that the user employs for broadcasting.

var name: String?

Ingest name

var participantId: String?

ID of the participant within the stage.

var stageArn: String?

ARN of the stage with which the IngestConfiguration is associated.

var state: IngestConfigurationState?

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

var streamKey: String?

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

var 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.

var 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.