AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IVS::IngestConfiguration

CfnIngestConfiguration

The `AWS::IVS::IngestConfiguration` resource specifies an ingest protocol to be used for a stage. For more information, see [Stream Ingest](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html) in the *Amazon IVS Real-Time Streaming User Guide* .

Import

import { CfnIngestConfiguration } from 'aws-cdk-lib/aws-ivs';

Or use the module namespace:

import * as ivs from 'aws-cdk-lib/aws-ivs';
// ivs.CfnIngestConfiguration

Properties

Configuration passed to the constructor as CfnIngestConfigurationProps.

ingestProtocolOptional
string

Type of ingest protocol that the user employs for broadcasting.

Default: - "RTMPS"

insecureIngestOptional
boolean | IResolvable

Whether the channel allows insecure RTMP ingest. Default: `false` .

Default: - false

nameOptional
string

Ingest name.

Default: - "-"

stageArnOptional
string

ARN of the stage with which the IngestConfiguration is associated.

Default: - ""

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource.

userIdOptional
string

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.*

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IVS::IngestConfigurationView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-ivs
CFN TypeAWS::IVS::IngestConfiguration
Properties6

Related Constructs

Explore This Service

External Links