Interface CfnTopicRule.FirehoseActionProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnTopicRule.FirehoseActionProperty extends
Describes an action that writes data to an Amazon Kinesis Firehose stream.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 FirehoseActionProperty firehoseActionProperty = FirehoseActionProperty.builder()
         // the properties below are optional
  • Method Details

    • getDeliveryStreamName

      @Stability(Stable) @NotNull String getDeliveryStreamName()
      The delivery stream name.
    • getRoleArn

      @Stability(Stable) @NotNull String getRoleArn()
      The IAM role that grants access to the Amazon Kinesis Firehose stream.
    • getBatchMode

      @Stability(Stable) @Nullable default Object getBatchMode()
      Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . The default value is false .

      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.

    • getSeparator

      @Stability(Stable) @Nullable default String getSeparator()
      A character separator that will be used to separate records written to the Firehose stream.

      Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

    • builder

      @Stability(Stable) static CfnTopicRule.FirehoseActionProperty.Builder builder()
      a CfnTopicRule.FirehoseActionProperty.Builder of CfnTopicRule.FirehoseActionProperty