Parameters default value are missing in the documentation

[barroij]

I'm discoveing aws SAM and CloudFormation, and it seems there is one big thing missing in the reference API documentation : the default values. i.e. the value one parameter is given when optional and not provided.

an example in https://github.com/awsdocs/aws-cloudformation-user-guide/blob/master/doc_source/aws-properties-apigateway-stage-methodsetting.md:
It tells that the CachingEnabled is optional, but does not tell if it set to trueor false if I don't put it in my template.

[dlenski]

Agreed, this is a problem in many parts of the reference documentation.

I just submitted a PR (#767) to add default values for the optional parameters of the AWS Lambda EventSourceMapping.

I had to go through various announcements and examples to find information on the defaults.

[devlinbd2]

I will take care of #767, but this one is API Gateway.

[dlenski]

Thanks for merging #767. I believe this issue was referring to a more general problem in various parts of the documentation… my PR only addressed a small part of it for one service.

[rob3c]

I think this issue should be reopened and made a tracking issue until all default values for all optional parameters for all resource types are documented. This issue is clearly about more than the single example the OP gave or the single fix offered in #767, as mentioned by @dlenski.

I shudder to think at the collective hours spent by all developers world-wide using CloudFormation and independently wasting their time searching for the same basic information that should obviously be provided by AWS here (or, if there's a single source of truth for these values for each resource to avoid sync problems, then the CloudFormation docs should maintain links to that info).

This would seem to be in AWS's best interest, since teams could go to production more quickly - with the corresponding AWS billing increases - instead of working it out for themselves with tiny examples over and over that are probably still in the free tier. Even earning only a dollar more per account that used CloudFormation more efficiently and got to production faster due to better documentation seems like it would justify the resources many times over to make this happen. So frustrating...

[devlinbd2]

If you compare the GitHub version<https://github.com/dlenski/aws-cloudformation-user-guide/blob/master/doc_source/aws-resource-lambda-eventsourcemapping.md> of the CFN user guide with the HTML version<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html>, the HTML version includes the default values in the field descriptions, but the descriptions have been truncated in the GitHub version. Is that intentional? Regards, Barry From: "Robert R." ***@***.***> Reply-To: awsdocs/aws-cloudformation-user-guide ***@***.***> Date: Monday, February 14, 2022 at 9:39 AM To: awsdocs/aws-cloudformation-user-guide ***@***.***> Cc: "Devlin, Barry" ***@***.***>, State change ***@***.***> Subject: Re: [awsdocs/aws-cloudformation-user-guide] Parameters default value are missing in the documentation (#272) I think this issue should be reopened and made a tracking issue until all default values for all optional parameters for all resource types are documented. This issue is clearly about more than the single example the OP gave or the single fix offered in #767<#767>, as mentioned by @dlenski<https://github.com/dlenski>. I shudder to think at the collective hours spent by all developers world-wide using CloudFormation and independently wasting their time searching for the same basic information that should obviously be provided by AWS here (or, if there's a single source of truth for these values for each resource to avoid sync problems, then the CloudFormation docs should maintain links to that info). This would seem to be in AWS's best interest, since teams could go to production more quickly - with the corresponding AWS billing increases - instead of working it out for themselves with tiny examples over and over that are probably still in the free tier. Even earning only a dollar more per account that used CloudFormation more efficiently and got to production faster due to better documentation seems like it would justify the resources many times over to make this happen. So frustrating... — Reply to this email directly, view it on GitHub<#272 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ANCQJ76VB4JJLW7BBYZWATTU3E4YXANCNFSM4GXDOSVQ>. Triage notifications on the go with GitHub Mobile for iOS<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you modified the open/close state.Message ID: ***@***.***>

[mnapoli]

Since this issue was not reopened I have opened #1239