Navigation Guide
You are on a type information page within a Client package. Return to the Client landing page

@aws-sdk/client-ivs-realtime

IngestConfigurationSummary Interface

Summary information about an IngestConfiguration.

Name	Type	Details
`arn Required`	`string \| undefined`	Ingest configuration ARN.
`ingestProtocol Required`	`IngestProtocol \| undefined`	Type of ingest protocol that the user employs for broadcasting.
`participantId Required`	`string \| undefined`	ID of the participant within the stage.
`stageArn Required`	`string \| undefined`	ARN of the stage with which the IngestConfiguration is associated.
`state Required`	`IngestConfigurationState \| undefined`	State of the ingest configuration. It is `ACTIVE` if a publisher currently is publishing to the stage associated with the ingest configuration.
`name`	`string \| undefined`	Ingest name.
`userId`	`string \| undefined`	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.

export interface IngestConfigurationSummary