Back to Genai Toolbox

cloud-sql-create-backup

docs/en/integrations/cloud-sql-admin/tools/cloudsqlcreatebackup.md

1.1.02.0 KB
Original Source

About

The cloud-sql-create-backup tool creates an on-demand backup on a Cloud SQL instance using the Cloud SQL Admin API.

Compatible Sources

{{< compatible-sources >}}

Parameters

parametertyperequireddescription
projectstringtrueThe project ID.
instancestringtrueThe name of the instance to take a backup on. Does not include the project ID.
locationstringfalse(Optional) Location of the backup run.
backup_descriptionstringfalse(Optional) The description of this backup run.

Example

Basic backup creation (current state)

yaml
kind: tool
name: backup-creation-basic
type: cloud-sql-create-backup
source: cloud-sql-admin-source
description: "Creates a backup on the given Cloud SQL instance."

Reference

fieldtyperequireddescription
typestringtrueMust be "cloud-sql-create-backup".
sourcestringtrueThe name of the cloud-sql-admin source to use.
descriptionstringfalseA description of the tool.

Additional Resources