AWS guidance documentation change
Summary
Restructured documentation headings, updated deployment steps with account context, simplified CID-CMD installation instructions, and changed dashboard template source from local file to GitHub URL
Security assessment
Changes focus on documentation structure and deployment process improvements without addressing security vulnerabilities or introducing security features. The template URL change improves source reliability but doesn't directly relate to security controls.
Diff
diff --git a/guidance/latest/cloud-intelligence-dashboards/config-resource-dashboard-account.md b/guidance/latest/cloud-intelligence-dashboards/config-resource-dashboard-account.md index 24eb53d42..7a070c844 100644 --- a//guidance/latest/cloud-intelligence-dashboards/config-resource-dashboard-account.md +++ b//guidance/latest/cloud-intelligence-dashboards/config-resource-dashboard-account.md @@ -3 +3 @@ -Deployment Instructions +Deployment InstructionsInstallation on dedicated Dashboard accountDeployment StepsStep 1 [in Dashboard account]Step 2 [in Log Archive account]Step 3 [in Dashboard account]Configure dataset refresh schedule (optional)Visualize the dashboard @@ -11 +11 @@ The infrastructure needed to collect and process the data is defined in AWS Clou -### Installation on dedicated Dashboard account +## Installation on dedicated Dashboard account @@ -30 +30 @@ The S3 replication rule configured at step 2 is valid only for new AWS Config fi -#### Deployment Steps +## Deployment Steps @@ -36 +36 @@ Ensure you are in the region where both your Log Archive bucket and Amazon Quick -##### Step 1 +## Step 1 [in Dashboard account] @@ -83 +83 @@ Ensure you are in the region where both your Log Archive bucket and Amazon Quick -##### Step 2 +## Step 2 [in Log Archive account] @@ -151 +151 @@ The S3 replication rule configured at step 2 is valid only for new AWS Config fi -##### Step 3 +## Step 3 [in Dashboard account] @@ -159 +159 @@ At this step you will specify the tags to be used to display resources in the [I - 1. Download the [dashboard template file](https://github.com/aws-samples/config-resource-compliance-dashboard/blob/main/dashboard_template/cid-crcd.yaml) on a temporary folder. Save it with name: `cid-crcd.yaml`. + 1. Navigate to the AWS Management Console and open [AWS CloudShell](https://console.aws.amazon.com/cloudshell). Ensure to be in the correct region. @@ -161,9 +161 @@ At this step you will specify the tags to be used to display resources in the [I - 2. Deploy the QuickSight dashboard using the [CID-CMD](https://github.com/aws-solutions-library-samples/cloud-intelligence-dashboards-framework/blob/main/CID-CMD.md) tool: - - * Navigate to the AWS Management Console and open [AWS CloudShell](https://console.aws.amazon.com/cloudshell). Ensure to be in the correct region. - - * Install the latest pip package: - - python3 -m ensurepip --upgrade - - * Install the CID-CMD tool: + 2. Install the latest pip package of [CID-CMD](https://github.com/aws-solutions-library-samples/cloud-intelligence-dashboards-framework/blob/main/CID-CMD.md) tool: @@ -173 +164,0 @@ At this step you will specify the tags to be used to display resources in the [I - * On the top right corner, click on `Actions`, and then `Upload file`. @@ -175 +165,0 @@ At this step you will specify the tags to be used to display resources in the [I - * Select the `cid-crcd.yaml` file and click on `Upload`. @@ -177 +167,2 @@ At this step you will specify the tags to be used to display resources in the [I - * Deploy the dashboard by running the following command (replace the parameters accordingly): + + 1. Deploy the dashboard by running the following command (replace the parameters accordingly): @@ -190,0 +182,9 @@ At this step you will specify the tags to be used to display resources in the [I + cid-cmd deploy \ + --resources 'https://raw.githubusercontent.com/aws-samples/config-resource-compliance-dashboard/refs/heads/main/dashboard_template/cid-crcd.yaml' \ + --dashboard-id 'cid-crcd' \ + --athena-database 'cid_crcd_database' \ + --athena-workgroup 'crcd-dashboard' \ + --tag1 'REPLACE_WITH_CUSTOM_TAG_1' \ + --tag2 'REPLACE_WITH_CUSTOM_TAG_2' \ + --tag3 'REPLACE_WITH_CUSTOM_TAG_3' \ + --tag4 'REPLACE_WITH_CUSTOM_TAG_4' @@ -195,2 +194,0 @@ At this step you will specify the tags to be used to display resources in the [I - cid-cmd deploy --resources '`cid-crcd.yaml`' --tag1 '`REPLACE_WITH_CUSTOM_TAG_1`' --tag2 '`REPLACE_WITH_CUSTOM_TAG_2`' --tag3 '`REPLACE_WITH_CUSTOM_TAG_3`' --tag4 '`REPLACE_WITH_CUSTOM_TAG_4`' --dashboard-id '`cid-crcd`' --athena-database '`cid_crcd_database`' --athena-workgroup '`crcd-dashboard`' - @@ -203 +201 @@ At this step you will specify the tags to be used to display resources in the [I - 2. When prompted `[quicksight-datasource-role] Please choose a QuickSight role. It must have access to Athena:` select `CidCmdQuickSightDataSourceRole <ADD NEW ROLE>` or `CidCmdQuickSightDataSourceRole` (the second option will appear as default if you have other CID/CUDOS dashboards). + 2. When prompted `[quicksight-datasource-role] Please choose a QuickSight role.` select `CidCmdQuickSightDataSourceRole <ADD NEW ROLE>` or `CidCmdQuickSightDataSourceRole` (the second option will appear as default if you have other CID/CUDOS dashboards). @@ -214 +212 @@ At this step you will specify the tags to be used to display resources in the [I -##### Configure dataset refresh schedule (optional) +## Configure dataset refresh schedule (optional) @@ -229 +227 @@ By default, the datasets for the CRCD dashboard are refreshed once a day. You ca -##### Visualize the dashboard +## Visualize the dashboard