Amazonka.IoTEvents.Types.FirehoseAction

Documentation

data FirehoseAction

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

See: newFirehoseAction smart constructor.

Constructors

FirehoseAction'

Fields

• payload :: Maybe Payload

  You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.

• separator :: Maybe Text

  A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

• deliveryStreamName :: Text

  The name of the Kinesis Data Firehose delivery stream where the data is written.

Instances

FromJSON FirehoseAction

Defined in Amazonka.IoTEvents.Types.FirehoseAction

Methods

parseJSON :: Value -> Parser FirehoseAction

parseJSONList :: Value -> Parser [FirehoseAction]

ToJSON FirehoseAction

Defined in Amazonka.IoTEvents.Types.FirehoseAction

Methods

toJSON :: FirehoseAction -> Value

toEncoding :: FirehoseAction -> Encoding

toJSONList :: [FirehoseAction] -> Value

toEncodingList :: [FirehoseAction] -> Encoding

Generic FirehoseAction

Defined in Amazonka.IoTEvents.Types.FirehoseAction

Associated Types

type Rep FirehoseAction :: Type -> Type

Methods

from :: FirehoseAction -> Rep FirehoseAction x

to :: Rep FirehoseAction x -> FirehoseAction

Read FirehoseAction

Defined in Amazonka.IoTEvents.Types.FirehoseAction

Methods

readsPrec :: Int -> ReadS FirehoseAction

readList :: ReadS [FirehoseAction]

readPrec :: ReadPrec FirehoseAction

readListPrec :: ReadPrec [FirehoseAction]

Show FirehoseAction

Defined in Amazonka.IoTEvents.Types.FirehoseAction

Methods

showsPrec :: Int -> FirehoseAction -> ShowS

show :: FirehoseAction -> String

showList :: [FirehoseAction] -> ShowS

NFData FirehoseAction

Defined in Amazonka.IoTEvents.Types.FirehoseAction

Methods

rnf :: FirehoseAction -> ()

Eq FirehoseAction

Defined in Amazonka.IoTEvents.Types.FirehoseAction

Methods

(==) :: FirehoseAction -> FirehoseAction -> Bool

(/=) :: FirehoseAction -> FirehoseAction -> Bool

Hashable FirehoseAction

Defined in Amazonka.IoTEvents.Types.FirehoseAction

Methods

hashWithSalt :: Int -> FirehoseAction -> Int

hash :: FirehoseAction -> Int

type Rep FirehoseAction

Defined in Amazonka.IoTEvents.Types.FirehoseAction

type Rep FirehoseAction = D1 ('MetaData "FirehoseAction" "Amazonka.IoTEvents.Types.FirehoseAction" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "FirehoseAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Payload)) :*: (S1 ('MetaSel ('Just "separator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deliveryStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newFirehoseAction

Arguments

:: 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:payload:FirehoseAction', firehoseAction_payload - You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.

$sel:separator:FirehoseAction', firehoseAction_separator - A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

$sel:deliveryStreamName:FirehoseAction', firehoseAction_deliveryStreamName - The name of the Kinesis Data Firehose delivery stream where the data is written.

firehoseAction_payload :: Lens' FirehoseAction (Maybe Payload)

You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.

firehoseAction_separator :: Lens' FirehoseAction (Maybe Text)

A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

firehoseAction_deliveryStreamName :: Lens' FirehoseAction Text

The name of the Kinesis Data Firehose delivery stream where the data is written.