GCP.AlloyDB reference

Backup

Source: src/GCP/AlloyDB/Backup.ts

An on-demand AlloyDB backup of a cluster.

Changing backupId, location, clusterName, type, encryptionConfig, tags, or description replaces the backup. displayName, labels, and annotations update in place.

Creating a backup typically takes several minutes and is skipIf-gated in live tests behind GCP_TEST_ALLOYDB.

Backup: Creating a Backup

On-demand backup of a cluster

const cluster = yield* GCP.AlloyDB.Cluster("AppDb", {
  pscConfig: { pscEnabled: true },
  automatedBackupPolicy: { enabled: false },
  continuousBackupConfig: { enabled: false },
});
const backup = yield* GCP.AlloyDB.Backup("Nightly", {
  clusterName: cluster.name,
  displayName: "nightly",
  labels: { env: "prod" },
});

Explicit id and description

const backup = yield* GCP.AlloyDB.Backup("Nightly", {
  clusterName: cluster.name,
  backupId: "app-db-nightly",
  displayName: "app-db-nightly",
  description: "manual snapshot",
});

Cluster

Source: src/GCP/AlloyDB/Cluster.ts

An AlloyDB for PostgreSQL cluster (regional storage layer).

Changing clusterId, location, network / networkConfig, encryptionConfig, clusterType, secondaryConfig, or pscConfig.pscEnabled replaces the cluster. A database version upgrade patches in place; a downgrade replaces.

Provisioning typically takes several minutes. Delete always sends force=true so child instances do not block teardown.

Cluster: Creating a Cluster

Generated name with Private Service Connect

const cluster = yield* GCP.AlloyDB.Cluster("AppDb", {
  location: "us-central1",
  pscConfig: { pscEnabled: true },
  initialUser: { user: "postgres", password: "change-me" },
  automatedBackupPolicy: { enabled: false },
  continuousBackupConfig: { enabled: false },
});

Explicit id, default VPC, and labels

const cluster = yield* GCP.AlloyDB.Cluster("AppDb", {
  clusterId: "app-db",
  location: "us-central1",
  network: "default",
  displayName: "app-db",
  labels: { env: "prod" },
  initialUser: { user: "postgres", password: "change-me" },
});

Cluster: Backups

const cluster = yield* GCP.AlloyDB.Cluster("AppDb", {
  pscConfig: { pscEnabled: true },
  automatedBackupPolicy: { enabled: false },
  continuousBackupConfig: { enabled: false },
});

ClustersUser

Source: src/GCP/AlloyDB/ClustersUser.ts

A database user on an AlloyDB cluster.

AlloyDB users have no labels field. list enumerates non-postgres users on alchemy-labeled clusters so pnpm nuke:gcp can find leaked rows without dropping the built-in superuser.

Changing cluster, location, userId, or userType replaces the user. password and databaseRoles update in place. Creating a built-in user requires a READY primary instance.

ClustersUser: Creating a User

Built-in user on a cluster

const cluster = yield* GCP.AlloyDB.Cluster("AppDb", {
  pscConfig: { pscEnabled: true },
  initialUser: { user: "postgres", password: "change-me" },
});
const primary = yield* GCP.AlloyDB.Instance("Primary", {
  cluster: cluster.name,
});
const appUser = yield* GCP.AlloyDB.ClustersUser("AppUser", {
  cluster: primary.clusterName,
  password: "change-me-too",
  databaseRoles: ["alloydbsuperuser"],
});

Explicit id and IAM user

const iamUser = yield* GCP.AlloyDB.ClustersUser("Analyst", {
  cluster: cluster.name,
  userId: "analyst@example.com",
  userType: "ALLOYDB_IAM_USER",
  databaseRoles: ["pg_read_all_data"],
});

GetBackup

Source: src/GCP/AlloyDB/GetBackup.ts

Runtime binding for AlloyDB backups.get.

Bind this operation to a Backup in a Function/Action init phase. Provide GetBackupHttp.

