interface CfnIngestConfigurationProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Ivs.CfnIngestConfigurationProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsivs#CfnIngestConfigurationProps |
 Java | software.amazon.awscdk.services.ivs.CfnIngestConfigurationProps |
 Python | aws_cdk.aws_ivs.CfnIngestConfigurationProps |
 TypeScript | aws-cdk-lib » aws_ivs » CfnIngestConfigurationProps |
Properties for defining a CfnIngestConfiguration.
Example
// 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
| Name | Type | Description |
|---|---|---|
| ingest | string | Type of ingest protocol that the user employs for broadcasting. |
| insecure | boolean | IResolvable | Whether the channel allows insecure RTMP ingest. |
| name? | string | Ingest name. |
| stage | string | ARN of the stage with which the IngestConfiguration is associated. |
| tags? | Cfn[] | An array of key-value pairs to apply to this resource. |
| user | string | Customer-assigned name to help identify the participant using the IngestConfiguration; |
ingestProtocol?
Type:
string
(optional, default: "RTMPS")
Type of ingest protocol that the user employs for broadcasting.
insecureIngest?
Type:
boolean | IResolvable
(optional, default: false)
Whether the channel allows insecure RTMP ingest.
Default: false .
name?
Type:
string
(optional, default: "-")
Ingest name.
stageArn?
Type:
string
(optional, default: "")
ARN of the stage with which the IngestConfiguration is associated.
tags?
Type:
Cfn[]
(optional)
An array of key-value pairs to apply to this resource.
userId?
Type:
string
(optional)
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.