interface CfnIngestConfigurationMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IVS.Mixins.CfnIngestConfigurationMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsivs/mixins#CfnIngestConfigurationMixinProps
Java	software.amazon.awscdk.mixins.preview.services.ivs.mixins.CfnIngestConfigurationMixinProps
Python	aws_cdk.mixins_preview.aws_ivs.mixins.CfnIngestConfigurationMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_ivs » mixins » CfnIngestConfigurationMixinProps

Properties for CfnIngestConfigurationPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as ivs_mixins } from '@aws-cdk/mixins-preview/aws-ivs';
const cfnIngestConfigurationMixinProps: ivs_mixins.CfnIngestConfigurationMixinProps = {
  ingestProtocol: 'ingestProtocol',
  insecureIngest: false,
  name: 'name',
  stageArn: 'stageArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userId: 'userId',
};

Properties

Name	Type	Description
ingestProtocol?	string	Type of ingest protocol that the user employs for broadcasting.
insecureIngest?	boolean | IResolvable	Whether the channel allows insecure RTMP ingest.
name?	string	Ingest name.
stageArn?	string	ARN of the stage with which the IngestConfiguration is associated.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.
userId?	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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-ingestprotocol

---

insecureIngest?

Type: boolean | IResolvable (optional, default: false)

Whether the channel allows insecure RTMP ingest.

Default: false .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-insecureingest

---

name?

Type: string (optional, default: "-")

Ingest name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-name

---

stageArn?

Type: string (optional, default: "")

ARN of the stage with which the IngestConfiguration is associated.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-stagearn

---

tags?

Type: CfnTag[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-tags

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-ingestconfiguration.html#cfn-ivs-ingestconfiguration-userid