Skip to content

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

Description

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

Usage

ivsrealtime_create_ingest_configuration(name, stageArn, userId,
  attributes, ingestProtocol, insecureIngest, redundantIngest, tags)

Arguments

  • name

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

  • stageArn

    ARN of the stage with which the IngestConfiguration is associated.

  • userId

    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.

  • attributes

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

  • ingestProtocol

    [required] Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

  • insecureIngest

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

  • redundantIngest

    Indicates whether redundant ingest is enabled for the ingest configuration. Default: false.

  • tags

    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.

Value

A list with the following syntax:

list(
  accessControlAllowOrigin = "string",
  accessControlExposeHeaders = "string",
  cacheControl = "string",
  contentSecurityPolicy = "string",
  strictTransportSecurity = "string",
  xContentTypeOptions = "string",
  xFrameOptions = "string",
  ingestConfiguration = list(
    name = "string",
    arn = "string",
    ingestProtocol = "RTMP"|"RTMPS",
    streamKey = "string",
    stageArn = "string",
    participantId = "string",
    state = "ACTIVE"|"INACTIVE",
    userId = "string",
    redundantIngest = TRUE|FALSE,
    redundantIngestCredentials = list(
      list(
        participantId = "string",
        streamKey = "string"
      )
    ),
    attributes = list(
      "string"
    ),
    tags = list(
      "string"
    )
  )
)

Request syntax

svc$create_ingest_configuration(
  name = "string",
  stageArn = "string",
  userId = "string",
  attributes = list(
    "string"
  ),
  ingestProtocol = "RTMP"|"RTMPS",
  insecureIngest = TRUE|FALSE,
  redundantIngest = TRUE|FALSE,
  tags = list(
    "string"
  )
)