AWS Kinesis rule
Use Ably’s Firehose Kinesis rule to send data such as messages, occupancy, lifecycle and presence events from Ably to Kinesis.
Creating a Kinesis rule
Copied!
There are two ways to create a Kinesis rule:
- Using the Ably Dashboard.
- Using the Control API.
To create a rule in your dashboard:
- Login and select the application you wish to integrate with Kinesis.
- Click the Integrations tab.
- Click the New Integration Rule button.
- Choose Firehose.
- Choose AWS Kinesis.
- Configure the settings applicable to your use case and your Kinesis installation.
- Click Create.
AWS Kinesis rule settings
Copied!
The following explains the AWS Kinesis rule settings:
| Section | Purpose |
|---|---|
| AWS Region | Specifies the AWS region for the Kinesis Stream. |
| Stream Name | Defines the name of the Kinesis Stream to connect to. |
| AWS authentication scheme | Choose the authentication method: AWS credentials or ARN of an assumable role. |
| AWS Credentials | Enter your AWS credentials in `key:value` format. |
| Source | Defines the type of event to deliver. |
| Channel filter | Allows filtering of the rule using a regular expression matching the channel name. |
See some examples of creating rules in the rules section of the Control API documentation. You can also refer to the rule section of the Control API Reference for information on creating a Kinesis rule. You will need to select a ruleType of aws/kinesis.