AlloyDB Admin

The “alloydb-admin” source provides a client for the AlloyDB API.

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:

  1. Application Default Credentials (ADC): By default, the source uses ADC to authenticate with the API.
  2. 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.

Example

sources:
    my-alloydb-admin:
        kind: alloy-admin

    my-oauth-alloydb-admin:
        kind: alloydb-admin
        useClientOAuth: true

Reference

fieldtyperequireddescription
kindstringtrueMust be “alloydb-admin”.
useClientOAuthbooleanfalseIf true, the source will use client-side OAuth for authorization. Otherwise, it will use Application Default Credentials. Defaults to false.
Last modified September 11, 2025: feat: add alloydb admin source (#1369) (33beb7187d)