AWS managedservices documentation change
Summary
Updated documentation to remove redundant 'AWS' prefix from 'CloudFormation' references and adjust phrasing for consistency.
Security assessment
The changes are primarily branding/terminology adjustments (removing 'AWS' from 'AWS CloudFormation'). The security-related content about avoiding embedded credentials and using Secrets Manager was already present and remains unchanged except for the product name. No new security issues or features are introduced.
Diff
diff --git a/managedservices/latest/appguide/cfn-author-templates.md b/managedservices/latest/appguide/cfn-author-templates.md index 0dcae7af5..0f10e8e32 100644 --- a//managedservices/latest/appguide/cfn-author-templates.md +++ b//managedservices/latest/appguide/cfn-author-templates.md @@ -7 +7 @@ Guidelines -# AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations +# CloudFormation Ingest Guidelines, Best Practices, and Limitations @@ -13 +13 @@ For AMS to process your CloudFormation template, there are some guidelines and r -To reduce AWS CloudFormation errors while performing AWS CloudFormation ingest, follow these guidelines: +To reduce CloudFormation errors while performing CloudFormation ingest, follow these guidelines: @@ -15 +15 @@ To reduce AWS CloudFormation errors while performing AWS CloudFormation ingest, - * **Don't embed credentials or other sensitive information in the template** – The CloudFormation template is visible in the AWS CloudFormation console, so you don't want to embed credentials or sensitive data in the template. The template can't contain sensitive information. The following resources are allowed only if you use AWS Secrets Manager for the value: + * **Don't embed credentials or other sensitive information in the template** – The CloudFormation template is visible in the CloudFormation console, so you don't want to embed credentials or sensitive data in the template. The template can't contain sensitive information. The following resources are allowed only if you use AWS Secrets Manager for the value: @@ -39 +39 @@ For information about using an AWS Secrets Manager secret in a resource property - * **Follow AWS CloudFormation guidelines when writing CloudFormation resource templates** – Ensure that you use the right data type/property name for the resource by referring to the _AWS CloudFormation User Guide_ for that resource. For example, the data type of SecurityGroupIds property in an AWS::EC2::Instance resource is 'List of String values', so ["sg-aaaaaaaa"] is ok (with brackets), but "sg-aaaaaaaa" is not (without brackets). + * **Follow CloudFormation guidelines when writing CloudFormation resource templates** – Ensure that you use the right data type/property name for the resource by referring to the _AWS CloudFormation User Guide_ for that resource. For example, the data type of SecurityGroupIds property in an AWS::EC2::Instance resource is 'List of String values', so ["sg-aaaaaaaa"] is ok (with brackets), but "sg-aaaaaaaa" is not (without brackets). @@ -43 +43 @@ For more information, see [AWS Resource and Property Types Reference](https://do - * **Configure your custom CloudFormation templates to use parameters defined in the AMS CloudFormation ingest CT** – When you configure your CloudFormation template to use parameters defined in the AMS CloudFormation ingest CT, you can reuse the CloudFormation template to create similar stacks by submitting it with changed parameter values in the CT input with the Management | Custom stack | Stack from CloudFormation template | Update CT (ct-361tlo1k7339x). For an example, see [AWS CloudFormation Ingest examples: Defining resources](./cfn-ingest-ex-define-resource.html). + * **Configure your custom CloudFormation templates to use parameters defined in the AMS CloudFormation ingest CT** – When you configure your CloudFormation template to use parameters defined in the AMS CloudFormation ingest CT, you can reuse the CloudFormation template to create similar stacks by submitting it with changed parameter values in the CT input with the Management | Custom stack | Stack from CloudFormation template | Update CT (ct-361tlo1k7339x). For an example, see [CloudFormation Ingest examples: Defining resources](./cfn-ingest-ex-define-resource.html). @@ -47 +47 @@ For more information, see [AWS Resource and Property Types Reference](https://do - * **Wait Condition requires signal logic** – Wait Condition is used to coordinate stack resource creation with configuration actions that are external to the stack creation. If you use the Wait Condition resource in the template, AWS CloudFormation waits for a success signal, and it marks stack creation as a failure if the number of success signals aren't made. You need to have a logic for the signal if you use the Wait Condition resource. For more information, see [Creating Wait Conditions in a Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html). + * **Wait Condition requires signal logic** – Wait Condition is used to coordinate stack resource creation with configuration actions that are external to the stack creation. If you use the Wait Condition resource in the template, CloudFormation waits for a success signal, and it marks stack creation as a failure if the number of success signals aren't made. You need to have a logic for the signal if you use the Wait Condition resource. For more information, see [Creating Wait Conditions in a Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html).