Skip to content
English
  • There are no suggestions because the search field is empty.

AWS Account - System Data Connector Guide

Gathid can be configured to download identity data from your AWS Account instance using an API. The following guide will assist you with configuring your system so that Gathid can automatically extract the data.

Overview

This article relates to version 8.2 of the AWS Account Data Connector.

The connector retrieves a list of users and other identity information from your AWS Account IAM service via REST API.

Optionally, it can also display Identity Policy information on the graph as well as collect EC2 instances, Lambda functions and S3 buckets.

Authentication is performed using OAuth 2.0 tokens - further details are provided below.

Click here to review the loader's system properties.


Summary

  1. Validate that the new AWS Account connector is available on your Gathid instance

  2. Create an IAM user and assign permissions

  3. Obtain credentials from your AWS Account instance for the Gathid configuration

  4. Configure the Prep Script tab in the AWS Account system loader

  5. Configure Optional Items

  6. Next Steps


Steps to configure the AWS Account data connector in Gathid

1. Validate that the new AWS Account connector is available on your Gathid instance

  1. As an Administrator user, log into Gathid and navigate to Admin Systems.

  2. You should see a new AWS Account loader in the list, in a Disabled state. If not, follow the process to add a new system.

REMINDER: To be able to view the Admin menu option in Gathid you need to have the ADMINISTRATOR role.

2. Create an IAM user and assign permissions

If you already have a user available for Gathid access in this AWS Account, ensure that you have the correct Access Policy (see step 2.9 below) assigned to this User. Then continue on to Obtain an Access Key and Secret Key for the Gathid connector.

  1. From the AWS Management Console log in to this AWS Account with a user that has administrative privileges.

  2. Navigate to the Identity and Access Management (IAM) service by searching for IAM in the search bar.
  3. Select IAM Users, and then Create user.
  4. For Step 1: Specify user details, provide a User name (e.g. "gathid-access") and click Next. (This user does not need access to the AWS Management Console.)
  5. For Step 2: Set permissions, leave the Permissions options as the default (Add user to group) and click Next. (
  6. For Step 3: Review and create, click on Create user
  7. Return to IAM Users and click on the user that has just been created.
  8. On the Permissions tab, in the Permissions policies section, click on the Add permissions drop down and select Create inline policy. (If you prefer, create a customer managed policy and attach it to this user.)
  9. For Step 1: Specify permissions, on the right-hand side of Policy editor, select the JSON tab. Delete the existing JSON and paste the following:
    {
    "Version": "2012-10-17",
    "Statement": [
    {
    "Effect": "Allow",
    "Action": [
    "iam:GetAccountAuthorizationDetails",
    "iam:ListRoles",
    "iam:ListPolicies",
    "iam:GetPolicyVersion"
    ],
    "Resource": "*"
    }]}
  10. Click Next.
  11. For Step 2: Review and create, under Policy details enter a Policy name (e.g. gathid-access-policy).
    Click on Create policy. This policy gets added to the user as a "Customer inline" policy.

3. Obtain credentials from your AWS Account instance for the Gathid configuration

  1. After a user has been created and the permissions have been assigned, return to the IAM Users section and click on the user that has just been created.
  2. In the Summary section on the right-hand-side, click Create access key.

  3. For Step 1: Access key best practices & alternatives, select Other and click Next.

  4. For Step 2: Set description tag, this is optional so it can be left empty. Click Create access key.
    A confirmation message appears at the top of the screen. Do not leave this screen without downloading the credentials as they cannot be recovered.
  5. Either copy the Access key and the Secret Access key or click Download.csv file.
    Keep these credentials as they will be required in the step to configure the Gathid loader.
  6. Click Done.

4. Configure the Prep Script tab in the AWS Account system loader

  1. As an Administrator, log into Gathid and navigate to Admin → Systems.
  2. Select the AWS Account loader and in 1. System Information toggle the System Enabled option to On.
    Ensure the correct start time for the loader is set in the Time. This should be close to your instance's stack start time.
  3. Then go to 2. Prep-Scripts (Optional) and edit the AWS Account Prep Script.
    Under Customer Configuration, enter the Access Key and Secret obtained in the previous step.
  4. Click on Save Parameters to save the prep-script changes.
    Click Save again to save the system loader configuration.

     

If an AWS Organization system loader is present and IDC is enabled, an external relationship can be created to join Permission Sets to AWS Account Roles.

5. Configure Optional Items

  1. The Gathid prep-script allows you to configure the data that is collected from this AWS Account.
  2. Currently there are 3 optional items to configure:
    1. EC2 Service Information
      Toggle this item on to collect EC2 instances from the region(s) specified.
      This requires additional permissions.
    2. Lambda Service Information
      Toggle this item on to collect Lambda functions from the region(s) specified.
      This requires additional permissions.
    3. S3 Service Information
      Toggle this item on to collect S3 buckets.
      This requires additional permissions.
  3. To update the permissions required for retrieving the optional information, following these  steps:
    1. Log into your AWS Management Account via the AWS Management Console as a user with sufficient privileges.
    2. In the IAM service, locate the user that has been setup for Gathid access (step 2 above).
    3. In the Permissions tab find the policy that grants the Gathid access permission and click on it.
    4. In the Policy editor, add the following permissions to the Action array:
      For EC2 instances:
      "ec2:DescribeInstances"

      For Lambda functions:
      "lambda:ListFunctions",
      "lambda:GetPolicy"

      For S3 buckets:
      "s3:ListAllMyBuckets",
      "s3:GetBucketPolicy"
    5. Click Next and then Save changes.
      NOTE: If you are experiencing difficulties saving due to syntax errors, ensure that each item in the Action has a comma after it, except for the very last one before the square bracket.
 

Next Steps: 

Add External Relationships

 


 

System Properties