GetBackup: Observing Backups

const getBackup = yield* GCP.AlloyDB.GetBackup(backup);
const live = yield* getBackup();

GetBackupHttp

Source: src/GCP/AlloyDB/GetBackupHttp.ts Kind: Layer · Provides: GCP.AlloyDB.GetBackup

HTTP implementation of GetBackup.

GetCluster

Source: src/GCP/AlloyDB/GetCluster.ts

Runtime binding for AlloyDB clusters.get.

Bind this operation to a Cluster in a Function/Action init phase. Provide GetClusterHttp.

GetCluster: Observing Clusters

const getCluster = yield* GCP.AlloyDB.GetCluster(cluster);
const live = yield* getCluster();

GetClusterHttp

Source: src/GCP/AlloyDB/GetClusterHttp.ts Kind: Layer · Provides: GCP.AlloyDB.GetCluster

HTTP implementation of GetCluster.

GetConnectionInfo

Source: src/GCP/AlloyDB/GetConnectionInfo.ts

Runtime binding for AlloyDB instances.getConnectionInfo.

Bind this operation to an Instance in a Function/Action init phase. Provide GetConnectionInfoHttp.

GetConnectionInfo: Connection Info

const getConnectionInfo = yield* GCP.AlloyDB.GetConnectionInfo(primary);
const info = yield* getConnectionInfo();

GetConnectionInfoHttp

Source: src/GCP/AlloyDB/GetConnectionInfoHttp.ts Kind: Layer · Provides: GCP.AlloyDB.GetConnectionInfo

HTTP implementation of GetConnectionInfo.

GetInstance

Source: src/GCP/AlloyDB/GetInstance.ts

Runtime binding for AlloyDB instances.get.

Bind this operation to an Instance in a Function/Action init phase. Provide GetInstanceHttp.

GetInstance: Observing Instances

const getInstance = yield* GCP.AlloyDB.GetInstance(primary);
const live = yield* getInstance();

GetInstanceHttp

Source: src/GCP/AlloyDB/GetInstanceHttp.ts Kind: Layer · Provides: GCP.AlloyDB.GetInstance

HTTP implementation of GetInstance.

GetUser

Source: src/GCP/AlloyDB/GetUser.ts

Runtime binding for AlloyDB users.get.

Bind this operation to a ClustersUser in a Function/Action init phase. Provide GetUserHttp.

GetUser: Observing Users

const getUser = yield* GCP.AlloyDB.GetUser(appUser);
const live = yield* getUser();

GetUserHttp

Source: src/GCP/AlloyDB/GetUserHttp.ts Kind: Layer · Provides: GCP.AlloyDB.GetUser

HTTP implementation of GetUser.

Instance

Source: src/GCP/AlloyDB/Instance.ts

An AlloyDB instance (compute attached to a cluster).

Changing cluster, location, instanceId, or instanceType replaces the instance. Machine size, flags, labels, activation policy, and read-pool size update in place.

A cluster may exist without instances (EMPTY). Creating a PRIMARY instance typically takes several minutes.

Instance: Creating an Instance

Primary instance on a cluster

const cluster = yield* GCP.AlloyDB.Cluster("AppDb", {
  pscConfig: { pscEnabled: true },
});
const primary = yield* GCP.AlloyDB.Instance("Primary", {
  cluster: cluster.name,
  instanceType: "PRIMARY",
  machineConfig: { cpuCount: 2 },
});

Explicit id, display name, and labels

const primary = yield* GCP.AlloyDB.Instance("Primary", {
  cluster: cluster.name,
  instanceId: "app-db-primary",
  displayName: "app-db-primary",
  labels: { env: "prod" },
  machineConfig: { cpuCount: 2 },
});

Instance: Read Pool

const pool = yield* GCP.AlloyDB.Instance("Reads", {
  cluster: cluster.name,
  instanceType: "READ_POOL",
  readPoolConfig: { nodeCount: 2 },
  machineConfig: { cpuCount: 2 },
});