v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1439243197.0 KB

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

post/CreateIngestConfiguration

Request body

namestring

Optional name that can be specified for the IngestConfiguration being created.

stageArnstring

ARN of the stage with which the IngestConfiguration is associated.

userIdstring

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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>

attributesobject

Application-provided attributes 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. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>

ingestProtocol'RTMP' | 'RTMPS' required

Type of ingest protocol that the user employs to broadcast. If this is set to <code>RTMP</code>, <code>insecureIngest</code> must be set to <code>true</code>.

insecureIngestboolean

Whether the stage allows insecure RTMP ingest. This must be set to <code>true</code>, if <code>ingestProtocol</code> is set to <code>RTMP</code>. Default: <code>false</code>.

redundantIngestboolean

Indicates whether redundant ingest is enabled for the ingest configuration. Default: <code>false</code>.

tagsobject

Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag Editor</i> 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.

Response

Success