AWS prescriptive-guidance documentation change
Summary
Updated documentation links and formatting: corrected CloudFormation API URL, fixed markdown bold formatting in bullet points, updated drift detection link URL and anchor text, changed section header from 'Next steps' to 'FAQ'.
Security assessment
Changes involve URL updates, markdown formatting corrections, and section header renaming. No security vulnerabilities are addressed, no new security guidance is added, and existing security recommendations remain unchanged.
Diff
diff --git a/prescriptive-guidance/latest/iac-edp-combo-approach/best-practices.md b/prescriptive-guidance/latest/iac-edp-combo-approach/best-practices.md index 72c6f350e..2c2962596 100644 --- a//prescriptive-guidance/latest/iac-edp-combo-approach/best-practices.md +++ b//prescriptive-guidance/latest/iac-edp-combo-approach/best-practices.md @@ -11 +11 @@ To use IaC and EDP together in a way that's compatible, secure, and mutually ben - * **Avoid making API calls directly on a resource –** Use the CloudFormation [update-stack](https://docs.aws.amazon.com//cli/latest/reference/cloudformation/update-stack.html) API call as part of an EDP approach, and make sure that only CloudFormation makes changes to the EBS volume. To ensure a successful update operation, the volume size must be valid and must not be lower than the value of the resources currently provisioned. The volume size could be a parameter in the CloudFormation stack. + * **Avoid making API calls directly on a resource** – Use the CloudFormation [update-stack](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/update-stack.html) API call as part of an EDP approach, and make sure that only CloudFormation makes changes to the EBS volume. To ensure a successful update operation, the volume size must be valid and must not be lower than the value of the resources currently provisioned. The volume size could be a parameter in the CloudFormation stack. @@ -13 +13 @@ To use IaC and EDP together in a way that's compatible, secure, and mutually ben - * **Avoid using a single, monolithic template –** Break your template into modular templates (similar to microservices). Modular templates are easier to update, maintain, and troubleshoot. + * **Avoid using a single, monolithic template** – Break your template into modular templates (similar to microservices). Modular templates are easier to update, maintain, and troubleshoot. @@ -15 +15 @@ To use IaC and EDP together in a way that's compatible, secure, and mutually ben - * **Use a feedback mechanism for EDP –** Design feedback mechanisms that are tailored to your organization's needs. In the previous hypothetical scenario, a feedback mechanism could be an auto-generated pull request to the version control system coupled with a solution to tag system events and metadata. + * **Use a feedback mechanism for EDP** – Design feedback mechanisms that are tailored to your organization's needs. In the previous hypothetical scenario, a feedback mechanism could be an auto-generated pull request to the version control system coupled with a solution to tag system events and metadata. @@ -17 +17 @@ To use IaC and EDP together in a way that's compatible, secure, and mutually ben - * **Create notification systems –** Notification systems can help notify the team when a certain event takes place. For example, you can create an email-based notification by using Amazon SNS. Finally, it's a best practice to always ensure that stacks are in sync and that your DevOps system is designed with guardrails that can help you avoid resource drift. For more information, see [Set up CloudFormation drift detection in a multi-Region, multiaccount organization](https://docs.aws.amazon.com//prescriptive-guidance/latest/patterns/set-up-aws-cloudformation-drift-detection-in-a-multi-region-multi-account-organization.html) in the AWS Prescriptive Guidance documentation. + * **Create notification systems** – Notification systems can help notify the team when a certain event takes place. For example, you can create an email-based notification by using Amazon SNS. Finally, it's a best practice to always ensure that stacks are in sync and that your DevOps system is designed with guardrails that can help you avoid resource drift. For more information, see [Set up AWS CloudFormation drift detection in a multi-Region, multi-account organization](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/set-up-aws-cloudformation-drift-detection-in-a-multi-region-multi-account-organization.html) in the AWS Prescriptive Guidance documentation. @@ -30 +30 @@ Blind spot scenario -Next steps +FAQ