AWS Security Instructions

This guide will walk through the requirements and steps to successfully generate documentation using Documentation as a Service.

Pre-Requesites

  • AWS CLI v2 (install this first) https://awscli.amazonaws.com/AWSCLIV2.msi Reboot after install
  • Powershell version 5.1 or better
  • Powershell modules AWSPowerShell.NetCore Up to date NuGet
  • Internet Connectivity
  • Read access or higher to the AWS account
  • API access using an AWS Access and Secret Keys

Downloading the latest Gather Script

  • Open a Browser and navigate to https://DocumentationAsCode.com
  • Log in with your Softchoice account
  • On the services dashboard, under Documentation as Code, select AWS
  • Click the link to download the latest version of the gather script, it will be a zip folder
  • Open your downloads folder and extract the file in the Get-AWS.zip to a new folder on your C: drive
    • Make sure to save the gather script somewhere you can find it later on your computer

Running the gather script

  • Browse to where you saved the gather script
  • Right-click on the file and select "Run with Powershell", If you don't have this prompt, open the file with PowerShell ISE and run the script
    • If you get a security warning, click open. Optionally, you can uncheck the "Always ask before opening this file" box to ignore this warning in the future
  • Next you will get a pop up asking for the AWS account ID
  • The script will prompt you for the following information AWS Access Key AWS Secret Key Region Output Type - take the default for this entry
  • The original PowerShell window will use the above information to extract the required JSON from AWS
    • Note: After it completes the export it will open a window to your file
  • If you do not see the window with your file, navigate to the folder where you saved the gather script and locate the JSON file

Generating Documentation

  • Return to https://DocumentationAsCode.com
  • Login with your Softchoice account
  • On the services dashboard, under Documentation as Code, select AWS
  • Under Generate Reports:
    • Enter the customer's name
    • Enter your name
    • Choose the type of document(s) you want to generate. The options are:
      1. Word
      2. Visio
      3. Network Visio
    • Click the "Browse" button and navigate to the JSON file that the script created. It will be in the same folder as the gather script unless you moved it somewhere else
  • Click Generate Document
  • You'll see a notification that the file has been uploaded and will be delivered shortly
  • Check your email for the documentation, coming from dac@softchoice.com
    • Note: Check your Other or Junk folders if you do not recieve your document within 5 minutes
  • Click the Download Document button in the email to download your documentation

Common Errors/Issues

  • If you get aws is not recognized as the name of a cmdlet, reboot as AWS CLI didn't update your paths to the executable
  • If you want to install the required modules, open PowerShell as an Administrator and run "Install-Module -Name AWSPowerShell.NetCore -Force", then select "Yes to All [A]"
  • If you get a zero byte JSON file, check that you entered the correct region where AWS Security Hub is running or that you didn't make an error on entry