spanner-create-instance

Create a Cloud Spanner instance.

The spanner-create-instance tool creates a new Cloud Spanner instance in a specified Google Cloud project.

Info

This tool uses the spanner-admin source.

Configuration

Here is an example of how to configure the spanner-create-instance tool in your tools.yaml file:

sources:
  my-spanner-admin-source:
    kind: spanner-admin

tools:
  create_my_spanner_instance:
    kind: spanner-create-instance
    source: my-spanner-admin-source
    description: "Creates a Spanner instance."

Parameters

The spanner-create-instance tool has the following parameters:

fieldtyperequireddescription
projectstringtrueThe Google Cloud project ID.
instanceIdstringtrueThe ID of the instance to create.
displayNamestringtrueThe display name of the instance.
configstringtrueThe instance configuration (e.g., regional-us-central1).
nodeCountintegertrueThe number of nodes. Mutually exclusive with processingUnits (one must be 0).
processingUnitsintegertrueThe number of processing units. Mutually exclusive with nodeCount (one must be 0).
editionstringfalseThe edition of the instance (STANDARD, ENTERPRISE, ENTERPRISE_PLUS).

Reference

fieldtyperequireddescription
kindstringtrueMust be spanner-create-instance.
sourcestringtrueThe name of the spanner-admin source to use for this tool.
descriptionstringfalseA description of the tool that is passed to the agent.