Class CfnStreamProps

Properties for defining a CfnStream.

Inheritance

object

CfnStreamProps

Implements

ICfnStreamProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.IoT

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnStreamProps : ICfnStreamProps

Syntax (vb)

Public Class CfnStreamProps Implements ICfnStreamProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoT;

             var cfnStreamProps = new CfnStreamProps {
                 Files = new [] { new StreamFileProperty {
                     FileId = 123,
                     S3Location = new S3LocationProperty {
                         Bucket = "bucket",
                         Key = "key",
                         Version = "version"
                     }
                 } },
                 RoleArn = "roleArn",
                 StreamId = "streamId",

                 // the properties below are optional
                 Description = "description",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnStreamProps()

Properties for defining a CfnStream.

Properties

Description	The description of the stream.
Files	The files to stream.
RoleArn	An IAM role that allows the IoT service principal to access your S3 files.
StreamId	The stream ID.
Tags	Metadata which can be used to manage streams.

Constructors

CfnStreamProps()

Properties for defining a CfnStream.

public CfnStreamProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoT;

             var cfnStreamProps = new CfnStreamProps {
                 Files = new [] { new StreamFileProperty {
                     FileId = 123,
                     S3Location = new S3LocationProperty {
                         Bucket = "bucket",
                         Key = "key",
                         Version = "version"
                     }
                 } },
                 RoleArn = "roleArn",
                 StreamId = "streamId",

                 // the properties below are optional
                 Description = "description",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

Description

The description of the stream.

public string? Description { get; set; }

Property Value

string

Remarks

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

Files

The files to stream.

public object Files { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnStream.IStreamFileProperty)[]

RoleArn

An IAM role that allows the IoT service principal to access your S3 files.

public string RoleArn { get; set; }

Property Value

string

Remarks

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

StreamId

The stream ID.

public string StreamId { get; set; }