AWS SDK for C++  1.9.158
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::FirehoseAction Class Reference

#include <FirehoseAction.h>

Public Member Functions

 FirehoseAction ()
 
 FirehoseAction (Aws::Utils::Json::JsonView jsonValue)
 
FirehoseActionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
FirehoseActionWithRoleArn (const Aws::String &value)
 
FirehoseActionWithRoleArn (Aws::String &&value)
 
FirehoseActionWithRoleArn (const char *value)
 
const Aws::StringGetDeliveryStreamName () const
 
bool DeliveryStreamNameHasBeenSet () const
 
void SetDeliveryStreamName (const Aws::String &value)
 
void SetDeliveryStreamName (Aws::String &&value)
 
void SetDeliveryStreamName (const char *value)
 
FirehoseActionWithDeliveryStreamName (const Aws::String &value)
 
FirehoseActionWithDeliveryStreamName (Aws::String &&value)
 
FirehoseActionWithDeliveryStreamName (const char *value)
 
const Aws::StringGetSeparator () const
 
bool SeparatorHasBeenSet () const
 
void SetSeparator (const Aws::String &value)
 
void SetSeparator (Aws::String &&value)
 
void SetSeparator (const char *value)
 
FirehoseActionWithSeparator (const Aws::String &value)
 
FirehoseActionWithSeparator (Aws::String &&value)
 
FirehoseActionWithSeparator (const char *value)
 
bool GetBatchMode () const
 
bool BatchModeHasBeenSet () const
 
void SetBatchMode (bool value)
 
