interface CfnStreamProps

Language	Type name
.NET	`Amazon.CDK.AWS.IoT.CfnStreamProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnStreamProps`
Java	`software.amazon.awscdk.services.iot.CfnStreamProps`
Python	`aws_cdk.aws_iot.CfnStreamProps`
TypeScript	`aws-cdk-lib` » `aws_iot` » `CfnStreamProps`

Properties for defining a CfnStream.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cfnStreamProps: iot.CfnStreamProps = {
  files: [{
    fileId: 123,
    s3Location: {
      bucket: 'bucket',
      key: 'key',
      version: 'version',
    },
  }],
  roleArn: 'roleArn',
  streamId: 'streamId',

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
files	`IResolvable` `\| (IResolvable` `\|` `StreamFileProperty)[]`	The files to stream.
roleArn	`string`	An IAM role that allows the IoT service principal to access your S3 files.
streamId	`string`	The stream ID.
description?	`string`	The description of the stream.
tags?	`CfnTag[]`	Metadata which can be used to manage streams.