Module Values.IngestConfigurationSource

Object specifying an ingest configuration.

Sourcetype nonrec t = {
  1. name : IngestConfigurationName.t option;
    (*

    Ingest name

    *)
  2. arn : IngestConfigurationArn.t option;
    (*

    Ingest configuration ARN.

    *)
  3. ingestProtocol : IngestProtocol.t option;
    (*

    Type of ingest protocol that the user employs for broadcasting.

    *)
  4. streamKey : StreamKey.t option;
    (*

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

    *)
  5. stageArn : IngestConfigurationStageArn.t option;
    (*

    ARN of the stage with which the IngestConfiguration is associated.

    *)
  6. participantId : ParticipantId.t option;
    (*

    ID of the participant within the stage.

    *)
  7. state : IngestConfigurationState.t option;
    (*

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

    *)
  8. userId : UserId.t option;
    (*

    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.

    *)
  9. redundantIngest : RedundantIngest.t option;
    (*

    Indicates whether redundant ingest is enabled for the ingest configuration.

    *)
  10. redundantIngestCredentials : RedundantIngestCredentials.t option;
    (*

    A list of redundant ingest credentials, present only when redundantIngest is set to true. See Redundant Ingest in IVS RTMP Publishing for details.

    *)
  11. attributes : ParticipantAttributes.t option;
    (*

    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.

    *)
  12. tags : Tags.t option;
    (*

    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.

    *)
}
Sourceval make : ?name:??? -> ?arn:??? -> ?ingestProtocol:??? -> ?streamKey:??? -> ?stageArn:??? -> ?participantId:??? -> ?state:??? -> ?userId:??? -> ?redundantIngest:??? -> ?redundantIngestCredentials:??? -> ?attributes:??? -> ?tags:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of RedundantIngest.t | `Enum of string | `List of [> `Structure of (string * [> `String of ParticipantId.t ]) list ] list | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of IngestConfigurationName.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t