Class FirehosePutRecordActionProps
(experimental) Configuration properties of an action for the Kinesis Data Firehose stream.
Inheritance
Namespace: Amazon.CDK.AWS.IoT.Actions.Alpha
Assembly: Amazon.CDK.AWS.IoT.Actions.Alpha.dll
Syntax (csharp)
public class FirehosePutRecordActionProps : Object, IFirehosePutRecordActionProps, ICommonActionProps
Syntax (vb)
Public Class FirehosePutRecordActionProps
Inherits Object
Implements IFirehosePutRecordActionProps, ICommonActionProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.KinesisFirehose.Alpha;
using Amazon.CDK.AWS.KinesisFirehose.Destinations.Alpha;
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
Constructors
FirehosePutRecordActionProps() |
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. |
Role | (experimental) The IAM role that allows access to AWS service. |
Constructors
FirehosePutRecordActionProps()
public FirehosePutRecordActionProps()
Properties
BatchMode
(experimental) Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch
.
public Nullable<bool> BatchMode { get; set; }
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.
public Nullable<FirehoseRecordSeparator> RecordSeparator { get; set; }
Property Value
System.Nullable<FirehoseRecordSeparator>
Remarks
Default: - none -- the stream does not use a separator
Stability: Experimental
Role
(experimental) The IAM role that allows access to AWS service.
public IRole Role { get; set; }
Property Value
Remarks
Default: a new role will be created
Stability: Experimental