The Kinesis target service requires the stream name, a partition key, and the security credentials for the user you created in AWS IAM. The Kinesis target service implements the asynchronous client for accessing Amazon Kinesis.
A Kinesis target service uses a bounded queue and a fixed-size thread pool to write data to the Kinesis stream. The length of the queue and the size of the thread pool determine the throughput of the target service. You can configure the length of the queue and the size of the thread pool to control the throughput.
For more information about the thread pool size and queue length, see the Oracle Java ThreadPoolExecutor documentation.
You can configure the following properties for the Kinesis target service type:
Entity Name
Name of the Kinesis target service. Maximum length is 32 characters.
Description
Description of the target service. Maximum length is 256 characters.
Access Key ID
Access key ID that the AWS IAM service generates when you create a user.
Secret Access Key
Secret access key that the AWS IAM service generates when you create a user.
Stream Name
Name of the Kinesis stream to which to write data.
Region Code
Region where the endpoint for your service is available. For example: us-east-2
Thread Count
Optional. Number of threads in the thread pool. Default is 5. You can change the thread count if you want additional parallel requests.
This parameter initializes the
ExecutorService
in the Kinesis client.
Queue Length
Optional. The length of the queue that the target service uses. Default is 10000.
This parameter initializes the
ExecutorService
in the Kinesis client.
Partition Key Name
Optional. Name of the partition key in the message header. You can select the following partition keys:
IP Address. To use the built-in IP address message header, choose
IP Address
.
Custom Partition Key. To enter the name of a custom message header, choose
Custom Partition Key
.
Dynamic Partition Key. If you want the target service to generate and use a random partition key, choose
Dynamic Partition Key
. If you select this option, all the shards in the stream are utilized.
Default is
Dynamic Partition Key
.
Custom Partition Key Name
Name of the custom message header to use as the partition key. Required if you choose to use a custom IP address message header as the partition key.
Retry on Failure
Indicates that the target service should try to write to the target if the operation fails the first time.
Number of Retries
The number of times the target service should retry to write to the source.
Delay between Retries
Time in milliseconds between successive retries.
Statistics
You can monitor the following statistics:
Bytes Received. The number of bytes the target service receives.
Events Received. The number of events the target service receives.
Failed events. The number of failed events.
Receive Rate (Per Sec). The number of bytes the target service receives every second.
Events Reassigned. The number messages that the source service resends to the target service when it has not received acknowledgment from the target service.