chore: merge release/v1.10.0 into master

Merge pull request #843 from awslabs/release/v1.10.0

Author: brettstack

.flake8

@@ -1,3 +1,3 @@
 [flake8]
 max-line-length = 120
-ignore = E126
+ignore = E126 F821 W504 W605

DEVELOPMENT_GUIDE.rst

@@ -78,26 +78,26 @@ Profiling
 
 Install snakeviz `pip install snakeviz`
 
-```
-python -m cProfile -o sam_profile_results bin/sam-translate.py translate --input-file=tests/translator/input/alexa_skill.yaml --output-file=cfn-template.json
-snakeviz sam_profile_results
-```
+.. code-block:: shell
+
+   python -m cProfile -o sam_profile_results bin/sam-translate.py translate --input-file=tests/translator/input/alexa_skill.yaml --output-file=cfn-template.json
+   snakeviz sam_profile_results
 
 Verifying transforms
 --------------------
 
 If you make changes to the transformer and want to verify the resulting CloudFormation template works as expected, you can transform your SAM template into a CloudFormation template using the following process:
 
-```shell
-# Optional: You only need to run the package command in certain cases; e.g. when your CodeUri specifies a local path
-# Replace MY_TEMPLATE_PATH with the path to your template and MY_S3_BUCKET with an existing S3 bucket
-aws cloudformation package --template-file MY_TEMPLATE_PATH/template.yaml --output-template-file output-template.yaml --s3-bucket MY_S3_BUCKET
+.. code-block:: shell
+
+   # Optional: You only need to run the package command in certain cases; e.g. when your CodeUri specifies a local path
+   # Replace MY_TEMPLATE_PATH with the path to your template and MY_S3_BUCKET with an existing S3 bucket
+   aws cloudformation package --template-file MY_TEMPLATE_PATH/template.yaml --output-template-file output-template.yaml --s3-bucket MY_S3_BUCKET
 
-# Transform your SAM template into a CloudFormation template
-# Replace "output-template.yaml" if you didn't run the package command above or specified a different path for --output-template-file
-bin/sam-translate.py --input-file=output-template.yaml
+   # Transform your SAM template into a CloudFormation template
+   # Replace "output-template.yaml" if you didn't run the package command above or specified a different path for --output-template-file
+   bin/sam-translate.py --input-file=output-template.yaml
 
-# Deploy your transformed CloudFormation template
-# Replace MY_STACK_NAME with a unique name each time you deploy
-aws cloudformation deploy --template-file cfn-template.json --capabilities CAPABILITY_NAMED_IAM --stack-name MY_STACK_NAME
-```
+   # Deploy your transformed CloudFormation template
+   # Replace MY_STACK_NAME with a unique name each time you deploy
+   aws cloudformation deploy --template-file cfn-template.json --capabilities CAPABILITY_NAMED_IAM --stack-name MY_STACK_NAME

Makefile

@@ -39,6 +39,10 @@ init:
 	$(info [*] Install requirements...)
 	@pip install -r requirements/dev.txt -r requirements/base.txt
 
+flake:
+	$(info [*] Running flake8...)
+	@flake8 samtranslator
+
 test:
 	$(info [*] Run the unit test with minimum code coverage of $(CODE_COVERAGE)%...)
 	@pytest --cov samtranslator --cov-report term-missing --cov-fail-under $(CODE_COVERAGE) tests
@@ -49,7 +53,7 @@ build-docs:
 	@$(MAKE) -C docs/website html
 
 # Command to run everytime you make changes to verify everything works
-dev: test
+dev: flake test
 
 # Verifications to run before sending a pull request
 pr: init dev
@@ -68,4 +72,4 @@ TARGETS
 	build-docs  Generate the documentation.
 	pr          Perform all checks before submitting a Pull Request.
 
-endef
+endef

docs/cloudformation_compatibility.rst

@@ -168,7 +168,9 @@ Variables                           All
 EndpointConfiguration               All
 MethodSettings                      All
 BinaryMediaTypes                    All
+MinimumCompressionSize              All
 Cors                                All
+TracingEnabled                      All
 ================================== ======================== ========================
 
 

docs/globals.rst

@@ -23,9 +23,10 @@ Example:
   Resources:
     HelloWorldFunction:
       Type: AWS::Serverless::Function
-      Environment:
-        Variables:
-          MESSAGE: "Hello From SAM"
+      Properties:
+        Environment:
+          Variables:
+            MESSAGE: "Hello From SAM"
 
     ThumbnailFunction:
       Type: AWS::Serverless::Function
@@ -53,7 +54,6 @@ Currently, the following resources and properties are being supported:
       # Properties of AWS::Serverless::Function
       Handler:
       Runtime:
-      # Specifying CodeUri on Globals is not yet supported by 'CloudFormation package' https://docs.aws.amazon.com/cli/latest/reference/cloudformation/package.html
       CodeUri: 
       DeadLetterQueue:
       Description:
@@ -67,7 +67,8 @@ Currently, the following resources and properties are being supported:
       Layers:
       AutoPublishAlias:
       DeploymentPreference:
-    
+      PermissionsBoundary:
+
     Api:
       # Properties of AWS::Serverless::Api
       # Also works with Implicit APIs
