@pulumi/databricks 1.83.0-alpha.1768973755 → 1.83.0

package/postgresBranch.d.ts

@@ -2,7 +2,62 @@ import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "./types/input";
 import * as outputs from "./types/output";
 /**
- * [![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)
+ * [![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)
+ *
+ * ## Example Usage
+ *
+ * ### Basic Branch Creation
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const _this = new databricks.PostgresProject("this", {
+ *     projectId: "my-project",
+ *     spec: {
+ *         pgVersion: 17,
+ *         displayName: "My Project",
+ *     },
+ * });
+ * const dev = new databricks.PostgresBranch("dev", {
+ *     branchId: "dev-branch",
+ *     parent: _this.name,
+ *     spec: {
+ *         noExpiry: true,
+ *     },
+ * });
+ * ```
+ *
+ * ### Protected Branch
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const production = new databricks.PostgresBranch("production", {
+ *     branchId: "production",
+ *     parent: _this.name,
+ *     spec: {
+ *         isProtected: true,
+ *         noExpiry: true,
+ *     },
+ * });
+ * ```
+ *
+ * ### Branch with Expiration (TTL)
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const temporary = new databricks.PostgresBranch("temporary", {
+ *     branchId: "temp-feature-test",
+ *     parent: _this.name,
+ *     spec: {
+ *         ttl: "604800s",
+ *     },
+ * });
+ * ```
  *
  * ## Import
  *
@@ -41,10 +96,11 @@ export declare class PostgresBranch extends pulumi.CustomResource {
      */
     static isInstance(obj: any): obj is PostgresBranch;
     /**
-     * The ID to use for the Branch, which will become the final component of
-     * the branch's resource name.
-     *
-     * This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/
+     * The ID to use for the Branch. This becomes the final component of the branch's resource name.
+     * The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
+     * Examples:
+     * - With custom ID: `staging` → name becomes `projects/{project_id}/branches/staging`
+     * - Without custom ID: system generates slug → name becomes `projects/{project_id}/branches/br-example-name-x1y2z3a4`
      */
     readonly branchId: pulumi.Output<string>;
     /**
@@ -52,17 +108,20 @@ export declare class PostgresBranch extends pulumi.CustomResource {
      */
     readonly createTime: pulumi.Output<string>;
     /**
-     * (string) - The resource name of the branch.
-     * Format: projects/{project_id}/branches/{branch_id}
+     * (string) - The resource name of the branch. This field is output-only and constructed by the system.
+     * Format: `projects/{project_id}/branches/{branch_id}`
      */
     readonly name: pulumi.Output<string>;
     /**
-     * The project containing this branch.
+     * The project containing this branch (API resource hierarchy).
      * Format: projects/{project_id}
+     *
+     * Note: This field indicates where the branch exists in the resource hierarchy.
+     * For point-in-time branching from another branch, see `spec.source_branch`
      */
     readonly parent: pulumi.Output<string>;
     /**
-     * The desired state of a Branch
+     * The spec contains the branch configuration
      */
     readonly spec: pulumi.Output<outputs.PostgresBranchSpec>;
     /**
@@ -70,7 +129,7 @@ export declare class PostgresBranch extends pulumi.CustomResource {
      */
     readonly status: pulumi.Output<outputs.PostgresBranchStatus>;
     /**
-     * (string) - System generated unique ID for the branch
+     * (string) - System-generated unique ID for the branch
      */
     readonly uid: pulumi.Output<string>;
     /**
@@ -91,10 +150,11 @@ export declare class PostgresBranch extends pulumi.CustomResource {
  */
 export interface PostgresBranchState {
     /**
-     * The ID to use for the Branch, which will become the final component of
-     * the branch's resource name.
-     *
-     * This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/
+     * The ID to use for the Branch. This becomes the final component of the branch's resource name.
+     * The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
+     * Examples:
+     * - With custom ID: `staging` → name becomes `projects/{project_id}/branches/staging`
+     * - Without custom ID: system generates slug → name becomes `projects/{project_id}/branches/br-example-name-x1y2z3a4`
      */
     branchId?: pulumi.Input<string>;
     /**
@@ -102,17 +162,20 @@ export interface PostgresBranchState {
      */
     createTime?: pulumi.Input<string>;
     /**
-     * (string) - The resource name of the branch.
-     * Format: projects/{project_id}/branches/{branch_id}
+     * (string) - The resource name of the branch. This field is output-only and constructed by the system.
+     * Format: `projects/{project_id}/branches/{branch_id}`
      */
     name?: pulumi.Input<string>;
     /**
-     * The project containing this branch.
+     * The project containing this branch (API resource hierarchy).
      * Format: projects/{project_id}
+     *
+     * Note: This field indicates where the branch exists in the resource hierarchy.
+     * For point-in-time branching from another branch, see `spec.source_branch`
      */
     parent?: pulumi.Input<string>;
     /**
-     * The desired state of a Branch
+     * The spec contains the branch configuration
      */
     spec?: pulumi.Input<inputs.PostgresBranchSpec>;
     /**
@@ -120,7 +183,7 @@ export interface PostgresBranchState {
      */
     status?: pulumi.Input<inputs.PostgresBranchStatus>;
     /**
-     * (string) - System generated unique ID for the branch
+     * (string) - System-generated unique ID for the branch
      */
     uid?: pulumi.Input<string>;
     /**
@@ -133,19 +196,23 @@ export interface PostgresBranchState {
  */
 export interface PostgresBranchArgs {
     /**
-     * The ID to use for the Branch, which will become the final component of
-     * the branch's resource name.
-     *
-     * This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/
+     * The ID to use for the Branch. This becomes the final component of the branch's resource name.
+     * The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
+     * Examples:
+     * - With custom ID: `staging` → name becomes `projects/{project_id}/branches/staging`
+     * - Without custom ID: system generates slug → name becomes `projects/{project_id}/branches/br-example-name-x1y2z3a4`
      */
     branchId: pulumi.Input<string>;
     /**
-     * The project containing this branch.
+     * The project containing this branch (API resource hierarchy).
      * Format: projects/{project_id}
+     *
+     * Note: This field indicates where the branch exists in the resource hierarchy.
+     * For point-in-time branching from another branch, see `spec.source_branch`
      */
     parent: pulumi.Input<string>;
     /**
-     * The desired state of a Branch
+     * The spec contains the branch configuration
      */
     spec?: pulumi.Input<inputs.PostgresBranchSpec>;
 }

package/postgresBranch.js

@@ -6,7 +6,62 @@ exports.PostgresBranch = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
 /**
- * [![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)
+ * [![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)
+ *
+ * ## Example Usage
+ *
+ * ### Basic Branch Creation
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const _this = new databricks.PostgresProject("this", {
+ *     projectId: "my-project",
+ *     spec: {
+ *         pgVersion: 17,
+ *         displayName: "My Project",
+ *     },
+ * });
+ * const dev = new databricks.PostgresBranch("dev", {
+ *     branchId: "dev-branch",
+ *     parent: _this.name,
+ *     spec: {
+ *         noExpiry: true,
+ *     },
+ * });
+ * ```
+ *
+ * ### Protected Branch
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const production = new databricks.PostgresBranch("production", {
+ *     branchId: "production",
+ *     parent: _this.name,
+ *     spec: {
+ *         isProtected: true,
+ *         noExpiry: true,
+ *     },
+ * });
+ * ```
+ *
+ * ### Branch with Expiration (TTL)
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const temporary = new databricks.PostgresBranch("temporary", {
+ *     branchId: "temp-feature-test",
+ *     parent: _this.name,
+ *     spec: {
+ *         ttl: "604800s",
+ *     },
+ * });
+ * ```
  *
  * ## Import
  *

package/postgresBranch.js.map

@@ -1 +1 @@
-{"version":3,"file":"postgresBranch.js","sourceRoot":"","sources":["../postgresBranch.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,cAAe,SAAQ,MAAM,CAAC,cAAc;IACrD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA2B,EAAE,IAAmC;QACzH,OAAO,IAAI,cAAc,CAAC,IAAI,EAAO,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACrE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,cAAc,CAAC,YAAY,CAAC;IAC/D,CAAC;IAgDD,YAAY,IAAY,EAAE,WAAsD,EAAE,IAAmC;QACjH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA8C,CAAC;YAC7D,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC;YAC7C,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC;YACjD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC;YACnC,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC;SACpD;aAAM;YACH,MAAM,IAAI,GAAG,WAA6C,CAAC;YAC3D,IAAI,IAAI,EAAE,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC3C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,IAAI,IAAI,EAAE,MAAM,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC;YAC5C,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;YACxC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;YACpC,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACjD,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3C,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC1C,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACpD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,cAAc,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;;AA1GL,wCA2GC;AA7FG,gBAAgB;AACO,2BAAY,GAAG,gDAAgD,CAAC"}
+{"version":3,"file":"postgresBranch.js","sourceRoot":"","sources":["../postgresBranch.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;AACH,MAAa,cAAe,SAAQ,MAAM,CAAC,cAAc;IACrD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA2B,EAAE,IAAmC;QACzH,OAAO,IAAI,cAAc,CAAC,IAAI,EAAO,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACrE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,cAAc,CAAC,YAAY,CAAC;IAC/D,CAAC;IAoDD,YAAY,IAAY,EAAE,WAAsD,EAAE,IAAmC;QACjH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAA8C,CAAC;YAC7D,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC;YAC7C,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC;YACjD,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC;YACnC,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC;SACpD;aAAM;YACH,MAAM,IAAI,GAAG,WAA6C,CAAC;YAC3D,IAAI,IAAI,EAAE,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC3C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;aAC3D;YACD,IAAI,IAAI,EAAE,MAAM,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC;YAC5C,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;YACxC,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;YACpC,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACjD,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3C,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC1C,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACpD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,cAAc,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;;AA9GL,wCA+GC;AAjGG,gBAAgB;AACO,2BAAY,GAAG,gDAAgD,CAAC"}

package/postgresEndpoint.d.ts

@@ -2,7 +2,153 @@ import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "./types/input";
 import * as outputs from "./types/output";
 /**
- * [![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)
+ * [![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)
+ *
+ * ## Example Usage
+ *
+ * ### Basic Read-Write Endpoint
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const _this = new databricks.PostgresProject("this", {
+ *     projectId: "my-project",
+ *     spec: {
+ *         pgVersion: 17,
+ *         displayName: "My Project",
+ *     },
+ * });
+ * const dev = new databricks.PostgresBranch("dev", {
+ *     branchId: "dev-branch",
+ *     parent: _this.name,
+ *     spec: {
+ *         noExpiry: true,
+ *     },
+ * });
+ * const primary = new databricks.PostgresEndpoint("primary", {
+ *     endpointId: "primary",
+ *     parent: dev.name,
+ *     spec: {
+ *         endpointType: "ENDPOINT_TYPE_READ_WRITE",
+ *     },
+ * });
+ * ```
+ *
+ * ### Read-Only Endpoint with Autoscaling
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const readReplica = new databricks.PostgresEndpoint("read_replica", {
+ *     endpointId: "read-replica-1",
+ *     parent: dev.name,
+ *     spec: {
+ *         endpointType: "ENDPOINT_TYPE_READ_ONLY",
+ *         autoscalingLimitMinCu: 0.5,
+ *         autoscalingLimitMaxCu: 4,
+ *     },
+ * });
+ * ```
+ *
+ * ### Endpoint with Custom Autoscaling and Suspension
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const analytics = new databricks.PostgresEndpoint("analytics", {
+ *     endpointId: "analytics",
+ *     parent: dev.name,
+ *     spec: {
+ *         endpointType: "ENDPOINT_TYPE_READ_ONLY",
+ *         autoscalingLimitMinCu: 1,
+ *         autoscalingLimitMaxCu: 8,
+ *         suspendTimeoutDuration: "600s",
+ *     },
+ * });
+ * ```
+ *
+ * ### Disabled Endpoint
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const maintenance = new databricks.PostgresEndpoint("maintenance", {
+ *     endpointId: "primary",
+ *     parent: dev.name,
+ *     spec: {
+ *         endpointType: "ENDPOINT_TYPE_READ_WRITE",
+ *         disabled: true,
+ *     },
+ * });
+ * ```
+ *
+ * ### Endpoint with No Suspension
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const alwaysOn = new databricks.PostgresEndpoint("always_on", {
+ *     endpointId: "always-on",
+ *     parent: dev.name,
+ *     spec: {
+ *         endpointType: "ENDPOINT_TYPE_READ_WRITE",
+ *         noSuspension: true,
+ *     },
+ * });
+ * ```
+ *
+ * ### Complete Example
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as databricks from "@pulumi/databricks";
+ *
+ * const prod = new databricks.PostgresProject("prod", {
+ *     projectId: "production",
+ *     spec: {
+ *         pgVersion: 17,
+ *         displayName: "Production Workloads",
+ *         historyRetentionDuration: "2592000s",
+ *         defaultEndpointSettings: {
+ *             autoscalingLimitMinCu: 1,
+ *             autoscalingLimitMaxCu: 8,
+ *             suspendTimeoutDuration: "300s",
+ *         },
+ *     },
+ * });
+ * const main = new databricks.PostgresBranch("main", {
+ *     branchId: "main",
+ *     parent: prod.name,
+ *     spec: {
+ *         noExpiry: true,
+ *     },
+ * });
+ * const primary = new databricks.PostgresEndpoint("primary", {
+ *     endpointId: "primary",
+ *     parent: main.name,
+ *     spec: {
+ *         endpointType: "ENDPOINT_TYPE_READ_WRITE",
+ *         autoscalingLimitMinCu: 1,
+ *         autoscalingLimitMaxCu: 9,
+ *         noSuspension: true,
+ *     },
+ * });
+ * const readReplica = new databricks.PostgresEndpoint("read_replica", {
+ *     endpointId: "read-replica",
+ *     parent: main.name,
+ *     spec: {
+ *         endpointType: "ENDPOINT_TYPE_READ_ONLY",
+ *         autoscalingLimitMinCu: 0.5,
+ *         autoscalingLimitMaxCu: 8,
+ *         suspendTimeoutDuration: "600s",
+ *     },
+ * });
+ * ```
  *
  * ## Import
  *
@@ -45,32 +191,33 @@ export declare class PostgresEndpoint extends pulumi.CustomResource {
      */
     readonly createTime: pulumi.Output<string>;
     /**
-     * The ID to use for the Endpoint, which will become the final component of
-     * the endpoint's resource name.
-     *
-     * This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/
+     * The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
+     * The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
+     * Examples:
+     * - With custom ID: `primary` → name becomes `projects/{project_id}/branches/{branch_id}/endpoints/primary`
+     * - Without custom ID: system generates slug → name becomes `projects/{project_id}/branches/{branch_id}/endpoints/ep-example-name-x1y2z3a4`
      */
     readonly endpointId: pulumi.Output<string>;
     /**
-     * (string) - The resource name of the endpoint.
-     * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
+     * (string) - The resource name of the endpoint. This field is output-only and constructed by the system.
+     * Format: `projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`
      */
     readonly name: pulumi.Output<string>;
     /**
-     * The branch containing this endpoint.
+     * The branch containing this endpoint (API resource hierarchy).
      * Format: projects/{project_id}/branches/{branch_id}
      */
     readonly parent: pulumi.Output<string>;
     /**
-     * The desired state of an Endpoint
+     * The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
      */
     readonly spec: pulumi.Output<outputs.PostgresEndpointSpec>;
     /**
-     * (EndpointStatus) - The current status of an Endpoint
+     * (EndpointStatus) - Current operational status of the compute endpoint
      */
     readonly status: pulumi.Output<outputs.PostgresEndpointStatus>;
     /**
-     * (string) - System generated unique ID for the endpoint
+     * (string) - System-generated unique ID for the endpoint
      */
     readonly uid: pulumi.Output<string>;
     /**
@@ -95,32 +242,33 @@ export interface PostgresEndpointState {
      */
     createTime?: pulumi.Input<string>;
     /**
-     * The ID to use for the Endpoint, which will become the final component of
-     * the endpoint's resource name.
-     *
-     * This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/
+     * The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
+     * The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
+     * Examples:
+     * - With custom ID: `primary` → name becomes `projects/{project_id}/branches/{branch_id}/endpoints/primary`
+     * - Without custom ID: system generates slug → name becomes `projects/{project_id}/branches/{branch_id}/endpoints/ep-example-name-x1y2z3a4`
      */
     endpointId?: pulumi.Input<string>;
     /**
-     * (string) - The resource name of the endpoint.
-     * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
+     * (string) - The resource name of the endpoint. This field is output-only and constructed by the system.
+     * Format: `projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`
      */
     name?: pulumi.Input<string>;
     /**
-     * The branch containing this endpoint.
+     * The branch containing this endpoint (API resource hierarchy).
      * Format: projects/{project_id}/branches/{branch_id}
      */
     parent?: pulumi.Input<string>;
     /**
-     * The desired state of an Endpoint
+     * The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
      */
     spec?: pulumi.Input<inputs.PostgresEndpointSpec>;
     /**
-     * (EndpointStatus) - The current status of an Endpoint
+     * (EndpointStatus) - Current operational status of the compute endpoint
      */
     status?: pulumi.Input<inputs.PostgresEndpointStatus>;
     /**
-     * (string) - System generated unique ID for the endpoint
+     * (string) - System-generated unique ID for the endpoint
      */
     uid?: pulumi.Input<string>;
     /**
@@ -133,19 +281,20 @@ export interface PostgresEndpointState {
  */
 export interface PostgresEndpointArgs {
     /**
-     * The ID to use for the Endpoint, which will become the final component of
-     * the endpoint's resource name.
-     *
-     * This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/
+     * The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
+     * The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
+     * Examples:
+     * - With custom ID: `primary` → name becomes `projects/{project_id}/branches/{branch_id}/endpoints/primary`
+     * - Without custom ID: system generates slug → name becomes `projects/{project_id}/branches/{branch_id}/endpoints/ep-example-name-x1y2z3a4`
      */
     endpointId: pulumi.Input<string>;
     /**
-     * The branch containing this endpoint.
+     * The branch containing this endpoint (API resource hierarchy).
      * Format: projects/{project_id}/branches/{branch_id}
      */
     parent: pulumi.Input<string>;
     /**
-     * The desired state of an Endpoint
+     * The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
      */
     spec?: pulumi.Input<inputs.PostgresEndpointSpec>;
 }