FirehoseActionWithBatchMode (bool value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 32 of file FirehoseAction.h.

Constructor & Destructor Documentation

◆ FirehoseAction() [1/2]

Aws::IoT::Model::FirehoseAction::FirehoseAction ( )

◆ FirehoseAction() [2/2]

Aws::IoT::Model::FirehoseAction::FirehoseAction ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BatchModeHasBeenSet()

bool Aws::IoT::Model::FirehoseAction::BatchModeHasBeenSet ( ) const
inline

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.

Definition at line 202 of file FirehoseAction.h.

◆ DeliveryStreamNameHasBeenSet()

bool Aws::IoT::Model::FirehoseAction::DeliveryStreamNameHasBeenSet ( ) const
inline

The delivery stream name.

Definition at line 90 of file FirehoseAction.h.

◆ GetBatchMode()

bool Aws::IoT::Model::FirehoseAction::GetBatchMode ( ) const
inline

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.

Definition at line 190 of file FirehoseAction.h.

◆ GetDeliveryStreamName()

const Aws::String& Aws::IoT::Model::FirehoseAction::GetDeliveryStreamName ( ) const
inline

The delivery stream name.

Definition at line 85 of file FirehoseAction.h.

◆ GetRoleArn()

const Aws::String& Aws::IoT::Model::FirehoseAction::GetRoleArn ( ) const
inline

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

Definition at line 44 of file FirehoseAction.h.

◆ GetSeparator()

const Aws::String& Aws::IoT::Model::FirehoseAction::GetSeparator ( ) const
inline

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

Definition at line 128 of file FirehoseAction.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::FirehoseAction::Jsonize ( ) const

◆ operator=()

FirehoseAction& Aws::IoT::Model::FirehoseAction::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

bool Aws::IoT::Model::FirehoseAction::RoleArnHasBeenSet ( ) const
inline

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

Definition at line 49 of file FirehoseAction.h.

◆ SeparatorHasBeenSet()

bool Aws::IoT::Model::FirehoseAction::SeparatorHasBeenSet ( ) const
inline

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

Definition at line 135 of file FirehoseAction.h.

◆ SetBatchMode()

void Aws::IoT::Model::FirehoseAction::SetBatchMode ( bool  value)
inline

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.

Definition at line 214 of file FirehoseAction.h.

◆ SetDeliveryStreamName() [1/3]

void Aws::IoT::Model::FirehoseAction::SetDeliveryStreamName ( Aws::String &&  value)
inline

The delivery stream name.

Definition at line 100 of file FirehoseAction.h.

◆ SetDeliveryStreamName() [2/3]

void Aws::IoT::Model::FirehoseAction::SetDeliveryStreamName ( const Aws::String value)
inline

The delivery stream name.

Definition at line 95 of file FirehoseAction.h.

◆ SetDeliveryStreamName() [3/3]

void Aws::IoT::Model::FirehoseAction::SetDeliveryStreamName ( const char *  value)
inline

The delivery stream name.

Definition at line 105 of file FirehoseAction.h.

◆ SetRoleArn() [1/3]

void Aws::IoT::Model::FirehoseAction::SetRoleArn ( Aws::String &&  value)
inline

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

Definition at line 59 of file FirehoseAction.h.

◆ SetRoleArn() [2/3]

void Aws::IoT::Model::FirehoseAction::SetRoleArn ( const Aws::String value)
inline

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

Definition at line 54 of file FirehoseAction.h.

◆ SetRoleArn() [3/3]

void Aws::IoT::Model::FirehoseAction::SetRoleArn ( const char *  value)
inline

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

Definition at line 64 of file FirehoseAction.h.

◆ SetSeparator() [1/3]

void Aws::IoT::Model::FirehoseAction::SetSeparator ( Aws::String &&  value)
inline

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

Definition at line 149 of file FirehoseAction.h.

◆ SetSeparator() [2/3]

void Aws::IoT::Model::FirehoseAction::SetSeparator ( const Aws::String value)
inline

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

Definition at line 142 of file FirehoseAction.h.

◆ SetSeparator() [3/3]

void Aws::IoT::Model::FirehoseAction::SetSeparator ( const char *  value)
inline

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

Definition at line 156 of file FirehoseAction.h.

◆ WithBatchMode()

FirehoseAction& Aws::IoT::Model::FirehoseAction::WithBatchMode ( bool  value)
inline

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.

Definition at line 226 of file FirehoseAction.h.

◆ WithDeliveryStreamName() [1/3]

FirehoseAction& Aws::IoT::Model::FirehoseAction::WithDeliveryStreamName ( Aws::String &&  value)
inline

The delivery stream name.

Definition at line 115 of file FirehoseAction.h.

◆ WithDeliveryStreamName() [2/3]

FirehoseAction& Aws::IoT::Model::FirehoseAction::WithDeliveryStreamName ( const Aws::String value)
inline

The delivery stream name.

Definition at line 110 of file FirehoseAction.h.

◆ WithDeliveryStreamName() [3/3]

FirehoseAction& Aws::IoT::Model::FirehoseAction::WithDeliveryStreamName ( const char *  value)
inline

The delivery stream name.

Definition at line 120 of file FirehoseAction.h.

◆ WithRoleArn() [1/3]

FirehoseAction& Aws::IoT::Model::FirehoseAction::WithRoleArn ( Aws::String &&  value)
inline

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

Definition at line 74 of file FirehoseAction.h.

◆ WithRoleArn() [2/3]

FirehoseAction& Aws::IoT::Model::FirehoseAction::WithRoleArn ( const Aws::String value)
inline

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

Definition at line 69 of file FirehoseAction.h.

◆ WithRoleArn() [3/3]

FirehoseAction& Aws::IoT::Model::FirehoseAction::WithRoleArn ( const char *  value)
inline

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

Definition at line 79 of file FirehoseAction.h.

◆ WithSeparator() [1/3]

FirehoseAction& Aws::IoT::Model::FirehoseAction::WithSeparator ( Aws::String &&  value)
inline

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

Definition at line 170 of file FirehoseAction.h.

◆ WithSeparator() [2/3]

FirehoseAction& Aws::IoT::Model::FirehoseAction::WithSeparator ( const Aws::String value)
inline

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

Definition at line 163 of file FirehoseAction.h.

◆ WithSeparator() [3/3]

FirehoseAction& Aws::IoT::Model::FirehoseAction::WithSeparator ( const char *  value)
inline

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

Definition at line 177 of file FirehoseAction.h.


The documentation for this class was generated from the following file: