LightBeam Documentation
Installer GuidesData SourcesPlaybooksInsightsPrivacyOpsGovernance
  • 💡What is LightBeam?
  • 🚀Getting Started
    • ⚙️Installer Guides
      • Pre-Requisites / Security Configurations
        • Firewall Requirements
        • Securing LightBeam on EKS with AWS Certificate Manager on Elastic Load Balancer
        • Configure HTTPS for LightBeam Endpoint FQDN Standalone deployment
        • Using Custom Certificates with LightBeam
        • Securing LightBeam on GKE with Google Certificate Manager and GCE Ingress
      • Core
        • LightBeam Deployment Instructions
        • LightBeam Installer
        • Web App Deployment
        • LightBeam Diagnostics
        • LightBeam Cluster Backup & Restore using Velero
      • Platform Specific
        • AWS
        • Microsoft Azure
        • Google Cloud (GKE)
        • Standalone Virtual Machine
        • Deployment on an Existing Managed Kubernetes Cluster
        • Azure Marketplace Deployment
      • Integration and Setup
        • Setting Up AWS PrivateLink for RDS-EKS Interaction
        • Twingate and LightBeam Integration Guide
        • Data Subject Request Web Application Server
        • Generate CSR for LightBeam
  • 🧠Core Features
    • 🔦Spectra AI
      • 🔗Data Sources
        • Cloud Platforms
          • AWS Auto Discovery
          • GCP Auto Discovery
        • Databases and Datalakes
          • PostgreSQL
          • Aurora (PostgreSQL)
          • Snowflake
          • MS SQL
          • MySQL
          • Aurora (MySQL)
          • BigQuery
          • AWS Redshift
          • Oracle
          • DynamoDB
          • MongoDB
          • CosmosDB (PostgreSQL)
          • CosmosDB (MongoDB)
          • CosmosDB (NoSQL)
          • Looker
          • AWS Glue
          • Databricks
          • SAP HANA
          • CSV Files as a Datasource
        • Messaging
          • Gmail
          • Slack
          • MS Teams
          • MS Outlook
        • Developer Tools
          • Zendesk
          • ServiceNow
          • Jira
          • GitHub
          • Confluence
        • File Repositories
          • NetDocuments
          • AWS S3
          • Azure Blob
          • Google Drive
          • OneDrive
          • SharePoint
          • Viva Engage
          • Dropbox
          • Box
          • SMB
        • CRM
          • Hubspot
          • Salesforce
          • Automated Data Processing (ADP)
          • Marketo
          • Iterable
          • MS Dynamics 365 Sales
          • Salesforce Marketing Cloud
      • 🔔PlayBooks
        • What is LightBeam Playbooks?
        • Policy and Alerts
          • Types of Policies
          • How to create a rule set
            • File Extension Filter
          • Configuring Retention Policies
          • Viewing Alerts
          • Sub Alerts
            • Reassigning Sub-Alerts
            • Sub-alert States
          • Levels of Actions on Alerts
          • User Roles and Permissions
            • Admin View
            • Alert Owner View
            • Onboarding New Users
              • User Management
              • Okta Integration
              • Alert Assignment Settings
              • Email Notifications
            • Planned Enhancements
          • Audit Logs
          • No Scan List
          • Permit List
          • Policy in read-only mode
      • 📊Insights
        • Entity Workflow
        • Document Classification
        • Attribute Management Overview
          • Attributes Page View
          • Attribute Sets
          • Creating Custom Attribute
          • Attributes List
        • Template Builder
        • Label Management
          • MIP Integration
          • Google Labels Integration
      • 🗃️Reporting
        • Delta Reporting
        • Executive Report
        • LightBeam Lens
      • Scanning and Redaction of Files
        • On-demand scanning
      • How-to Guides
        • Leveraging LightBeam insights for structured data sources
      • LightBeam Dashboard Outlay
      • Risk Score
    • 🏛️PrivacyOps
      • Data Subject Request (DSR)
        • What is DSR?
        • Accessing the DSR Module
        • DSR Form Builder (DPO View)
          • Creating a New DSR Form
            • Using a Predefined Template
            • Creating a Custom Form
          • Form Configuration
          • Form Preview and Publishing
          • Multi-Form Management
          • Messaging Templates
        • Form Submission & Email Verification (Data Subject View)
        • DSR Management Dashboard (DPO View)
        • Processing DSR Requests
          • Data Protection Officer (DPO) Workflow
          • Self Service Workflow (Direct Validation)
          • Data Source Owner (DSO) Workflow
        • DSR Report
      • 🚧Consent Management
        • Overview
        • Consent Logs
        • Preference Centre
        • Settings
      • 🍪Cookie Consent
        • Dashboard
        • Banners
        • Domains
        • Settings
        • CMP Deployment Guide for Google Tag Manager
        • FAQs
      • 🔏Privacy Impact Assessment (PIA)
        • PIA Templates
        • PIA Assessment Workflow
        • Collaborator View
        • Process Owner Login View (With Collaborator)
        • Filling questionnaire without collaborator
        • Submitting the assessment for DPO review
        • DPO review process
        • Marking the assessment as reviewed
        • Editing and resubmitting assessments after DPO review
        • Revoke review request
        • Edit Reviewer
        • PIA Reports
      • ⏺️Records of Processing Activity (RoPA)
        • Creating a RoPA Template
          • How to clone a template
          • How to use a template
        • How to create a process
          • Adding Process Details
          • Adding Data Elements
          • Adding Data Subjects
          • Adding Data Retention
          • Adding Safeguards
          • Adding Transfers
          • Adding a Custom Section
          • Setting a Review Schedule
          • Data Flow Diagram
        • How to add a collaborator
        • Overview Section
        • Generating a RoPA Report Using LightBeam
        • Collaborator working on a ticket
    • 🛡️Governance
      • Access
        • Dashboard
        • Users
        • Groups
        • Objects
        • Active Directory Settings
        • Access Governance at a Data Source Level
        • Policies and Alerting
        • Access Governance Statistics
        • Governance Module Dashboard
      • Privacy At Partners
  • 📊Tools & Resources
    • 🔀API Documentation
      • API to Create Reports for Structured Datasource
    • ❓Onboarding Assessments
      • Structured Datasource Onboarding Questionnaire
        • MongoDB/CosmosDB Questionnaire
        • Oracle Datasource Questionnaire
      • SMB Questionnaire
    • 🛠️Administration
      • Audit Logs
      • SMTP
        • Basic and oAuth Configuration
      • User Management
        • SAML Identity Providers
          • Okta
            • LightBeam Okta SAML Configuration Guide
          • Azure
            • Azure AD SAML Configuration for LightBeam
          • Google
            • Google IDP
        • Local User Management
          • Adding a User to the LightBeam Dashboard
          • Reset Default Admin Password
  • 📚Support & Reference
    • 📅Release Notes
      • LightBeam v2.2.0
      • Reporting Release Notes
      • Q1 2024 Key Enhancements
      • Q2 2024 Key Enhancements
      • Q3 2024 Key Enhancements
      • Q4 2024 Key Enhancements
    • 📖Glossary
