AlloyDB Admin Source

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-admin source provides a client to interact with the Google AlloyDB API. This allows tools to perform administrative tasks on AlloyDB resources, such as managing clusters, instances, and users.

Authentication can be handled in two ways:

Application Default Credentials (ADC): By default, the source uses ADC to authenticate with the API.
Client-side OAuth: If useClientOAuth is set to true, the source will expect an OAuth 2.0 access token to be provided by the client (e.g., a web browser) for each request.

Available Tools

AlloyDB Admin Source Tools

Tool Name	Description
alloydb-create-cluster	The "alloydb-create-cluster" tool creates a new AlloyDB for PostgreSQL cluster in a specified project and location.
alloydb-create-instance	The "alloydb-create-instance" tool creates a new AlloyDB instance within a specified cluster.
alloydb-get-cluster	The "alloydb-get-cluster" tool retrieves details for a specific AlloyDB cluster.
alloydb-get-instance	The "alloydb-get-instance" tool retrieves details for a specific AlloyDB instance.
alloydb-get-user	The "alloydb-get-user" tool retrieves details for a specific AlloyDB user.
alloydb-list-clusters	The "alloydb-list-clusters" tool lists the AlloyDB clusters in a given project and location.
alloydb-list-instances	The "alloydb-list-instances" tool lists the AlloyDB instances for a given project, cluster and location.
alloydb-list-users	The "alloydb-list-users" tool lists all database users within an AlloyDB cluster.
alloydb-create-user	The "alloydb-create-user" tool creates a new database user within a specified AlloyDB cluster.
alloydb-wait-for-operation	Wait for a long-running AlloyDB operation to complete.

Example

kind: source
name: my-alloydb-admin
type: alloydb-admin
---
kind: source
name: my-oauth-alloydb-admin
type: alloydb-admin
useClientOAuth: true

Reference