UNPKG

serverless-sam

Version:

Serverless framework plugin to export AWS SAM templates for a service

github.com/SAPessi/serverless-sam

SAPessi/serverless-sam

105 lines (77 loc) • 3.12 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<!-- title: AWS Node Scheduled Weather example in NodeJS description: This is an example of creating a function that runs as a cron job using the serverless 'schedule' event. It retrieves weather information at 10am (UTC) and emails it to a predefined recipient. layout: Doc --> # AWS Node Scheduled Weather Example This is an example of creating a function that runs as a cron job using the serverless `schedule` event. It retrieves weather information at 10am (UTC) and emails it to a predefined recipient. For more information on `schedule` event check out the Serverless docs on [schedule](https://serverless.com/framework/docs/providers/aws/events/schedule/). ## Cron syntax ```pseudo cron(Minutes Hours Day-of-month Month Day-of-week Year) ``` All fields are required and time zone is UTC only. | Field | Values | Wildcards | | ------------- |:--------------:|:-------------:| | Minutes | 0-59 | , - * / | | Hours | 0-23 | , - * / | | Day-of-month | 1-31 | , - * ? / L W | | Month | 1-12 or JAN-DEC| , - * / | | Day-of-week | 1-7 or SUN-SAT | , - * ? / L # | | Year | 1970-2199 | , - * / | Read the [AWS cron expression syntax](http://docs.aws.amazon.com/lambda/latest/dg/tutorial-scheduled-events-schedule-expressions.html) docs for more info on how to setup cron ## Setup ### DarkSky Please visit https://darksky.net/dev/ to register for a free API token. ### Postmark Please visit https://postmarkapp.com to register for a free Postmark account. ### Configuration Upon setting up access to both external services, you'll be required to update the environment variables in `serverless.yml`: ``` environment: RECIPIENT: tom@carrotcreative.com DARK_SKY_API_KEY: abc123 POSTMARK_API_KEY: abc123 POSTMARK_SENDER: devops@carrotcreative.com LATITUDE: 40.702637 LONGITUDE: -73.989406 ``` ## Deploy In order to deploy the you endpoint simply run ```bash serverless deploy ``` The expected result should be similar to: ```bash Serverless: Packaging service... Serverless: Uploading CloudFormation file to S3... Serverless: Uploading service .zip file to S3 (1.87 MB)... Serverless: Updating Stack... Serverless: Checking Stack update progress... ........... Serverless: Stack update finished... Serverless: Removing old service versions... Service Information service: scheduled-weather-example stage: dev region: us-east-1 api keys: None endpoints: None functions: scheduled-weather-example-dev-weather: arn:aws:lambda:us-east-1:219106525755:function:scheduled-weather-example-dev-weather ``` There is no additional step required. Your defined schedule becomes active right away after deployment. ## Usage To test your function remotely: ```bash sls invoke -f weather ``` The expected result should be similar to: ```json { "success": true } ``` ## Additonal Resources For more information on running cron with Serverless check out the [Tutorial: Serverless Scheduled Tasks](https://parall.ax/blog/view/3202/tutorial-serverless-scheduled-tasks) by Parallax.