AWS Kinesis Firehose

Discover more about the AWS Kinesis Firehose connector and how to use it on the Digibee Integration Platform.

The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.

AWS Kinesis Firehose produces data to AWS Kinesis Firehose streams using AWS SDK version 2.x.

Parameters

Take a look at the configuration parameters for the connector. Parameters supported by Double Braces expressions are marked with (DB).

General tab

ParameterDescriptionDefault valueData type

Dynamic Account

When active, the connector will use the account dynamically. Otherwise, it will use the account statically.

False

Boolean

Account Name (DB)

The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.

N/A

String

Account

The account used by the connector. It is only available if the Dynamic Account parameter is inactive.

N/A

Account

Stream Name (DB)

Name of the stream.

N/A

String

Fail On Error

If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.

False

Boolean

Optional tab

ParameterDescriptionDefault valueData type

Cbor Enabled

This option will set the CBOR_ENABLED property during the execution.

True

Boolean

Override Endpoint

Set the need for overidding the endpoint. This option needs to be used in combination with the Uri Endpoint Override option.

False

Boolean

Pojo Request

Whether to use a POJO request as body or not.

False

Boolean

Region (DB)

The region in which the Kinesis Firehouse client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

N/A

String

Trust All Certificates

Whether to trust all certificates in case of overriding the endpoint.

False

Boolean

Uri Endpoint Override (DB)

Set the overriding URI endpoint. This option needs to be used in combination with the Override Endpoint option.

N/A

String

Headers tab

ParameterDescriptionDefault valueData type

Record Id (DB)

The record ID, as defined in the Amazon documentation.

N/A

String

Operation (DB)

The operation to perform.

N/A

String

Delivery Stream Name (DB)

The name of the delivery stream.

N/A

String

Documentation tab

ParameterDescriptionDefault valueData type

Documentation

Section for documenting any necessary information about the connector configuration and business rules.

N/A

String

Last updated