Prerequisites
- An Amazon Kinesis data stream carrying the events you want to send to Auxia
- Permission to register a stream consumer, and to attach resource policies to the stream and the consumer
- If the stream is encrypted with a customer-managed key: permission to update the KMS key policy
- An agreed event schema — see Record format and schema
Placeholders used in this guide
Replace these values in every command and policy below:
The Auxia role ARN,
arn:aws:iam::838011126883:role/AuxiaTransferRole, is not a placeholder. Use it as written unless your Auxia solutions engineer gives you a different ARN.
Setup instructions
1
Share your stream details with Auxia
Send these to your Auxia solutions engineer:
2
Register an enhanced fan-out consumer
Register a stream consumer for Auxia. Enhanced fan-out gives Auxia its own read throughput, so its reads don’t compete with your existing consumers.Share the resulting consumer ARN with Auxia. It looks like:
3
Grant the Auxia role read access
You don’t need to create an IAM role. Instead, grant read access to the Auxia-owned role with resource policies on the stream and on the consumer.Attach a resource policy to the stream, so Auxia can list its shards:Attach a resource policy to the consumer, so Auxia can read records:Apply each policy — once for the stream, once for the consumer:
stream-policy.json
consumer-policy.json
4
Grant decrypt access (encrypted streams only)
If your stream uses server-side encryption with a customer-managed key, add the Auxia role to the key policy. Without this, Auxia can connect to the stream but can’t read records.Streams encrypted with the AWS-managed Kinesis key need no extra configuration.
5
Auxia configures ingestion
Auxia creates the import topic and the destination table, then checks end to end that records land correctly. There’s nothing for you to do in this step.