IngestConfiguration

Object specifying an ingest configuration.

arn

Ingest configuration ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:ingest-configuration/[a-zA-Z0-9-]+

Required: Yes

ingestProtocol

Type of ingest protocol that the user employs for broadcasting.

Type: String

Valid Values: RTMP | RTMPS

Required: Yes

participantId

ID of the participant within the stage.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: [a-zA-Z0-9-]*

Required: Yes

stageArn

ARN of the stage with which the IngestConfiguration is associated.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: ^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$

Required: Yes

state

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

Type: String

Valid Values: ACTIVE | INACTIVE

Required: Yes

streamKey

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

Type: String

Pattern: rt_[0-9]+_[a-z0-9-]+_[a-zA-Z0-9-]+_.+

Required: Yes

attributes

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.

Type: String to string map

Required: No

name

Ingest name

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9-_]*

Required: No

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.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Required: No

IngestConfiguration

Contents

See Also