From 97640c2c42d2504288a3d1895b69f13937668706 Mon Sep 17 00:00:00 2001 From: Dan Miller Date: Mon, 11 Mar 2024 10:39:05 -0700 Subject: [PATCH] feat: `prettier` in READMEs (https://github.com/cloudposse/terraform-aws-components/pull/998) --- src/README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/README.md b/src/README.md index f261167..43bf853 100644 --- a/src/README.md +++ b/src/README.md @@ -52,18 +52,18 @@ and effectively manage security compliance across their AWS accounts and resourc This component is complex in that it must be deployed multiple times with different variables set to configure the AWS Organization successfully. -It is further complicated by the fact that you must deploy each of the component instances described below to -every region that existed before March 2019 and to any regions that have been opted-in as described in the [AWS -Documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions). +It is further complicated by the fact that you must deploy each of the component instances described below to every +region that existed before March 2019 and to any regions that have been opted-in as described in the +[AWS Documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions). In the examples below, we assume that the AWS Organization Management account is `root` and the AWS Organization Delegated Administrator account is `security`, both in the `core` tenant. ### Deploy to Delegated Administrator Account -First, the component is deployed to the [Delegated -Administrator](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_organizations.html) account in each region to -configure the Security Hub instance to which each account will send its findings. +First, the component is deployed to the +[Delegated Administrator](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_organizations.html) account in each +region to configure the Security Hub instance to which each account will send its findings. ```yaml # core-ue1-security @@ -148,6 +148,7 @@ atmos terraform apply security-hub/org-settings/uw1 -s core-uw1-security # ... other regions ``` + ## Requirements @@ -236,6 +237,7 @@ atmos terraform apply security-hub/org-settings/uw1 -s core-uw1-security | [sns\_topic\_name](#output\_sns\_topic\_name) | The name of the SNS topic created by the component | | [sns\_topic\_subscriptions](#output\_sns\_topic\_subscriptions) | The SNS topic subscriptions created by the component | + ## References