CfnIngestConfigurationProps Struct
Properties for defining a CfnIngestConfiguration.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ivs as ivs } from 'aws-cdk-lib';
const cfnIngestConfigurationProps: ivs.CfnIngestConfigurationProps = {
ingestProtocol: 'ingestProtocol',
insecureIngest: false,
name: 'name',
stageArn: 'stageArn',
tags: [{
key: 'key',
value: 'value',
}],
userId: 'userId',
};
Properties
ingestProtocoloptionalstringingest_protocoloptionalstringestProtocoloptionalStringIngestProtocoloptionalstringIngestProtocoloptional*string= "RTMPS"#Type of ingest protocol that the user employs for broadcasting.
insecureIngestoptionalboolean | IResolvableinsecure_ingestoptionaltyping.Union[bool, IResolvable]insecureIngestoptionalBooleanInsecureIngestoptionalboolInsecureIngestoptionalinterface{}= false#Whether the channel allows insecure RTMP ingest.
Default: false .
Ingest name.
stageArnoptionalstringstage_arnoptionalstrstageArnoptionalStringStageArnoptionalstringStageArnoptional*string= ""#ARN of the stage with which the IngestConfiguration is associated.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#An array of key-value pairs to apply to this resource.
userIdoptionalstringuser_idoptionalstruserIdoptionalStringUserIdoptionalstringUserIdoptional*string#Customer-assigned name to help identify the participant using the IngestConfiguration;
notes
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.