Event Target for Amazon Kinesis
This event Target receives CloudEvents over HTTP and publishes the event to Amazon Kinesis.
Prerequisite(s)
- AWS API key and secret
- ARN for the Kinesis stream
- A Kinesis partition name to publish the events to
Consult the Secrets guide for more information about how to add the AWS API specific secrets.
Deploying an Instance of the Target
Open the Bridge creation screen and add a Target of type Amazon Kinesis
.
In the Target creation form, provide a name for the event Target and add the following information:
- AWS Secret: Reference a TriggerMesh secret containing an AWS API key and Secret as discussed in the prerequisites.
- AWS ARN: The ARN that points to the Amazon Kinesis stream.
- Partition: The Kinesis partition to publish the events to.
There is an optional toggle flag indicating if the full CloudEvent should be sent to Kinesis. By default, this is disabled which means only the event payload will be sent.
After clicking the Save
button, the console will self-navigate to the Bridge editor. Proceed by adding the remaining components to the Bridge.
After submitting the Bridge, and allowing for some configuration time, a green check mark on the main Bridges page indicates that the Bridge with the Amazon Kinesis Target was successfully created.
For more information about using Amazon Kinesis, please refer to the AWS documentation.
Event Types
The Amazon Kinesis event Target leaves the CloudEvent type definition to the discretion of the implementer given the flexible nature of Kinesis.
However, the response CloudEvent would have the following payload:
Name | Value | Description |
---|---|---|
ce-type | io.triggermesh.targets.aws.kinesis.result | Denotes a response payload from Kinesis |
ce-source | arn:aws:kinesis:... |
The Kinesis ARN value as configured by the target |
body | JSON | A JSON response from the Target invocation |