Powered by GitBook
On this page
  • Overview
  • About DynamoDB
  • Features
  • Onboarding DynamoDB Data Source
  • APPENDIX
  • Minimal permissions setup
  • Validate permissions to the database
  • About LightBeam
  1. Core Features
  2. Spectra AI
  3. Data Sources
  4. Databases and Datalakes

DynamoDB

Connecting DynamoDB to LightBeam


Overview

LightBeam Spectra users can connect various data sources to the LightBeam application and these data sources will be continuously monitored for PII, PHI data.

Example: DynamoDB, Redshift, PostgreSQL, etc.


About DynamoDB

DynamoDB, AWS's managed NoSQL database service, supports both structured and semi-structured data. Users have the flexibility to define tables with or without a predefined schema. Lightbeam now includes support for DynamoDB as a structured data source.


Features

Datasource Registration

  • DynamoDB administrators can create a user with restricted permissions.

  • Utilize the restricted user’s accessKey and secretKey for registration with Lightbeam.

  • During registration, users select desired regions for scanning. Lightbeam will subsequently scan all tables within these specified regions.

Metadata Scanning

We scan the tables present in regions configured in scan conditions. A region is a database on our side. For each table, we treat each document as a row. All first level fields in documents are treated as columns. A first level field which is a map or a list is considered a Blob.

  • LightBeam scans the tables present in regions configured in scan conditions (each region is treated as a separate database).

  • For each table, each document is treated as a row.

  • All first-level fields in the documents are considered columns.

  • First-level fields that are maps or lists are categorized as Blobs.

PII Detection

LightBeam fetches sample data for each table and classifies first-level fields in documents. A field or column may be classified into a single attribute or multi-attribute for nested fields with varied PII types.

Full Blob Scan

  • Lightbeam provides an option for a comprehensive scan of blob columns. This is to ensure detection of all potential attribute types.

  • Users can opt for a full scan of marked blob columns, which Lightbeam conducts periodically (every 15 days) in the background.

  • Due to the resource-intensive nature of full scans, this feature is not enabled by default and is activated upon user configuration.


Onboarding DynamoDB Data Source

  1. Login to your LightBeam Instance.

  2. Click on DATASOURCES on the Top Navigation Bar.

  3. Click on “Add a data source”.

  1. Search for DynamoDB.

  1. Click on DynamoDB.

  1. Configure Basic Details

In the Basic Details section, enter the following information:

  • Instance Name: Provide a unique name for the DynamoDB data source (e.g., DynamoDB Datasource).

  • Primary Owner: Enter the email address of the individual responsible for this data source (e.g., demo@lightbeam.ai).

  • Source of Truth (Optional): Toggle this option on if this database serves as a single source of truth for entity validation.

  • Description (Optional): Add a brief description of the database (e.g., "DynamoDB Datasource Instance").

  1. Additional Details (Optional)

In this section, you can specify metadata attributes related to the data source:

  • Location: The location of the data source.

  • Purpose: The purpose of the data being collected/processed.

  • Stage: The stage of the data source. Example: Source, Processing, Archival, etc

  1. Enter Connection Details

Provide the following details in the Connection section:

  • Access Key: The AWS IAM user's access key to authenticate with DynamoDB.

  • Secret Key: The AWS IAM user's secret key for authentication.

  1. Click Test Connection to validate the credentials. If successful, you will see a Test Connection Success message.

  2. Click Next to proceed.

  1. Configure Scan Settings

  • Set Scan Frequency

    • Scan Every: Select the scan interval (e.g., 1 Month).

    • Scan Day: Select a specific day for scanning between Day 1 to the last day of the month.

    The default start time is 12:00 AM UTC.

In the next step, you will see a list of databases presented from your DynamoDB cluster.

  1. Select Databases to Scan

You can choose to scan:

a. All current and future databases – This ensures any new databases added in the future are included automatically.

b. Selected databases only – Manually select specific databases for scanning.

i. Adding Databases to the Inclusion / Scan List

If you choose Scan selected databases only, follow these steps to select databases:

  • Search for a Database: Use the search box to find the database you want to include.

  • Add Database to the Scan List: Click the “+ Add to Inclusion / Scan List” button to add the selected database to the scan list. The selected database will then appear in the list below.

  • Review and Confirm: The added databases will be displayed in the Inclusion / Scan List section. In this example, us-east-2 is selected for scanning.

  • Remove a Database (If Needed): If you want to remove a database, click the trash bin icon next to it.

  1. Once you have selected the databases, click Save to proceed.

  1. Finally, click on Start Sampling to connect to the DynamoDB datasource.


APPENDIX

Minimal permissions setup

To facilitate the scanning of DynamoDB tables with Lightbeam, a user possessing read-only access is required.

This entails creating an IAM user within AWS and assigning the AmazonDynamoDBReadOnlyAccess permission to this user.

Once established, the Access Key and Secret Key associated with this IAM user can be employed to enable Lightbeam to perform database scans.

Note:

If the DynamoDB is KMS encrypted, then the following permission needs to be added to the policy. All keys that are used for encryption need to be specified in the Resource field.

{
	"Sid": "VisualEditor6",
	"Effect": "Allow",
	"Action": [
		"kms:Decrypt",	
	],
	"Resource": "arn:aws:kms:<AWS region>:<account_id>:key/<key_id>"
}

Validate permissions to the database

Next, the user needs to validate these permissions to the database. This ensures authorized access to the database by the credentials provided by the user. After validating the permissions to the database, the user can configure LightBeam Spectra on the system.

Steps

  1. Go into sql_user_check_dynamodb directory.

  2. Please refer to the README.md file in the directory for detailed instructions.


About LightBeam

LightBeam automates Privacy, Security, and AI Governance, so businesses can accelerate their growth in new markets. Leveraging generative AI, LightBeam has rapidly gained customers’ trust by pioneering a unique privacy-centric and automation-first approach to security. Unlike siloed solutions, LightBeam ties together sensitive data cataloging, control, and compliance across structured and unstructured data applications providing 360-visibility, redaction, self-service DSRs, and automated ROPA reporting ensuring ultimate protection against ransomware and accidental exposures while meeting data privacy obligations efficiently. LightBeam is on a mission to create a secure privacy-first world helping customers automate compliance against a patchwork of existing and emerging regulations.

PreviousOracleNextMongoDB

Last updated 3 months ago

Figure 1. Add Data Source

First, clone the repository

For any questions or suggestions, please get in touch with us at: .

🧠
🔦
🔗
https://github.com/lightbeamai/lb-installer
support@lightbeam.ai
Figure 2. Search DynamoDB
Figure 3. Click on DynamoDB.
Figure 4. DynamoDB - Basic Configuration
Fig 5. DynamoDB - Connection details
Fig 6. DynamoDB - Scan Settings - Frequency
Fig 8. DynamoDB - Scanning Scope
Fig 7. DynamoDB - Database Selection