# sam-local-windows-install

> SAM Local Hello World Sample

Latest version **1.0.0** (published 2019-03-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install sam-local-windows-install
pnpm add sam-local-windows-install
yarn add sam-local-windows-install
bun add sam-local-windows-install
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-03-07 |
| First published | 2019-03-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 166 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gary A. Stafford |
| Maintainers | mitesh.chudasama |

## Links

- npm: https://www.npmjs.com/package/sam-local-windows-install
- npm.io page: https://npm.io/package/sam-local-windows-install

## Recent versions

- 1.0.0 (latest) — 2019-03-07

## README

# SAM Local Installation

Install SAM Local on Windows 10 Enterprise. Test SAM Local with a simple Lambda function.

According to [AWS](https://github.com/awslabs/aws-sam-local#sam-local-beta), '_sam is the AWS CLI tool for managing Serverless applications written with AWS Serverless Application Model (SAM). SAM Local can be used to test functions locally, start a local API Gateway from a SAM template, validate a SAM template, and generate sample payloads for various event sources._'

## Install Docker for Windows

SAM Local requires Docker. Link to [Docker for Windows](https://docs.docker.com/docker-for-windows/install/#download-docker-for-windows). Choose the Stable or Edge version of Docker for Windows.

![Docker](install_pics/SAM_Local_01.PNG)

You will need to close and logout.

![Docker](install_pics/SAM_Local_02.PNG)

Windows will ask you to restart to enable Hyper-V and Containers features.

![Docker](install_pics/SAM_Local_03.PNG)

## Install AWS SAM Local

Install `aws-sam-local` npm package globally. Assumes Node.js/npm already installed.

```javascript
npm install -g aws-sam-local
sam --version
```

![Node](install_pics/SAM_Local_07.PNG)

## Sample Lambda Function

Example is a combination of several public AWS samples.

Lambda: `index.js`

```javascript
'use strict';

console.log('Loading function');

exports.handler = (event, context, callback) => {
  console.log('Received event:', JSON.stringify(event, null, 2));
  console.log('value1 =', event.key1);
  console.log('value2 =', event.key2);
  console.log('value3 =', event.key3);
  callback(null, {
    statusCode: 200,
    headers: {
      "x-custom-header": event.key1
    },
    body: event.key2
  });
};
```

Test Event: `event.json`

```json
{
  "key3": "Lambda",
  "key2": "Serverless",
  "key1": "API Gateway"
}
```

SAM Template: `template.yaml`

```yaml
AWSTemplateFormatVersion: '2010-09-09'
Transform: 'AWS::Serverless-2016-10-31'
Description: A starter AWS Lambda function.
Resources:
  helloworld:
    Type: 'AWS::Serverless::Function'
    Properties:
      Handler: index.handler
      Runtime: nodejs6.10
      CodeUri: .
      Description: A starter AWS Lambda function.
      MemorySize: 128
      Timeout: 3
      Events:
        Api:
          Type: Api
          Properties:
            Path: /test
            Method: get
```

### Invoke Lambda with an Event file

To test SAM Local, execute `npm test` or `sam local invoke -e event.json`.

![Node](install_pics/SAM_Local_08.PNG)

The first time you run SAM Local, you will need to share access to your C: drive.

![Docker](install_pics/SAM_Local_06.PNG)

## Deploy API to AWS

Execute the two commands below to deploy of the Lambda function and associated API to AWS, using [SAM](https://docs.aws.amazon.com/lambda/latest/dg/serverless_app.html). Commands require you have sufficient privileges to AWS resources.

These commands will create an S3 bucket (you will need to substitute a unique bucket name for the bucket), API, in the API Gateway, titled `test-api`, matching the CloudFormation stack name. The Lambda will also be created, titled similar to `test-stack-helloworld-1SOIAN9J9EUJS`. The Lambda function will be associated with the `GET` method of the `/test` API endpoint.

```bash
aws s3 mb s3://<unique_bucket_name>

aws cloudformation package \
  --template-file template.yaml \
  --s3-bucket <unique_bucket_name> \
  --output-template-file packaged-template.yaml

aws cloudformation deploy \
  --template-file packaged-template.yaml \
  --stack-name test-api \
  --capabilities CAPABILITY_IAM
```

## SAM Local References

- [SAM Local Requirements](https://docs.aws.amazon.com/lambda/latest/dg/sam-cli-requirements.html)
- [SAM Local Guide](https://github.com/awslabs/aws-sam-local)
- [SAM Node Hello World Sample](https://github.com/awslabs/serverless-application-model/tree/master/examples/apps/hello-world)

---
_Source: https://npm.io/package/sam-local-windows-install · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._