Skip to content

Commit ed2cdd5

Browse files
sanathkrsanathkr
committed
Merge branch 'docs' into origin-master
2 parents 240ea95 + 24ef690 commit ed2cdd5

18 files changed

+975
-1
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
.DS_Store
22
node_modules
3+
docs/website/_build
4+
.vscode
5+
.idea

‎.travis.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ branches:
33
only:
44
- docs
55
- master
6+
7+
# Enable container based builds
8+
sudo: false
9+
language: python
10+
611
install: # Install requirement as "Environment Setup Section"
712
- pip install -r docs/website/requirements.txt
813
script: # build sphinx document

‎docs/api.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Api
2+
===
3+
4+
TBD

‎docs/cloudformation_compatibility.rst‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
CloudFormation Compatibility Section
2+
====================================
3+
4+
.. contents::
5+
6+
SAM is built ontop of CloudFormation Transforms. Therefore, we need to support different CloudFormation Capabilities like: Attributes, Intrinsic functions, etc.
7+
8+
CloudFormation Resources Attributes
9+
10+
======================== ========================
11+
Attribute Name Supported?
12+
======================== ========================
13+
CreationPolicy Not Currently
14+
DeletionPolicy Not Currently
15+
DependsOn `DependsOn Attribute`_
16+
Metadata Not Currently
17+
UpdatePolicy Not Currently
18+
======================== ========================
19+
20+
.. _DependsOn Attribute:
21+
22+
DependsOn Attribute:
23+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24+
25+
.. code:: yaml
26+
27+
LambdaFunction:
28+
DependsOn: SomeOtherResources
29+
Type: AWS::Serverless::Function
30+
...
31+
32+
CloudFormation Intrinsic Funtions
33+
---------------------------------
34+
Currently, we do not support all Intrinsic Functions for all Property Values in `AWS::Serverless::*` resources but is fully available in other CloudFormation resources. Please see below tables for a details on which Intrinsic Functions can be used on a given field.
35+
36+
The Condition Function is not currently supported on any ``AWS::Serverless::*`` Resource type
37+
38+
39+
AWS::Serverless::Function
40+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41+
42+
======================== ================================== ========================
43+
Property Name Intrinsic(s) Supported Reasons
44+
======================== ================================== ========================
45+
Handler All
46+
Runtime All
47+
CodeUri (String - S3Uri) None SAM does not parse any Parameters, which is needed to support Ref
48+
CodeUri (Bucket & Key) All
49+
FunctionName All
50+
Description All
51+
MemorySize All
52+
Timeout All
53+
Role All
54+
Policies All
55+
Environment All
56+
VpcConfig All
57+
Events All
58+
Tags All
59+
Tracing All
60+
KmsKeyArn All
61+
DeadLetterQueue All
62+
DeploymentPreference All
63+
AutoPublishAlias Ref of a CloudFormation Parameter Alias resources created by SAM uses a LocicalId <FunctionLogicalId+AliasName>. So SAM either needs a string for alias name, or a Ref to template Parameter that SAM can resolve into a string.
64+
======================== ================================== ========================
65+
66+
Events Properties
67+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68+
69+
S3
70+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71+
======================== ================================== ========================
72+
Property Name Intrinsic(s) Supported Reasons
73+
======================== ================================== ========================
74+
Bucket All
75+
Events All
76+
Filter All
77+
======================== ================================== ========================
78+
79+
SNS
80+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81+
======================== ================================== ========================
82+
Property Name Intrinsic(s) Supported Reasons
83+
======================== ================================== ========================
84+
Topic All
85+
======================== ================================== ========================
86+
87+
Kinesis
88+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
89+
======================== ================================== ========================
90+
Property Name Intrinsic(s) Supported Reasons
91+
======================== ================================== ========================
92+
Stream All
93+
StartingPosition All
94+
BatchSize All
95+
======================== ================================== ========================
96+
97+
DynamoDB
98+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99+
======================== ================================== ========================
100+
Property Name Intrinsic(s) Supported Reasons
101+
======================== ================================== ========================
102+
Stream All
103+
StartingPosition All
104+
BatchSize All
105+
======================== ================================== ========================
106+
107+
Api
108+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109+
======================== ======================================== ========================
110+
Property Name Intrinsic(s) Supported Reasons
111+
======================== ======================================== ========================
112+
Path None
113+
Method None
114+
RestApiId Ref of a AWS::Serverless::Api Resource Properties in the AWS::Serverless::API are used to construct different attributes, policies, etc. SAM expects a Path and Method to exist as defined by the AWs::Serverless::API Resource definition
115+
======================== ======================================== ========================
116+
117+
Schedule
118+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
119+
======================== ================================== ========================
120+
Property Name Intrinsic(s) Supported Reasons
121+
======================== ================================== ========================
122+
Schedule All
123+
Input All
124+
======================== ================================== ========================
125+
126+
CloudWatchEvent
127+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128+
======================== ================================== ========================
129+
Property Name Intrinsic(s) Supported Reasons
130+
======================== ================================== ========================
131+
Pattern All
132+
Input All
133+
InputPath All
134+
======================== ================================== ========================
135+
136+
IotRule
137+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138+
======================== ================================== ========================
139+
Property Name Intrinsic(s) Supported Reasons
140+
======================== ================================== ========================
141+
Sql All
142+
AwsIotSqlVersion All
143+
======================== ================================== ========================
144+
145+
AlexaSkill
146+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
147+
This event has no Properties
148+
149+
150+
AWS::Serverless::Api
151+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
152+
153+
================================== ======================== ========================
154+
Property Name Intrinsic(s) Supported Reasons
155+
================================== ======================== ========================
156+
Name All
157+
StageName All
158+
DefinitionUri (String - S3URI) None SAM does not parse any Parameters, which is needed to support Ref
159+
DefinitionUri (Bucket & Key) All
160+
DefinitionBody All
161+
CacheClusterEnabled All
162+
CacheClusterSize All
163+
Variables All
164+
================================== ======================== ========================
165+
166+
167+
AWS::Serverless::SimpleTable
168+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
169+
170+
======================== ======================== ========================
171+
Property Name Intrinsic(s) Supported Reasons
172+
======================== ======================== ========================
173+
PrimaryKey None
174+
ProvisionedThroughput None
175+
======================== ======================== ========================

0 commit comments

Comments
 (0)