Interface IFirehosePutRecordActionProps
(experimental) Configuration properties of an action for the Kinesis Data Firehose stream.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT.Actions
Assembly: Amazon.CDK.AWS.IoT.Actions.dll
Syntax (csharp)
public interface IFirehosePutRecordActionProps : ICommonActionProps
Syntax (vb)
Public Interface IFirehosePutRecordActionProps
Inherits ICommonActionProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.KinesisFirehose;
using Amazon.CDK.AWS.KinesisFirehose.Destinations;
var bucket = new Bucket(this, "MyBucket");
var stream = new DeliveryStream(this, "MyStream", new DeliveryStreamProps {
Destinations = new [] { new S3Bucket(bucket) }
});
var topicRule = new TopicRule(this, "TopicRule", new TopicRuleProps {
Sql = IotSql.FromStringAsVer20160323("SELECT * FROM 'device/+/data'"),
Actions = new [] {
new FirehosePutRecordAction(stream, new FirehosePutRecordActionProps {
BatchMode = true,
RecordSeparator = FirehoseRecordSeparator.NEWLINE
}) }
});
Synopsis
Properties
BatchMode | (experimental) Whether to deliver the Kinesis Data Firehose stream as a batch by using |
RecordSeparator | (experimental) A character separator that will be used to separate records written to the Kinesis Data Firehose stream. |
Properties
BatchMode
(experimental) Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch
.
virtual Nullable<bool> BatchMode { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch request. The resulting array can't have more than 500 records.
Default: false
Stability: Experimental
RecordSeparator
(experimental) A character separator that will be used to separate records written to the Kinesis Data Firehose stream.
virtual Nullable<FirehoseRecordSeparator> RecordSeparator { get; }
Property Value
System.Nullable<FirehoseRecordSeparator>
Remarks
Default: - none -- the stream does not use a separator
Stability: Experimental