KinesisReceiver

Using the Amazon Kinesis service, receives data records from an Amazon Kinesis stream.

Usage Notes

The performance of this transformer is dependent on the amount of memory allocated to the Java Virtual Machine (JVM). The following environment variables allow you to specify memory available to Java Plugins:

FME_JVM_MIN_HEAP_SIZE: Initial heap size for initializing the JVM. If unset, the default value is 1024K.

These variables must be set in multiples of 1024 and greater than 1 MB. To indicate kilobytes, megabytes, or gigabytes, append k or K, m or M, or g or G respectively. For example, any of these values is acceptable:

6291456

6144k

FME_JVM_MAX_HEAP_SIZE: Maximum heap size for initializing the JVM. If unset, the default value is 16384K.

These variables must be set in multiples of 1024 and greater than 2 MB. To indicate kilobytes, megabytes, or gigabytes, append k or K, m or M, or g or G respectively. For example, any of these values is acceptable:

83886080

81920k

80m

Note: To pass additional parameters used by FME to the Java Virtual Machine, use the JAVA_TOOL_OPTIONS environment variable.

Configuration

Input Ports

Output Ports

Output

Features containing data records from the specified Amazon Kinesis stream. The content and other details of the data record are stored as attributes of the feature. The following attributes are used:

Attribute	Description
sequence_number	The sequence number of the data record.
partition_key	The partition key of the data record.
data_blob	The data blob of the data record.
shard_id	The id of the shard which contained the data record.

Parameters

Kinesis Stream

Stream	The name of the Kinesis stream from which data records are to be received.
Region	The AWS region in which the Kinesis stream was created.
Access Key	An access key associated with a user with permission to receive data records from the stream.
Secret Access Key	A secret key paired with the access key provided.

Receive Options

Application Name	The name of the application processing the Kinesis stream.
Idle Time Between Reads	The idle time in seconds between reads from the Kinesis stream. Minimum is 0.001 seconds and can be up to 3 decimal spaces.
Max Records per Read	Maximum number of records that can be received from Kinesis stream per read. Maximum is 10,000 data records.

Stopping Condition

Stopping Condition	If None, the receiver runs indefinitely. If Max Polling Time, enter a maximum polling time in seconds in Max Polling Time. If Max Records Output, enter a maximum number of data records to be output in Max Records to Output. If Both, enter values for both Max Polling Time and Max Records to Output. Whichever of these two stopping conditions is met first will cause the receiver to stop reading from the stream.
Max Polling Time	The maximum time in seconds spent receiving no data records from the Kinesis stream. The polling time will start once all shards in the stream have been initialized. Once the maximum polling time has been reached, the receiver will stop reading from the stream. Minimum is 1 second and must be integer values.
Max Records to Output	The maximum number of data records to be output by the transformer. Once the maximum number of records has been output, the receiver will stop reading from the stream.

Editing Transformer Parameters

Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.

Transformer Categories

Integrations

FME Community

The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.

Search for samples and information about this transformer on the FME Community.