Viewing docs for pgEdge v0.0.43
published on Monday, May 4, 2026 by pgEdge
published on Monday, May 4, 2026 by pgEdge
pgEdge
I want to use the Pulumi pgEdge package (pgedge) in my project.
## Provider details
- Package: pgedge
- Version: v0.0.43
- Publisher: pgEdge
- Source: pulumi
- Repository: https://github.com/pgEdge/pulumi-pgedge
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/pgedge/pgedge/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/pgedge/pgedge/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/pgedge/pgedge/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/pgedge/pgedge/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for pgEdge v0.0.43
published on Monday, May 4, 2026 by pgEdge
published on Monday, May 4, 2026 by pgEdge
pgEdge Provider
The official Pulumi provider for pgEdge Cloud, designed to simplify the management of pgEdge Cloud resources for both Developers and Enterprise edition.
Authentication
Before using the provider, you must create an API Client in pgEdge Cloud and configure the following environment variables:
export PGEDGE_CLIENT_ID="your-client-id"
export PGEDGE_CLIENT_SECRET="your-client-secret"
These credentials authenticate the Pulumi provider with your pgEdge Cloud account
Example Usage
Developer Edition Configuration
For Developer Edition, pgEdge offers access to manage databases. Here’s an example setup for Developer Edition:
import * as pulumi from "@pulumi/pulumi";
import * as pgedge from "@pgEdge/pulumi-pgedge";
// Define a database
const defaultdb = new pgedge.Database("defaultdb", {
name: "defaultdb",
clusterId: "f12239ddq-df9d-4ded-adqwead9-3e2bvhe6d6ee",
options: [
"rest:enabled",
"install:northwind"
]
});
Enterprise Edition Configuration
Enterprise Edition users can manage Cloud Accounts, SSH keys, Backup Stores, and Clusters. Here’s an Enterprise Edition example:
import * as pulumi from "@pulumi/pulumi";
import * as pgedge from "@pgEdge/pulumi-pgedge";
// Create an SSH Key
const sshKey = new pgedge.SSHKey("exampleSSHKey", {
name: "example",
publicKey: "ssh-ed25519 AAAAC3NzaC1lZsdw877237ICXfT63i04t5fvvlGesddwed21VG7DkyxvyXbYQNhKP/rSeLY user@example.com",
});
// Create a Cloud Account
const cloudAccount = new pgedge.CloudAccount("exampleCloudAccount", {
name: "my-aws-account",
type: "aws",
description: "My AWS Cloud Account",
credentials: {
role_arn: "arn:aws:iam::21112529deae39:role/pgedge-135232c",
},
}, { dependsOn: sshKey });
// Create a Backup Store
const backupStore = new pgedge.BackupStore("exampleBackupStore", {
name: "example",
cloudAccountId: cloudAccount.id,
region: "us-west-2",
}, { dependsOn: cloudAccount });
// Create a Cluster
const cluster = new pgedge.Cluster("exampleCluster", {
name: "example",
cloudAccountId: cloudAccount.id,
regions: ["us-west-2", "us-east-1", "eu-central-1"],
nodeLocation: "public",
sshKeyId: sshKey.id,
nodes: [
{
name: "n1",
region: "us-west-2",
instanceType: "r6g.medium",
volumeSize: 100,
volumeType: "gp2",
},
{
name: "n2",
region: "us-east-1",
instanceType: "r6g.medium",
volumeSize: 100,
volumeType: "gp2",
},
{
name: "n3",
region: "eu-central-1",
instanceType: "r6g.medium",
volumeSize: 100,
volumeType: "gp2",
},
],
networks: [
{
region: "us-west-2",
cidr: "10.1.0.0/16",
publicSubnets: ["10.1.0.0/24"],
// privateSubnets: ["10.1.0.0/24"],
},
{
region: "us-east-1",
cidr: "10.2.0.0/16",
publicSubnets: ["10.2.0.0/24"],
// privateSubnets: ["10.2.0.0/24"],
},
{
region: "eu-central-1",
cidr: "10.3.0.0/16",
publicSubnets: ["10.3.0.0/24"],
// privateSubnets: ["10.3.0.0/24"],
},
],
backupStoreIds: [backupStore.id],
firewallRules: [
{
name: "postgres",
port: 5432,
sources: ["123.456.789.0/32"],
},
],
}, { dependsOn: backupStore });
// Create a Database
const database = new pgedge.Database("exampleDatabase", {
name: "example",
clusterId: cluster.id,
options: [
"autoddl:enabled",
// "install:northwind",
// "rest:enabled",
// "cloudwatch_metrics:enabled",
],
extensions: {
autoManage: true,
requesteds: [
"postgis",
"vector",
],
},
nodes:{
n1: {
name: "n1",
},
n2: {
name: "n2",
},
n3: {
name: "n3",
},
},
backups: {
provider: "pgbackrest",
configs: [
{
id: "default",
schedules: [
{
id: "daily-full-backup",
cronExpression: "0 1 * * *",
type: "full",
},
{
id: "hourly-incr-backup",
cronExpression: "0 * * * ?",
type: "incr",
},
]
},
]
},
}, { dependsOn: cluster });
// Export the resource IDs
export const sshKeyId = sshKey.id;
export const cloudAccountId = cloudAccount.id;
export const backupStoreId = backupStore.id;
export const clusterId = cluster.id;
export const databaseId = database.id;
You could find more complete and detailed examples in the pulumi-pgedge repository
Viewing docs for pgEdge v0.0.43
published on Monday, May 4, 2026 by pgEdge
published on Monday, May 4, 2026 by pgEdge