AlloyDB Admin Source
The “alloydb-admin” source provides a client for the AlloyDB API.
2 minute read
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
useClientOAuthis set totrue, 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 Tool | The "alloydb-create-cluster" tool creates a new AlloyDB for PostgreSQL cluster in a specified project and location. |
| alloydb-create-instance Tool | The "alloydb-create-instance" tool creates a new AlloyDB instance within a specified cluster. |
| alloydb-get-cluster Tool | The "alloydb-get-cluster" tool retrieves details for a specific AlloyDB cluster. |
| alloydb-get-instance Tool | The "alloydb-get-instance" tool retrieves details for a specific AlloyDB instance. |
| alloydb-get-user Tool | The "alloydb-get-user" tool retrieves details for a specific AlloyDB user. |
| alloydb-list-clusters Tool | The "alloydb-list-clusters" tool lists the AlloyDB clusters in a given project and location. |
| alloydb-list-instances Tool | The "alloydb-list-instances" tool lists the AlloyDB instances for a given project, cluster and location. |
| alloydb-list-users Tool | The "alloydb-list-users" tool lists all database users within an AlloyDB cluster. |
| alloydb-create-user Tool | The "alloydb-create-user" tool creates a new database user within a specified AlloyDB cluster. |
| alloydb-wait-for-operation Tool | Wait for a long-running AlloyDB operation to complete. |
Example
kind: sources
name: my-alloydb-admin
type: alloydb-admin
---
kind: sources
name: my-oauth-alloydb-admin
type: alloydb-admin
useClientOAuth: true
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “alloydb-admin”. |
| defaultProject | string | false | The Google Cloud project ID to use for AlloyDB infrastructure tools. |
| useClientOAuth | boolean | false | If true, the source will use client-side OAuth for authorization. Otherwise, it will use Application Default Credentials. Defaults to false. |
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.