# CfnIngestConfigurationProps

Properties for defining a `CfnIngestConfiguration`.

Extends: CfnIngestConfigurationProps
Used as props by: CfnIngestConfiguration

- Source: Generated code
- Type last changed: v2.169.0 · 21 Nov 2024

## 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

- `ingestProtocol`: string = "RTMPS" — Type of ingest protocol that the user employs for broadcasting.

- `insecureIngest`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) = false — Whether the channel allows insecure RTMP ingest.

  Default: `false` .

- `name`: string = "-" — Ingest name.

- `stageArn`: string = "" — ARN of the stage with which the IngestConfiguration is associated.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An array of key-value pairs to apply to this resource.

- `userId`: 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.*