Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.Types.FirehoseAction

Description

Synopsis

Documentation

data FirehoseAction Source #

Describes an action that writes data to an Amazon Kinesis Firehose stream.

See: newFirehoseAction smart constructor.

Constructors

FirehoseAction'

Fields

batchMode :: Maybe Bool
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.
separator :: Maybe Text
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).
roleArn :: Text
The IAM role that grants access to the Amazon Kinesis Firehose stream.
deliveryStreamName :: Text
The delivery stream name.

Instances

Instances details

Eq FirehoseAction Source #
Instance details Defined in Amazonka.IoT.Types.FirehoseAction Methods (==) :: FirehoseAction -> FirehoseAction -> Bool # (/=) :: FirehoseAction -> FirehoseAction -> Bool #
Read FirehoseAction Source #
Instance details Defined in Amazonka.IoT.Types.FirehoseAction Methods readsPrec :: Int -> ReadS FirehoseAction # readList :: ReadS [FirehoseAction] # readPrec :: ReadPrec FirehoseAction # readListPrec :: ReadPrec [FirehoseAction] #
Show FirehoseAction Source #
Instance details Defined in Amazonka.IoT.Types.FirehoseAction Methods showsPrec :: Int -> FirehoseAction -> ShowS # show :: FirehoseAction -> String # showList :: [FirehoseAction] -> ShowS #
Generic FirehoseAction Source #
Instance details Defined in Amazonka.IoT.Types.FirehoseAction Associated Types type Rep FirehoseAction :: Type -> Type # Methods from :: FirehoseAction -> Rep FirehoseAction x # to :: Rep FirehoseAction x -> FirehoseAction #
NFData FirehoseAction Source #
Instance details Defined in Amazonka.IoT.Types.FirehoseAction Methods rnf :: FirehoseAction -> () #
Hashable FirehoseAction Source #
Instance details Defined in Amazonka.IoT.Types.FirehoseAction Methods hashWithSalt :: Int -> FirehoseAction -> Int # hash :: FirehoseAction -> Int #
ToJSON FirehoseAction Source #
Instance details Defined in Amazonka.IoT.Types.FirehoseAction Methods toJSON :: FirehoseAction -> Value # toEncoding :: FirehoseAction -> Encoding # toJSONList :: [FirehoseAction] -> Value # toEncodingList :: [FirehoseAction] -> Encoding #
FromJSON FirehoseAction Source #
Instance details Defined in Amazonka.IoT.Types.FirehoseAction Methods parseJSON :: Value -> Parser FirehoseAction # parseJSONList :: Value -> Parser [FirehoseAction] #
type Rep FirehoseAction Source #
Instance details Defined in Amazonka.IoT.Types.FirehoseAction type Rep FirehoseAction = D1 ('MetaData "FirehoseAction" "Amazonka.IoT.Types.FirehoseAction" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "FirehoseAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "batchMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "separator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deliveryStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newFirehoseAction Source #

Arguments

:: Text	`$sel:roleArn:FirehoseAction'`
-> Text	`$sel:deliveryStreamName:FirehoseAction'`
-> FirehoseAction

Create a value of FirehoseAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:batchMode:FirehoseAction', firehoseAction_batchMode - 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.

$sel:separator:FirehoseAction', firehoseAction_separator - 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).

$sel:roleArn:FirehoseAction', firehoseAction_roleArn - The IAM role that grants access to the Amazon Kinesis Firehose stream.

$sel:deliveryStreamName:FirehoseAction', firehoseAction_deliveryStreamName - The delivery stream name.

firehoseAction_batchMode :: Lens' FirehoseAction (Maybe Bool) Source #

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.

firehoseAction_separator :: Lens' FirehoseAction (Maybe Text) Source #

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).

firehoseAction_roleArn :: Lens' FirehoseAction Text Source #

The IAM role that grants access to the Amazon Kinesis Firehose stream.

firehoseAction_deliveryStreamName :: Lens' FirehoseAction Text Source #

The delivery stream name.