Skip to content

Commit 4cc57bb

Browse files
author
Jude
committed
Update README.md with sample Kinesis subscription
1 parent 0776975 commit 4cc57bb

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ function inside a specific VPC, make sure you set up the role correctly to allow
2626

2727
Note also the `ignore` entry is an array of regular expression strings
2828
used to match against the relative paths - be careful to quote accordingly.
29-
For example, a traditional `*.txt` "glob" is matched by the JSON string:
29+
For example, a traditional `*.txt` "glob" is matched by the JSON string:
3030
`".*\\.txt$"` (or just `"\\.txt$"`).
3131

3232
Example `lambda.json` file:
@@ -57,6 +57,30 @@ Example `lambda.json` file:
5757
}
5858
```
5959

60+
You can also optionally setup a subscription to a Kinesis stream for your
61+
lambda using the `subscription` field as in the following sample configuration.
62+
63+
```json
64+
{
65+
"name": "myFunction",
66+
"description": "It does things",
67+
"region": "us-east-1",
68+
"runtime": "python2.7",
69+
"handler": "function.lambda_handler",
70+
"role": "arn:aws:iam::00000000000:role/lambda_basic_execution",
71+
"requirements": ["pygithub"],
72+
"timeout": 30,
73+
"memory": 512,
74+
"subscription": {
75+
"kinesis": {
76+
"stream": "arn:aws:kinesis:eu-west-1:000000000000:stream/services",
77+
"batch_size": 10
78+
}
79+
}
80+
}
81+
```
82+
83+
6084
### Command Line Usage
6185
To package and upload simply run the command from within your lambda directory or
6286
with the directory as an option.

0 commit comments

Comments
 (0)