Skip to content
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.

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

Add Documentation page for CloudFormation Compatibility #290

Merged
merged 1 commit into from
Feb 13, 2018

Conversation

jfuss
Copy link
Contributor

@jfuss jfuss commented Feb 7, 2018

No description provided.

@jfuss jfuss requested a review from sanathkr February 7, 2018 16:44
Copy link
Contributor

@sanathkr sanathkr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for doing this. This is an important step forward. I have some minor corrections


CloudFormation Intrinsic Funtions
-------------------
Currently, we do not support all Intrinsic Functions for all Property Values. Please see below tables for a details on which Intrinsic Functions can be used on a given field.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you mention that intrinsics support is partial in AWS::Serverless::* resources, but fully available in other CloudFormation resources

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will update

.. code:: yaml

LambdaFunction:
Condition: SomeCondition
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would skip the example because Conditions is not supported. Examples are useful for things we actually support

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair. Will remove

======================== ======================== ========================
Property Name Intrinsic(s) Supported Reaons
======================== ======================== ========================
Handler Ref Only
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not true. Handler, Runtime, Description, MemorySize, Timeout - We support all intrinsics.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought I tested this, but must have been doing something else. Will update to reflect what is actually supported

KmsKeyArn All
DeadLetterQueue All
DeploymentPreference All
AutoPublishAlias Ref Only
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be precise: Ref of a CloudFormation Parameter
Reason: Alias resource created by SAM uses a LogicalID <FunctionLogicalId+AliasName>. So SAM either needs a string for alias name, or a Ref to template Parameter that SAM can resolve into a string.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

StageName All
DefinitionUri All
DefinitionBody All
CacheClusterEnabled Ref Only
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All for CacheClusterEnabled & CacheClusterSize

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

======================== ======================== ========================
Name All
StageName All
DefinitionUri All
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DefinitionUri also has Bucket/Key variant like CodeUri. Can you mention that as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

This includes Event structure and Resource Properties.
@jfuss
Copy link
Contributor Author

jfuss commented Feb 12, 2018

Updated based on feedback.

Copy link
Contributor

@sanathkr sanathkr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@sanathkr sanathkr merged commit 5355289 into aws:docs Feb 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants