DNAnexus Documentation
APIDownloadsIndex of dx CommandsLegal
  • Overview
  • Getting Started
    • DNAnexus Essentials
    • Key Concepts
      • Projects
      • Organizations
      • Apps and Workflows
    • User Interface Quickstart
    • Command Line Quickstart
    • Developer Quickstart
    • Developer Tutorials
      • Bash
        • Bash Helpers
        • Distributed by Chr (sh)
        • Distributed by Region (sh)
        • SAMtools count
        • TensorBoard Example Web App
        • Git Dependency
        • Mkfifo and dx cat
        • Parallel by Region (sh)
        • Parallel xargs by Chr
        • Precompiled Binary
        • R Shiny Example Web App
      • Python
        • Dash Example Web App
        • Distributed by Region (py)
        • Parallel by Chr (py)
        • Parallel by Region (py)
        • Pysam
      • Web App(let) Tutorials
        • Dash Example Web App
        • TensorBoard Example Web App
      • Concurrent Computing Tutorials
        • Distributed
          • Distributed by Region (sh)
          • Distributed by Chr (sh)
          • Distributed by Region (py)
        • Parallel
          • Parallel by Chr (py)
          • Parallel by Region (py)
          • Parallel by Region (sh)
          • Parallel xargs by Chr
  • User
    • Login and Logout
    • Projects
      • Project Navigation
      • Path Resolution
    • Running Apps and Workflows
      • Running Apps and Applets
      • Running Workflows
      • Running Nextflow Pipelines
      • Running Batch Jobs
      • Monitoring Executions
      • Job Notifications
      • Job Lifecycle
      • Executions and Time Limits
      • Executions and Cost and Spending Limits
      • Smart Reuse (Job Reuse)
      • Apps and Workflows Glossary
      • Tools List
    • Cohort Browser
      • Chart Types
        • Row Chart
        • Histogram
        • Box Plot
        • List View
        • Grouped Box Plot
        • Stacked Row Chart
        • Scatter Plot
        • Kaplan-Meier Survival Curve
      • Locus Details Page
    • Using DXJupyterLab
      • DXJupyterLab Quickstart
      • Running DXJupyterLab
        • FreeSurfer in DXJupyterLab
      • Spark Cluster-Enabled DXJupyterLab
        • Exploring and Querying Datasets
      • Stata in DXJupyterLab
      • Running Older Versions of DXJupyterLab
      • DXJupyterLab Reference
    • Using Spark
      • Apollo Apps
      • Connect to Thrift
      • Example Applications
        • CSV Loader
        • SQL Runner
        • VCF Loader
      • VCF Preprocessing
    • Environment Variables
    • Objects
      • Describing Data Objects
      • Searching Data Objects
      • Visualizing Data
      • Filtering Objects and Jobs
      • Archiving Files
      • Relational Database Clusters
      • Symlinks
      • Uploading and Downloading Files
        • Small File Sets
          • dx upload
          • dx download
        • Batch
          • Upload Agent
          • Download Agent
    • Platform IDs
    • Organization Member Guide
    • Index of dx commands
  • Developer
    • Developing Portable Pipelines
      • dxCompiler
    • Cloud Workstation
    • Apps
      • Introduction to Building Apps
      • App Build Process
      • Advanced Applet Tutorial
      • Bash Apps
      • Python Apps
      • Spark Apps
        • Table Exporter
        • DX Spark Submit Utility
      • HTTPS Apps
        • Isolated Browsing for HTTPS Apps
      • Transitioning from Applets to Apps
      • Third Party and Community Apps
        • Community App Guidelines
        • Third Party App Style Guide
        • Third Party App Publishing Checklist
      • App Metadata
      • App Permissions
      • App Execution Environment
        • Connecting to Jobs
      • Dependency Management
        • Asset Build Process
        • Docker Images
        • Python package installation in Ubuntu 24.04 AEE
      • Job Identity Tokens for Access to Clouds and Third-Party Services
      • Enabling Web Application Users to Log In with DNAnexus Credentials
      • Types of Errors
    • Workflows
      • Importing Workflows
      • Introduction to Building Workflows
      • Building and Running Workflows
      • Workflow Build Process
      • Versioning and Publishing Global Workflows
      • Workflow Metadata
    • Ingesting Data
      • Molecular Expression Assay Loader
        • Common Errors
        • Example Usage
        • Example Input
      • Data Model Loader
        • Data Ingestion Key Steps
        • Ingestion Data Types
        • Data Files Used by the Data Model Loader
        • Troubleshooting
      • Dataset Extender
        • Using Dataset Extender
    • Dataset Management
      • Rebase Cohorts and Dashboards
      • Assay Dataset Merger
      • Clinical Dataset Merger
    • Apollo Datasets
      • Dataset Versions
      • Cohorts
    • Creating Custom Viewers
    • Client Libraries
      • Support for Python 3
    • Walkthroughs
      • Creating a Mixed Phenotypic Assay Dataset
      • Guide for Ingesting a Simple Four Table Dataset
    • DNAnexus API
      • Entity IDs
      • Protocols
      • Authentication
      • Regions
      • Nonces
      • Users
      • Organizations
      • OIDC Clients
      • Data Containers
        • Folders and Deletion
        • Cloning
        • Project API Methods
        • Project Permissions and Sharing
      • Data Object Lifecycle
        • Types
        • Object Details
        • Visibility
      • Data Object Metadata
        • Name
        • Properties
        • Tags
      • Data Object Classes
        • Records
        • Files
        • Databases
        • Drives
        • DBClusters
      • Running Analyses
        • I/O and Run Specifications
        • Instance Types
        • Job Input and Output
        • Applets and Entry Points
        • Apps
        • Workflows and Analyses
        • Global Workflows
        • Containers for Execution
      • Search
      • System Methods
      • Directory of API Methods
      • DNAnexus Service Limits
  • Administrator
    • Billing
    • Org Management
    • Single Sign-On
    • Audit Trail
    • Integrating with External Services
    • Portal Setup
    • GxP
      • Controlled Tool Access (allowed executables)
  • Science Corner
    • Scientific Guides
      • Somatic Small Variant and CNV Discovery Workflow Walkthrough
      • SAIGE GWAS Walkthrough
      • LocusZoom DNAnexus App
      • Human Reference Genomes
    • Using Hail to Analyze Genomic Data
    • Open-Source Tools by DNAnexus Scientists
    • Using IGV Locally with DNAnexus
  • Downloads
  • FAQs
    • EOL Documentation
      • Python 3 Support and Python 2 End of Life (EOL)
    • Automating Analysis Workflow
    • Backups of Customer Data
    • Developing Apps and Applets
    • Importing Data
    • Platform Uptime
    • Legal and Compliance
    • Sharing and Collaboration
    • Product Version Numbering
  • Release Notes
  • Technical Support
  • Legal
