# CockroachDB: Cloud Deployments ## Cloud Deployments - [Cloud Deployments / Cloud API Reference (518 pages)](https://docs.cockroachlabs.com/_llms/cloud-deployments/cloud-api-reference.md): Documentation for Cloud Deployments / Cloud API Reference. ### Deploy #### Get Started - [CockroachDB Cloud Overview](https://docs.cockroachlabs.com/docs/cockroachcloud/index.md) - [Try CockroachDB Cloud for free](https://docs.cockroachlabs.com/docs/cockroachcloud/free-trial.md) - [Quickstart with CockroachDB](https://docs.cockroachlabs.com/docs/cockroachcloud/quickstart.md) - [Quickstart with CockroachDB Advanced](https://docs.cockroachlabs.com/docs/cockroachcloud/quickstart-trial-cluster.md) - [Create a CockroachDB Cloud account](https://docs.cockroachlabs.com/docs/cockroachcloud/create-an-account.md) - [Understand CockroachDB Cloud Costs](https://docs.cockroachlabs.com/docs/cockroachcloud/costs.md) - [CockroachDB Cloud Regions](https://docs.cockroachlabs.com/docs/cockroachcloud/regions.md) #### Basic Deployments - [Plan a CockroachDB Basic Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-basic.md) - [Create a CockroachDB Basic Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/create-a-basic-cluster.md) - [Connect to a CockroachDB Basic Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/connect-to-a-basic-cluster.md) - [Understand the Resource Usage of your CockroachDB Basic Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/resource-usage-basic.md) - [Manage a CockroachDB Basic Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/basic-cluster-management.md) - [Provision a CockroachDB Cloud Basic cluster with the Terraform provider](https://docs.cockroachlabs.com/docs/cockroachcloud/provision-a-cluster-with-terraform-basic.md) - [Change a Cluster's Plan Between Basic and Standard](https://docs.cockroachlabs.com/docs/cockroachcloud/change-plan-between-basic-and-standard.md) #### Standard Deployments - [Plan a CockroachDB Standard Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster.md) - [Create a CockroachDB Standard Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/create-your-cluster.md) - [Connect to a CockroachDB Standard Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/connect-to-your-cluster.md) - [Understand the Resource Usage of your CockroachDB Standard Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/resource-usage.md) - [Manage a CockroachDB Standard Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/cluster-management.md) - [Provision a CockroachDB Cloud Standard cluster with the Terraform provider](https://docs.cockroachlabs.com/docs/cockroachcloud/provision-a-cluster-with-terraform.md) - [Production Checklist](https://docs.cockroachlabs.com/docs/cockroachcloud/production-checklist.md) - [Migrate from Standard or Basic to Advanced](https://docs.cockroachlabs.com/docs/cockroachcloud/migrate-from-standard-to-advanced.md) #### Advanced Deployments - [Plan a CockroachDB Advanced Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster-advanced.md) - [Create a CockroachDB Advanced Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/create-an-advanced-cluster.md) - [Connect to a CockroachDB Advanced Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/connect-to-an-advanced-cluster.md) - [Manage a CockroachDB Advanced Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/advanced-cluster-management.md) - [Provision a CockroachDB Cloud Advanced cluster with the Terraform provider](https://docs.cockroachlabs.com/docs/cockroachcloud/provision-a-cluster-with-terraform-advanced.md) - [CockroachDB Advanced on Azure](https://docs.cockroachlabs.com/docs/cockroachcloud/cockroachdb-advanced-on-azure.md) #### BYOC Deployments - [CockroachDB BYOC Overview](https://docs.cockroachlabs.com/docs/cockroachcloud/byoc-overview.md) - [BYOC Architecture and Data Flow](https://docs.cockroachlabs.com/docs/cockroachcloud/byoc-architecture.md) - [Security and Compliance in BYOC](https://docs.cockroachlabs.com/docs/cockroachcloud/byoc-security.md) - [Prepare a CockroachDB Cloud BYOC Deployment in Amazon Web Services](https://docs.cockroachlabs.com/docs/cockroachcloud/byoc-aws-deployment.md) - [Prepare a CockroachDB Cloud BYOC Deployment in Azure](https://docs.cockroachlabs.com/docs/cockroachcloud/byoc-azure-deployment.md) - [Prepare a CockroachDB Cloud BYOC Deployment in Google Cloud Platform](https://docs.cockroachlabs.com/docs/cockroachcloud/byoc-gcp-deployment.md) - [CockroachDB Cloud BYOC FAQ](https://docs.cockroachlabs.com/docs/cockroachcloud/byoc-faq.md) #### Troubleshooting - [Troubleshoot Cloud Setup](https://docs.cockroachlabs.com/docs/cockroachcloud/troubleshooting-page.md) ### Manage #### Monitoring and Alerting - [Overview Page](https://docs.cockroachlabs.com/docs/cockroachcloud/overview-page.md) - [Alerts Page](https://docs.cockroachlabs.com/docs/cockroachcloud/alerts-page.md) - [Tools Page](https://docs.cockroachlabs.com/docs/cockroachcloud/tools-page.md) - [Insights Page](https://docs.cockroachlabs.com/docs/cockroachcloud/insights-page.md) - [Databases Page](https://docs.cockroachlabs.com/docs/cockroachcloud/databases-page.md) - [Jobs Page](https://docs.cockroachlabs.com/docs/cockroachcloud/jobs-page.md) - [Billing Management](https://docs.cockroachlabs.com/docs/cockroachcloud/billing-management.md) - [View Organization Audit Logs in the Cloud Console](https://docs.cockroachlabs.com/docs/cockroachcloud/organization-audit-logs-in-cloud-console.md) ##### Metrics - [Metrics Overview](https://docs.cockroachlabs.com/docs/cockroachcloud/metrics.md) - [Overview metrics](https://docs.cockroachlabs.com/docs/cockroachcloud/metrics-overview.md) - [SQL metrics](https://docs.cockroachlabs.com/docs/cockroachcloud/metrics-sql.md) - [Changefeed metrics](https://docs.cockroachlabs.com/docs/cockroachcloud/metrics-changefeeds.md) - [Row-Level TTL metrics](https://docs.cockroachlabs.com/docs/cockroachcloud/metrics-row-level-ttl.md) - [Request Unit metrics](https://docs.cockroachlabs.com/docs/cockroachcloud/metrics-request-units.md) - [Custom Metrics Chart Page](https://docs.cockroachlabs.com/docs/cockroachcloud/custom-metrics-chart-page.md) - [Export Metrics From a CockroachDB Standard Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/export-metrics.md) - [Export Metrics From a CockroachDB Advanced Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/export-metrics-advanced.md) - [Essential Metrics for CockroachDB Standard Deployments](https://docs.cockroachlabs.com/docs/cockroachcloud/metrics-essential.md) ##### SQL Activity - [Statements Page](https://docs.cockroachlabs.com/docs/cockroachcloud/statements-page.md) - [Sessions Page](https://docs.cockroachlabs.com/docs/cockroachcloud/sessions-page.md) - [Transactions Page](https://docs.cockroachlabs.com/docs/cockroachcloud/transactions-page.md) #### Tools - [Connect to the CockroachDB Cloud MCP Server](https://docs.cockroachlabs.com/docs/cockroachcloud/connect-to-the-cockroachdb-cloud-mcp-server.md) - [MOLT Schema Conversion Tool](https://docs.cockroachlabs.com/docs/cockroachcloud/migrations-page.md) - [SQL Shell](https://docs.cockroachlabs.com/docs/cockroachcloud/sql-shell.md) - [Use the CockroachDB Cloud API](https://docs.cockroachlabs.com/docs/cockroachcloud/cloud-api.md) ##### ccloud CLI - [Get Started with the ccloud CLI](https://docs.cockroachlabs.com/docs/cockroachcloud/ccloud-get-started.md) - [ccloud CLI Command Reference](https://docs.cockroachlabs.com/docs/cockroachcloud/ccloud-reference.md) #### Upgrade - [CockroachDB Cloud Support and Upgrade Policy](https://docs.cockroachlabs.com/docs/cockroachcloud/upgrade-policy.md) - [Upgrade a cluster in CockroachDB Cloud](https://docs.cockroachlabs.com/docs/cockroachcloud/upgrade-cockroach-version.md) #### Disaster Recovery - [Physical Cluster Replication for Resiliency](https://docs.cockroachlabs.com/docs/cockroachcloud/physical-cluster-replication.md) - [Stream a Changefeed to Snowflake](https://docs.cockroachlabs.com/docs/cockroachcloud/stream-changefeed-to-snowflake-aws.md) ##### Backups and Restores - [Backup and Restore in CockroachDB Cloud Overview](https://docs.cockroachlabs.com/docs/cockroachcloud/backup-and-restore-overview.md) - [Take and Restore Self-Managed Backups on CockroachDB Cloud](https://docs.cockroachlabs.com/docs/cockroachcloud/take-and-restore-self-managed-backups.md) - [Backup and Restore Monitoring](https://docs.cockroachlabs.com/docs/cockroachcloud/backup-and-restore-monitoring.md) ###### Managed Backups - [Managed Backups in CockroachDB Basic Clusters](https://docs.cockroachlabs.com/docs/cockroachcloud/managed-backups-basic.md) - [Managed Backups in CockroachDB Standard Clusters](https://docs.cockroachlabs.com/docs/cockroachcloud/managed-backups.md) - [Managed Backups in CockroachDB Advanced Clusters](https://docs.cockroachlabs.com/docs/cockroachcloud/managed-backups-advanced.md) ### Security #### Overview - [CockroachDB Cloud Security Overview](https://docs.cockroachlabs.com/docs/cockroachcloud/security-overview.md) #### Customer-Managed Encryption Keys (CMEK) - [Customer-Managed Encryption Keys (CMEK) Overview](https://docs.cockroachlabs.com/docs/cockroachcloud/cmek.md) - [Manage CMEK for CockroachDB Advanced](https://docs.cockroachlabs.com/docs/cockroachcloud/managing-cmek.md) #### Compliance - [Regulatory Compliance in CockroachDB Cloud](https://docs.cockroachlabs.com/docs/cockroachcloud/compliance.md) - [Payment Card Industry Data Security Standard (PCI DSS) Compliance in CockroachDB Advanced](https://docs.cockroachlabs.com/docs/cockroachcloud/pci-dss.md) #### Authentication - [Authentication on CockroachDB Cloud](https://docs.cockroachlabs.com/docs/cockroachcloud/authentication.md) - [Single Sign-On (SSO) for CockroachDB Cloud organizations](https://docs.cockroachlabs.com/docs/cockroachcloud/cloud-org-sso.md) - [Configure Cloud Organization SSO](https://docs.cockroachlabs.com/docs/cockroachcloud/configure-cloud-org-sso.md) - [Configure SCIM Provisioning](https://docs.cockroachlabs.com/docs/cockroachcloud/configure-scim-provisioning.md) - [Cluster Single Sign-on (SSO) using the Cloud Console](https://docs.cockroachlabs.com/docs/cockroachcloud/cloud-sso-sql.md) - [Multi-Factor Authentication for the CockroachDB Cloud Console](https://docs.cockroachlabs.com/docs/cockroachcloud/multi-factor-authentication.md) - [SQL Client Certificate Authentication for CockroachDB Advanced](https://docs.cockroachlabs.com/docs/cockroachcloud/client-certs-advanced.md) #### Authorization - [CockroachDB Cloud Access Management (Authorization) Overview](https://docs.cockroachlabs.com/docs/cockroachcloud/authorization.md) - [Manage Users, Roles, and Service Accounts](https://docs.cockroachlabs.com/docs/cockroachcloud/managing-access.md) - [Organize CockroachDB Cloud Clusters Using Folders](https://docs.cockroachlabs.com/docs/cockroachcloud/folders.md) - [Organize CockroachDB Cloud Resources Using Labels](https://docs.cockroachlabs.com/docs/cockroachcloud/labels.md) #### Network Authorization - [Network Authorization for CockroachDB Cloud](https://docs.cockroachlabs.com/docs/cockroachcloud/network-authorization.md) - [Create Private Clusters](https://docs.cockroachlabs.com/docs/cockroachcloud/private-clusters.md) - [Egress Perimeter Controls for CockroachDB Advanced](https://docs.cockroachlabs.com/docs/cockroachcloud/egress-perimeter-controls.md) - [Manage AWS PrivateLink](https://docs.cockroachlabs.com/docs/cockroachcloud/aws-privatelink.md) - [Configure Egress Private Endpoints](https://docs.cockroachlabs.com/docs/cockroachcloud/egress-private-endpoints.md) #### Audit Logs - [SQL Audit Logging](https://docs.cockroachlabs.com/docs/cockroachcloud/sql-audit-logging.md) - [Export CockroachDB Cloud Organization Audit Logs](https://docs.cockroachlabs.com/docs/cockroachcloud/cloud-org-audit-logs.md) - [Export Logs From a CockroachDB Standard Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/export-logs.md) - [Export Logs From a CockroachDB Advanced Cluster](https://docs.cockroachlabs.com/docs/cockroachcloud/export-logs-advanced.md) ## OpenAPI Specs - [latest](/openapi/cloud/latest.json) - [2024-09-16](/openapi/cloud/2024-09-16.json) - [2023-04-10](/openapi/cloud/2023-04-10.json) - [2022-09-20](/openapi/cloud/2022-09-20.json) - [2022-03-31](/openapi/cloud/2022-03-31.json)