Kinesis trigger#

Reads records from Amazon Kinesis streams.

In this document#

Attributes#

Path Type Description
accessKeyID string Required by AWS Kinesis
secretAccessKey string Required by AWS Kinesis
regionName string Required by AWS Kinesis
streamName string Required by AWS Kinesis
shards string List of shards on which this function receives events

Example#

triggers:
  myKinesisStream:
    kind: kinesis
    attributes:
      accessKeyID: "my-key"
      secretAccessKey: "my-secret"
      regionName: "eu-west-1"
      streamName: "my-stream"
      shards: [shard-0, shard-1, shard-2]

IAM Configuration#

The minimal policy-actions needed for Kinesis trigger to consume messages are:

  • kinesis:GetShardIterator

  • kinesis:GetRecords

  • kinesis:DescribeStream

E.g.:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "VisualEditor0",
      "Effect": "Allow",
      "Action": [
        "kinesis:GetShardIterator",
        "kinesis:GetRecords",
        "kinesis:DescribeStream"
      ],
      "Resource": "arn:aws:kinesis:<region-name>:<user-unique-id>:stream/<specific-stream>"
    }
  ]
}