docs: add referable properties of sam resources #1468

ShreyaGangishetty · 2020-02-25T18:11:39Z

Issue #, if available:

Description of changes:
Added documentation for referable properties in SAM.

Description of how you validated changes:

Checklist:

make pr passes
Update documentation

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

keetonian · 2020-02-25T18:23:27Z

This is just for referencing other CloudFormation resources that SAM creates, correct? Thank you for including the properties that cause SAM to create these resources.

versions/2016-10-31.md

codecov-io · 2020-02-25T20:56:16Z

Codecov Report

Merging #1468 into develop will increase coverage by <.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #1468      +/-   ##
===========================================
+ Coverage    94.39%   94.39%   +<.01%     
===========================================
  Files           78       78              
  Lines         4709     4714       +5     
  Branches       944      948       +4     
===========================================
+ Hits          4445     4450       +5     
  Misses         121      121              
  Partials       143      143

Impacted Files	Coverage Δ
samtranslator/model/api/api_generator.py	`95.07% <0%> (+0.03%)`	⬆️
samtranslator/model/eventsources/push.py	`90.78% <0%> (+0.03%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 58d1dc2...10db9c0. Read the comment docs.

ShreyaGangishetty · 2020-02-25T21:58:04Z

This is just for referencing other CloudFormation resources that SAM creates, correct? Thank you for including the properties that cause SAM to create these resources.

Yes, this doc is for all referable properties(CFN resources) that SAM creates when SAM resources are defined in the template

versions/2016-10-31.md

alexw91 · 2020-02-27T00:08:33Z

Codecov Report

Merging #1468 into develop will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1468   +/-   ##
========================================
  Coverage    94.39%   94.39%           
========================================
  Files           78       78           
  Lines         4709     4714    +5     
  Branches       944      948    +4     
========================================
+ Hits          4445     4450    +5     
  Misses         121      121           
  Partials       143      143

Impacted Files	Coverage Δ
samtranslator/model/api/api_generator.py	`95.07% <0.00%> (+0.03%)`	⬆️
samtranslator/model/eventsources/push.py	`90.78% <0.00%> (+0.03%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 58d1dc2...0a8e5ec. Read the comment docs.

codecov-io · 2020-02-27T00:08:37Z

Codecov Report

Merging #1468 into develop will increase coverage by <.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #1468      +/-   ##
===========================================
+ Coverage    94.39%   94.39%   +<.01%     
===========================================
  Files           78       78              
  Lines         4709     4714       +5     
  Branches       944      948       +4     
===========================================
+ Hits          4445     4450       +5     
  Misses         121      121              
  Partials       143      143

Impacted Files	Coverage Δ
samtranslator/model/api/api_generator.py	`95.07% <0%> (+0.03%)`	⬆️
samtranslator/model/eventsources/push.py	`90.78% <0%> (+0.03%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 58d1dc2...0a8e5ec. Read the comment docs.

keetonian · 2020-02-27T18:55:35Z

versions/2016-10-31.md

+
+Property Name | Reference | LogicalId | Description
+---|:---:|---|---
+Stage | `restapi-logical-id`.Stage | `restapi-logical-id` `StageName`Stage | SAM generates `AWS::ApiGateway::Stage` resource when `AWS::Serverless::Api` resource is defined. This resource can be referenced in intrinsic function using the resource logical id or `restapi-logical-id`.Stage


Approving, as I believe the information here is correct. However, there is another case for the logical id of the stage, and that is when SAM can't resolve the actual stage name (because it's using intrinsics that SAM can't read).

alexw91 · 2020-02-27T19:41:18Z

Codecov Report

Merging #1468 into develop will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1468   +/-   ##
========================================
  Coverage    94.39%   94.39%           
========================================
  Files           78       78           
  Lines         4709     4714    +5     
  Branches       944      948    +4     
========================================
+ Hits          4445     4450    +5     
  Misses         121      121           
  Partials       143      143

Impacted Files	Coverage Δ
samtranslator/model/sam_resources.py	`94.06% <0.00%> (ø)`	⬆️
samtranslator/model/api/api_generator.py	`95.07% <0.00%> (+0.03%)`	⬆️
samtranslator/model/eventsources/push.py	`90.78% <0.00%> (+0.03%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 58d1dc2...a9a3678. Read the comment docs.

codecov-io · 2020-03-03T19:42:21Z

Codecov Report

Merging #1468 into develop will not change coverage.
The diff coverage is 82.65%.

@@           Coverage Diff            @@
##           develop    #1468   +/-   ##
========================================
  Coverage    94.15%   94.15%           
========================================
  Files           78       78           
  Lines         4789     4789           
  Branches       967      967           
========================================
  Hits          4509     4509           
  Misses         130      130           
  Partials       150      150

Impacted Files	Coverage Δ
samtranslator/plugins/globals/globals.py	`99.05% <ø> (ø)`	⬆️
samtranslator/model/eventsources/push.py	`90.78% <100%> (ø)`	⬆️
samtranslator/model/api/api_generator.py	`95.07% <100%> (ø)`	⬆️
...el/preferences/deployment_preference_collection.py	`91.35% <100%> (ø)`	⬆️
samtranslator/__init__.py	`100% <100%> (ø)`	⬆️
samtranslator/model/intrinsics.py	`95.83% <100%> (ø)`	⬆️
samtranslator/model/sam_resources.py	`94.2% <100%> (ø)`	⬆️
samtranslator/public/intrinsics.py	`100% <100%> (ø)`	⬆️
samtranslator/model/function_policies.py	`100% <100%> (ø)`	⬆️
samtranslator/model/api/http_api_generator.py	`93.19% <68.96%> (ø)`	⬆️
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4b1afc2...f5f567b. Read the comment docs.

alexw91 · 2020-03-03T19:43:33Z

Codecov Report

Merging #1468 into develop will not change coverage by %.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1468   +/-   ##
========================================
  Coverage    94.15%   94.15%           
========================================
  Files           78       78           
  Lines         4789     4789           
  Branches       967      967           
========================================
  Hits          4509     4509           
  Misses         130      130           
  Partials       150      150

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c5221fc...f5f567b. Read the comment docs.

praneetap

This also reminded me to actually make the domainname referable! :D Thanks!

praneetap · 2020-03-03T20:00:14Z

versions/2016-10-31.md

+---|:---:|---|---
+Alias | `function-logical-id`.Alias | `function-logical-id`Alias`alias-name` | SAM generates an `AWS::Lambda::Alias` resource when `AutoPublishAlias` property is set. This resource can be referenced in intrinsic functions by using the resource logical ID or  `function-logical-id`.Alias
+Version | `function-logical-id`.Version | `function-logical-id`Version`sha` | SAM generates an `AWS::Lambda::Version` resource when `AutoPublishAlias` property is set. This resource can be referenced in intrinsic functions by using the resource logical ID or  `function-logical-id`.Version
+Destination (for SNS Topic) | `function-logical-id`.DestinationTopic |`function-logical-id`EventInvokeConfig`OnSuccess/OnFailure`Topic| SAM auto creates an `AWS::SNS::Topic` resource when `Destination` property of `DestinationConfig` property in `EventInvokeConfig` property is not specified. This generated resource can be referenced by using `function-logical-id`.DestinationTopic


I would make the property name DestinationTopic

Thank you, I will update

praneetap · 2020-03-03T20:00:40Z

versions/2016-10-31.md

+Alias | `function-logical-id`.Alias | `function-logical-id`Alias`alias-name` | SAM generates an `AWS::Lambda::Alias` resource when `AutoPublishAlias` property is set. This resource can be referenced in intrinsic functions by using the resource logical ID or  `function-logical-id`.Alias
+Version | `function-logical-id`.Version | `function-logical-id`Version`sha` | SAM generates an `AWS::Lambda::Version` resource when `AutoPublishAlias` property is set. This resource can be referenced in intrinsic functions by using the resource logical ID or  `function-logical-id`.Version
+Destination (for SNS Topic) | `function-logical-id`.DestinationTopic |`function-logical-id`EventInvokeConfig`OnSuccess/OnFailure`Topic| SAM auto creates an `AWS::SNS::Topic` resource when `Destination` property of `DestinationConfig` property in `EventInvokeConfig` property is not specified. This generated resource can be referenced by using `function-logical-id`.DestinationTopic
+Destination (for SQS Queue) | `function-logical-id`.DestinationQueue |`function-logical-id`EventInvokeConfig`OnSuccess/OnFailure`Queue | SAM auto creates an `AWS::SQS::Queue` resource when `Destination` property of `DestinationConfig` property in `EventInvokeConfig` property is not specified. This generated resource can be referenced by using `function-logical-id`.DestinationQueue


PropertyName DestinationQueue

codecov-io · 2020-03-03T22:45:17Z

Codecov Report

Merging #1468 into develop will not change coverage.
The diff coverage is 82.65%.

@@           Coverage Diff            @@
##           develop    #1468   +/-   ##
========================================
  Coverage    94.15%   94.15%           
========================================
  Files           78       78           
  Lines         4789     4789           
  Branches       967      967           
========================================
  Hits          4509     4509           
  Misses         130      130           
  Partials       150      150

Impacted Files	Coverage Δ
samtranslator/plugins/globals/globals.py	`99.05% <ø> (ø)`	⬆️
samtranslator/model/eventsources/push.py	`90.78% <100%> (ø)`	⬆️
samtranslator/model/api/api_generator.py	`95.07% <100%> (ø)`	⬆️
...el/preferences/deployment_preference_collection.py	`91.35% <100%> (ø)`	⬆️
samtranslator/__init__.py	`100% <100%> (ø)`	⬆️
samtranslator/model/intrinsics.py	`95.83% <100%> (ø)`	⬆️
samtranslator/model/sam_resources.py	`94.2% <100%> (ø)`	⬆️
samtranslator/public/intrinsics.py	`100% <100%> (ø)`	⬆️
samtranslator/model/function_policies.py	`100% <100%> (ø)`	⬆️
samtranslator/model/api/http_api_generator.py	`93.19% <68.96%> (ø)`	⬆️
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4b1afc2...b8cc833. Read the comment docs.

smatsumt · 2020-03-18T06:44:46Z

versions/2016-10-31.md

+
+Property Name | Reference | LogicalId | Description
+---|:---:|---|---
+Stage | `restapi-logical-id`.Stage | `restapi-logical-id` `StageName`Stage | SAM generates `AWS::ApiGateway::Stage` resource when `AWS::Serverless::Api` resource is defined. This resource can be referenced in intrinsic function using the resource logical id or `restapi-logical-id`.Stage


As far as I know, Stage LogicalId does not contain StageName, so it will be "restapi-logical-idStage". Please refer #259 (comment)

I'm not sure HTTPApi is same or not.

docs: add referable properties of sam resources

906368b

keetonian reviewed Feb 25, 2020

View reviewed changes

versions/2016-10-31.md Outdated Show resolved Hide resolved

ShreyaGangishetty force-pushed the ref-props branch from 70f0b11 to 20b9d85 Compare February 25, 2020 22:19

docs: fix httpapi stage logical id

cddb69e

ShreyaGangishetty force-pushed the ref-props branch from 20b9d85 to cddb69e Compare February 25, 2020 22:20

docs: fix destination property for sqs and sns

10db9c0

keetonian reviewed Feb 26, 2020

View reviewed changes

versions/2016-10-31.md Outdated Show resolved Hide resolved

keetonian self-assigned this Feb 26, 2020

docs: stage logical id for api

0a8e5ec

Update 2016-10-31.md

a9a3678

keetonian approved these changes Feb 27, 2020

View reviewed changes

keetonian reviewed Feb 27, 2020

View reviewed changes

ShreyaGangishetty requested a review from praneetap February 28, 2020 02:27

ShreyaGangishetty assigned praneetap and unassigned keetonian Feb 28, 2020

Shreya Gangishetty added 2 commits March 3, 2020 11:16

update domainname for httpapi

4b1afc2

merge with develop

f5f567b

praneetap reviewed Mar 3, 2020

View reviewed changes

fix: cr comments

b8cc833

praneetap approved these changes Mar 3, 2020

View reviewed changes

ShreyaGangishetty merged commit f928b4b into aws:develop Mar 3, 2020

ShreyaGangishetty pushed a commit to ShreyaGangishetty/serverless-application-model that referenced this pull request Mar 3, 2020

docs: add referable properties of sam resources (aws#1468)

15d2553

ShreyaGangishetty mentioned this pull request Mar 3, 2020

Release tracker for SAM v1.22.0 release #1486

Closed

smatsumt reviewed Mar 18, 2020

View reviewed changes

jamesiri unassigned praneetap Aug 24, 2020

docs: add referable properties of sam resources #1468

docs: add referable properties of sam resources #1468

Uh oh!

Conversation

ShreyaGangishetty commented Feb 25, 2020

Uh oh!

keetonian commented Feb 25, 2020

Uh oh!

Uh oh!

codecov-io commented Feb 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ShreyaGangishetty commented Feb 25, 2020

Uh oh!

Uh oh!

alexw91 commented Feb 27, 2020

Codecov Report

Uh oh!

codecov-io commented Feb 27, 2020

Codecov Report

Uh oh!

keetonian Feb 27, 2020

Choose a reason for hiding this comment

Uh oh!

alexw91 commented Feb 27, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codecov-io commented Mar 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

alexw91 commented Mar 3, 2020

Codecov Report

Uh oh!

praneetap left a comment

Choose a reason for hiding this comment

Uh oh!

praneetap Mar 3, 2020

Choose a reason for hiding this comment

Uh oh!

ShreyaGangishetty Mar 3, 2020

Choose a reason for hiding this comment

Uh oh!

praneetap Mar 3, 2020

Choose a reason for hiding this comment

Uh oh!

codecov-io commented Mar 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

smatsumt Mar 18, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov-io commented Feb 25, 2020 •

edited

Loading

alexw91 commented Feb 27, 2020 •

edited

Loading

codecov-io commented Mar 3, 2020 •

edited

Loading

codecov-io commented Mar 3, 2020 •

edited

Loading