cloud-sql-clone-instance Tool
Clone a Cloud SQL instance.
2 minute read
About
The cloud-sql-clone-instance tool clones a Cloud SQL instance using the Cloud SQL Admin API.
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| Cloud SQL Admin Source |
Example
Basic clone (current state)
kind: tools
name: clone-instance-basic
type: cloud-sql-clone-instance
source: cloud-sql-admin-source
description: "Creates an exact copy of a Cloud SQL instance. Supports configuring instance zones and high-availability setup through zone preferences."
Point-in-time recovery (PITR) clone
kind: tools
name: clone-instance-pitr
type: cloud-sql-clone-instance
source: cloud-sql-admin-source
description: "Creates an exact copy of a Cloud SQL instance at a specific point in time (PITR). Supports configuring instance zones and high-availability setup through zone preferences"
Reference
Tool Configuration
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “cloud-sql-clone-instance”. |
| source | string | true | The name of the cloud-sql-admin source to use. |
| description | string | false | A description of the tool. |
Tool Inputs
| parameter | type | required | description |
|---|---|---|---|
| project | string | true | The project ID. |
| sourceInstanceName | string | true | The name of the source instance to clone. |
| destinationInstanceName | string | true | The name of the new (cloned) instance. |
| pointInTime | string | false | (Optional) The point in time for a PITR (Point-In-Time Recovery) clone. |
| preferredZone | string | false | (Optional) The preferred zone for the cloned instance. If not specified, defaults to the source instance’s zone. |
| preferredSecondaryZone | string | false | (Optional) The preferred secondary zone for the cloned instance (for HA). |
Advanced Usage
- The tool supports both basic clone and point-in-time recovery (PITR) clone operations.
- For PITR, specify the
pointInTimeparameter in RFC3339 format (e.g.,2024-01-01T00:00:00Z). - The source must be a valid Cloud SQL Admin API source.
- You can optionally specify the
zoneparameter to set the zone for the cloned instance. If omitted, the zone of the source instance will be used. - You can optionally specify the
preferredZoneandpreferredSecondaryZone(only in REGIONAL instances) to set the preferred zones for the cloned instance. These are useful for high availability (HA) configurations. If omitted, defaults will be used based on the source instance.
Additional Resources
- Cloud SQL Admin API documentation
- Toolbox Cloud SQL tools documentation
- Cloud SQL Clone API documentation
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.