Skip to content

docs: small fix, grammar and readability improvement in globals.rst #504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 16, 2018
+26 −14
Merged

docs: small fix, grammar and readability improvement in globals.rst #504

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
656eb45
Update Maps section in globals to improve grammar and readability
Jul 9, 2018
0034ba2
Update Lists section in globals to improve grammar and readability
Jul 9, 2018
c06d396
Remove outdated reference to supported resources section in globals
Jul 9, 2018
381bcf0
Wrap JSON attributes in double quotes
Jul 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 26 additions & 14 deletions docs/globals.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,15 @@ In the above example, both ``HelloWorldFunction`` and ``ThumbnailFunction`` will
timeout and index.handler Handler. ``HelloWorldFunction`` adds MESSAGE environment variable in addition to the
inherited TABLE_NAME. ``ThumbnailFunction`` inherits all the Globals properties and adds an API Event source.

Supported Resources
-------------------
Properties of ``AWS::Serverless::Function`` and ``AWS::Serverless::Api`` are only supported in Globals section
presently.
Supported Resources and Properties
----------------------------------
Currently, the following resources and properties are being supported:

.. code:: yaml

Globals:
Function:
# Some properties of AWS::Serverless::Function
# Properties of AWS::Serverless::Function
Handler:
Runtime:
CodeUri:
Expand All @@ -68,7 +67,7 @@ presently.
DeploymentPreference:

Api:
# Some properties of AWS::Serverless::Api
# Properties of AWS::Serverless::Api
# Also works with Implicit APIs
Name:
DefinitionUri:
Expand All @@ -81,6 +80,7 @@ presently.
Cors:

SimpleTable:
# Properties of AWS::Serverless::SimpleTable
SSESpecification

Implicit APIs
Expand Down Expand Up @@ -143,20 +143,19 @@ Runtime of ``MyFunction`` will be set to python3.6

Maps are merged
~~~~~~~~~~~~~~~
*Also called as dictionaries, or key/value pairs*
*Maps are also known as dictionaries or collections of key/value pairs*

Map value in the resource will be **merged** with the map value from Global.
Map entries in the resource will be **merged** with global map entries. In case of duplicates the resource entry will override the global entry.

Example:

Environment variables of ``MyFunction`` will be set to ``{ TABLE_NAME: "resource-table", "NEW_VAR": "hello" }``

.. code:: yaml

Globals:
Function:
Environment:
Variables:
STAGE: Production
TABLE_NAME: global-table

Resources:
Expand All @@ -168,16 +167,24 @@ Environment variables of ``MyFunction`` will be set to ``{ TABLE_NAME: "resource
TABLE_NAME: resource-table
NEW_VAR: hello

In the above example the environment variables of ``MyFunction`` will be set to:

.. code:: json

{
"STAGE": "Production",
"TABLE_NAME": "resource-table",
"NEW_VAR": "hello"
}

Lists are additive
~~~~~~~~~~~~~~~~~~~
*Also called as arrays*
*Lists are also known as arrays*

List values in the resource will be **appended** with the map value from Global.
List entries in the resource will be **appended** to the global entries.

Example:

SecurityGroupIds of VpcConfig will be set to ``["sg-first", "sg-123", "sg-456"]``

.. code:: yaml

Globals:
Expand All @@ -195,3 +202,8 @@ SecurityGroupIds of VpcConfig will be set to ``["sg-first", "sg-123", "sg-456"]`
SecurityGroupIds:
- sg-first

In the above example the Security Group Ids of ``MyFunction``'s VPC Config will be set to:

.. code:: json

[ "sg-123", "sg-456", "sg-first" ]