CfnStreamProps
- class aws_cdk.aws_iot.CfnStreamProps(*, files, role_arn, stream_id, description=None, tags=None)
Bases:
objectProperties for defining a
CfnStream.- Parameters:
files (
Union[IResolvable,Sequence[Union[IResolvable,StreamFileProperty,Dict[str,Any]]]]) – The files to stream.role_arn (
str) – An IAM role that allows the IoT service principal to access your S3 files.stream_id (
str) – The stream ID.description (
Optional[str]) – The description of the stream.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – Metadata which can be used to manage streams.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-stream.html
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import CfnTag # The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_iot as iot cfn_stream_props = iot.CfnStreamProps( files=[iot.CfnStream.StreamFileProperty( file_id=123, s3_location=iot.CfnStream.S3LocationProperty( bucket="bucket", key="key", version="version" ) )], role_arn="roleArn", stream_id="streamId", # the properties below are optional description="description", tags=[CfnTag( key="key", value="value" )] )
Attributes
- description
The description of the stream.
- files
The files to stream.
- role_arn
An IAM role that allows the IoT service principal to access your S3 files.
- stream_id
The stream ID.
- tags
Metadata which can be used to manage streams.