Powered by GitBook

Copyright 2025 DNAnexus

On this page
  • Relational Database Clusters
  • Overview of the Relational Database Service
  • Restriction on Transfers of Projects Containing DBClusters

Was this helpful?

Export as PDF
  1. User
  2. Objects

Relational Database Clusters

Last updated 8 months ago

Was this helpful?

Relational Database Clusters

The DNAnexus Relational Database Service provides users with a way to create and manage cloud database clusters (referred to as dbcluster objects on the platform). These databases can then be securely accessed from within DNAnexus jobs/workers.

The Relational Database Service is currently available via the application program interface (API) in AWS regions only. See for details.

A license is required to access the Relational Database Service. for more information.

Overview of the Relational Database Service

DNAnexus Relational DB Cluster States

When describing a DNAnexus dbclusters, the status field can be any of the following:

DBCluster status
Details

creating

The database cluster is being created, but not yet available for reading/writing.

available

The database cluster is created and all replicas are available for reading/writing.

stopping

The database cluster is currently being stopped.

stopped

The database cluster is stopped.

starting

The database cluster is restarting from a stopped state, it will be transitioned to available when ready.

terminating

The database cluster is being terminated.

terminated

The database cluster has been terminated and all data deleted.

Connecting to a DB Cluster

DB Clusters are not accessible from outside of the DNAnexus platform. Any access to these databases must occur from within a DNAnexus job. Refer to this page on for one possible way to access a DB Cluster from within a job. Executions such as can access a DB Cluster as well.

The parameters needed for connecting to the database are:

  • port 3306 for MySQL Engines or 5432 for Postgresql Engines

  • user root

  • For MySQL: ssl-mode 'required'

  • For Postgresql: sslmode 'require' Note: For connecting and verifying certs: (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html)

DBCluster Instance Types

The table below provides all the valid configurations of dxInstanceClass, database engine and versions

DxInstanceClass
Engine + Version Supported
Memory (GB)
# Cores

db_std1_x2 (*)

aurora-mysql: ["8.0.mysql_aurora.3.04.1"], aurora-postgresql: ["12.9", "13.9", "14.6"]

4

2

db_mem1_x2

aurora-mysql: ["8.0.mysql_aurora.3.04.1"], aurora-postgresql: [ "12.9", "13.9", "14.6"]

16

2

db_mem1_x4

aurora-mysql: ["8.0.mysql_aurora.3.04.1"], aurora-postgresql: ["12.9", "13.9", "14.6"]

32

4

db_mem1_x8

aurora-mysql: ["8.0.mysql_aurora.3.04.1"], aurora-postgresql: ["12.9", "13.9", "14.6"]

64

8

db_mem1_x16

aurora-mysql: ["8.0.mysql_aurora.3.04.1"], aurora-postgresql: [ "12.9", "13.9", "14.6"]

128

16

db_mem1_x32

aurora-mysql: ["8.0.mysql_aurora.3.04.1"], aurora-postgresql: ["12.9", "13.9", "14.6"]

244

32

db_mem1_x48

aurora-mysql: ["8.0.mysql_aurora.3.04.1"], aurora-postgresql: ["12.9", "13.9", "14.6"]

384

48

db_mem1_x64

aurora-mysql: ["8.0.mysql_aurora.3.04.1"], aurora-postgresql: ["12.9", "13.9", "14.6"]

488

64

db_mem1_x96

aurora-postgresql: ["12.9", "13.9", "14.6"]

768

96

Restriction on Transfers of Projects Containing DBClusters

host Use endpoint as returned from

password Use the adminPassword specified when creating the database

* - db_std1 instances may incur CPU Burst charges similar to AWS T3 Db instances described in . Regular hourly charges for this instance type are based on 1 core, CPU Burst charges are based on 2 cores.

If a project contains a , its ownership cannot be changed. on attempting to change the billTo of such a project.

DBClusters API page
Contact DNAnexus Sales
cloud workstations
app/applets
dbcluster-xxxx/describe
dbcluster/new
this AWS documentation
DBCluster
A PermissionDenied error will be returned