@@ -79,7 +80,11 @@ Currently, the following resources and properties are being supported:
       EndpointConfiguration:
       MethodSettings:
       BinaryMediaTypes:
+      MinimumCompressionSize:
       Cors:
+      AccessLogSetting:
+      CanarySetting:
+      TracingEnabled:
 
     SimpleTable:
       # Properties of AWS::Serverless::SimpleTable

examples/2016-10-31/api_cognito_auth/template.yaml

@@ -40,6 +40,7 @@ Resources:
             RestApiId: !Ref MyApi
             Path: /
             Method: GET
+            # NOTE: This endpoint is publicly accessible
             Auth:
               Authorizer: NONE
         ProxyAny:
@@ -48,6 +49,7 @@ Resources:
             RestApiId: !Ref MyApi
             Path: /{proxy+}
             Method: ANY
+            # NOTE: This endpoint is publicly accessible
             Auth:
               Authorizer: NONE
         GetUsers:
@@ -56,6 +58,7 @@ Resources:
             RestApiId: !Ref MyApi
             Path: /users
             Method: GET
+            # NOTE: This endpoint is publicly accessible
             Auth:
               Authorizer: NONE
         GetUser:
@@ -64,6 +67,7 @@ Resources:
             RestApiId: !Ref MyApi
             Path: /users/{userId}
             Method: GET
+            # NOTE: This endpoint is publicly accessible
             Auth:
               Authorizer: NONE
         CreateUser:

examples/2016-10-31/api_lambda_request_auth/README.md

@@ -6,6 +6,13 @@ The Authorizer Lambda Function in this example simply accepts an `auth` query st
 
 ## Running the example
 
+Optional: Uncomment the following lines in `template.yaml` to enable a publicly accessible endpoint:
+
+```yaml
+# Auth:
+#   Authorizer: NONE
+```
+
 Deploy the example into your account:
 
 ```bash
@@ -15,7 +22,7 @@ aws cloudformation package --template-file template.yaml --output-template-file
 aws cloudformation deploy --template-file ./template.packaged.yaml --stack-name sam-example-api-lambda-request-auth --capabilities CAPABILITY_IAM
 ```
 
-Invoke the API's root endpoint `/` without an `auth` query string to see the API respond with a 200. In the SAM template, we explicitly state `Authorizer: NONE` to make this a public/open endpoint (the Authorizer Lambda Function is not invoked).
+Invoke the API's root endpoint `/` without an `auth` query string to see the API respond with a 200 (assuming you followed the optional step above). In the SAM template, we explicitly state `Authorizer: NONE` to make this a public/open endpoint (the Authorizer Lambda Function is not invoked).
 
 ```bash
 api_url=$(aws cloudformation describe-stacks --stack-name sam-example-api-lambda-request-auth --query 'Stacks[].Outputs[?OutputKey==`ApiURL`].OutputValue' --output text)

examples/2016-10-31/api_lambda_request_auth/template.yaml

@@ -38,8 +38,9 @@ Resources:
             RestApiId: !Ref MyApi
             Path: /
             Method: get
-            Auth:
-              Authorizer: NONE
+            # NOTE: Uncomment the two lines below to make `GET /` publicly accessible
+            # Auth:
+            #   Authorizer: NONE
         GetUsers:
           Type: Api
           Properties:

examples/2016-10-31/api_lambda_token_auth/README.md

@@ -6,6 +6,13 @@ The Authorizer Lambda Function in this example simply accepts an `Authorization`
 
 ## Running the example
 
+Optional: Uncomment the following lines in `template.yaml` to enable a publicly accessible endpoint:
+
+```yaml
+# Auth:
+#   Authorizer: NONE
+```
+
 Deploy the example into your account:
 
 ```bash
@@ -15,7 +22,7 @@ aws cloudformation package --template-file template.yaml --output-template-file
 aws cloudformation deploy --template-file ./template.packaged.yaml --stack-name sam-example-api-lambda-token-auth --capabilities CAPABILITY_IAM
 ```
 
-Invoke the API's root endpoint `/` without an `Authorization` header to see the API respond with a 200. In the SAM template, we explicitly state `Authorizer: NONE` to make this a public/open endpoint (the Authorizer Lambda Function is not invoked).
+Invoke the API's root endpoint `/` without an `Authorization` header to see the API respond with a 200 (assuming you followed the optional step above). In the SAM template, we explicitly state `Authorizer: NONE` to make this a public/open endpoint (the Authorizer Lambda Function is not invoked).
 
 ```bash
 curl "$(aws cloudformation describe-stacks --stack-name sam-example-api-lambda-token-auth --query 'Stacks[].Outputs[?OutputKey==`ApiURL`].OutputValue' --output text)"

examples/2016-10-31/api_lambda_token_auth/template.yaml

@@ -31,8 +31,9 @@ Resources:
             RestApiId: !Ref MyApi
             Path: /
             Method: get
-            Auth:
-              Authorizer: NONE
+            # NOTE: Uncomment the two lines below to make `GET /` publicly accessible
+            # Auth:
+            #   Authorizer: NONE
         GetUsers:
           Type: Api
           Properties: