Class CfnTopicRule.FirehoseActionProperty
Describes an action that writes data to an Amazon Kinesis Firehose stream.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class FirehoseActionProperty : Object, CfnTopicRule.IFirehoseActionProperty
Syntax (vb)
Public Class FirehoseActionProperty
Inherits Object
Implements CfnTopicRule.IFirehoseActionProperty
Remarks
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 firehoseActionProperty = new FirehoseActionProperty {
DeliveryStreamName = "deliveryStreamName",
RoleArn = "roleArn",
// the properties below are optional
BatchMode = false,
Separator = "separator"
};
Synopsis
Constructors
FirehoseActionProperty() |
Properties
BatchMode | Whether to deliver the Kinesis Data Firehose stream as a batch by using |
DeliveryStreamName | The delivery stream name. |
RoleArn | The IAM role that grants access to the Amazon Kinesis Firehose stream. |
Separator | A character separator that will be used to separate records written to the Firehose stream. |
Constructors
FirehoseActionProperty()
public FirehoseActionProperty()
Properties
BatchMode
Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch
. The default value is false
.
public object BatchMode { get; set; }
Property Value
System.Object
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.
DeliveryStreamName
The delivery stream name.
public string DeliveryStreamName { get; set; }
Property Value
System.String
Remarks
RoleArn
The IAM role that grants access to the Amazon Kinesis Firehose stream.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
Separator
A character separator that will be used to separate records written to the Firehose stream.
public string Separator { get; set; }
Property Value
System.String
Remarks
Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).