Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi
published on Tuesday, May 12, 2026 by Pulumi
Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi
published on Tuesday, May 12, 2026 by Pulumi
Example Usage
Managing Implicitly Created Read-Write Endpoint
A read-write endpoint named primary is implicitly created for every branch. Since Pulumi is declarative, managing an already-existing resource requires replaceExisting = true: it lets Pulumi represent the implicitly created endpoint in Pulumi state and immediately apply the provided configuration to it. Support for providing a custom endpointId will be available in later versions.
Pulumi uses this resource exclusively for managing updates. It does not control creation or deletion of the endpoint itself. Removing the resource from your Pulumi configuration only removes it from Pulumi state; the actual endpoint is unaffected, because its lifecycle is controlled by the parent branch. The only way to remove the actual endpoint is to delete the branch it belongs to. If you don’t want to delete the parent branch and are concerned about the cost, use the disabled or suspendTimeoutDuration fields in spec.
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",
autoscalingLimitMinCu: 0.5,
autoscalingLimitMaxCu: 4,
suspendTimeoutDuration: "600s",
},
replaceExisting: true,
});
import pulumi
import pulumi_databricks as databricks
this = databricks.PostgresProject("this",
project_id="my-project",
spec={
"pg_version": 17,
"display_name": "My Project",
})
dev = databricks.PostgresBranch("dev",
branch_id="dev-branch",
parent=this.name,
spec={
"no_expiry": True,
})
primary = databricks.PostgresEndpoint("primary",
endpoint_id="primary",
parent=dev.name,
spec={
"endpoint_type": "ENDPOINT_TYPE_READ_WRITE",
"autoscaling_limit_min_cu": 0.5,
"autoscaling_limit_max_cu": float(4),
"suspend_timeout_duration": "600s",
},
replace_existing=True)
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
this, err := databricks.NewPostgresProject(ctx, "this", &databricks.PostgresProjectArgs{
ProjectId: pulumi.String("my-project"),
Spec: &databricks.PostgresProjectSpecArgs{
PgVersion: pulumi.Int(17),
DisplayName: pulumi.String("My Project"),
},
})
if err != nil {
return err
}
dev, err := databricks.NewPostgresBranch(ctx, "dev", &databricks.PostgresBranchArgs{
BranchId: pulumi.String("dev-branch"),
Parent: this.Name,
Spec: &databricks.PostgresBranchSpecArgs{
NoExpiry: pulumi.Bool(true),
},
})
if err != nil {
return err
}
_, err = databricks.NewPostgresEndpoint(ctx, "primary", &databricks.PostgresEndpointArgs{
EndpointId: pulumi.String("primary"),
Parent: dev.Name,
Spec: &databricks.PostgresEndpointSpecArgs{
EndpointType: pulumi.String("ENDPOINT_TYPE_READ_WRITE"),
AutoscalingLimitMinCu: pulumi.Float64(0.5),
AutoscalingLimitMaxCu: pulumi.Float64(4),
SuspendTimeoutDuration: pulumi.String("600s"),
},
ReplaceExisting: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var @this = new Databricks.PostgresProject("this", new()
{
ProjectId = "my-project",
Spec = new Databricks.Inputs.PostgresProjectSpecArgs
{
PgVersion = 17,
DisplayName = "My Project",
},
});
var dev = new Databricks.PostgresBranch("dev", new()
{
BranchId = "dev-branch",
Parent = @this.Name,
Spec = new Databricks.Inputs.PostgresBranchSpecArgs
{
NoExpiry = true,
},
});
var primary = new Databricks.PostgresEndpoint("primary", new()
{
EndpointId = "primary",
Parent = dev.Name,
Spec = new Databricks.Inputs.PostgresEndpointSpecArgs
{
EndpointType = "ENDPOINT_TYPE_READ_WRITE",
AutoscalingLimitMinCu = 0.5,
AutoscalingLimitMaxCu = 4,
SuspendTimeoutDuration = "600s",
},
ReplaceExisting = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.PostgresProject;
import com.pulumi.databricks.PostgresProjectArgs;
import com.pulumi.databricks.inputs.PostgresProjectSpecArgs;
import com.pulumi.databricks.PostgresBranch;
import com.pulumi.databricks.PostgresBranchArgs;
import com.pulumi.databricks.inputs.PostgresBranchSpecArgs;
import com.pulumi.databricks.PostgresEndpoint;
import com.pulumi.databricks.PostgresEndpointArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var this_ = new PostgresProject("this", PostgresProjectArgs.builder()
.projectId("my-project")
.spec(PostgresProjectSpecArgs.builder()
.pgVersion(17)
.displayName("My Project")
.build())
.build());
var dev = new PostgresBranch("dev", PostgresBranchArgs.builder()
.branchId("dev-branch")
.parent(this_.name())
.spec(PostgresBranchSpecArgs.builder()
.noExpiry(true)
.build())
.build());
var primary = new PostgresEndpoint("primary", PostgresEndpointArgs.builder()
.endpointId("primary")
.parent(dev.name())
.spec(PostgresEndpointSpecArgs.builder()
.endpointType("ENDPOINT_TYPE_READ_WRITE")
.autoscalingLimitMinCu(0.5)
.autoscalingLimitMaxCu(4.0)
.suspendTimeoutDuration("600s")
.build())
.replaceExisting(true)
.build());
}
}
resources:
this:
type: databricks:PostgresProject
properties:
projectId: my-project
spec:
pgVersion: 17
displayName: My Project
dev:
type: databricks:PostgresBranch
properties:
branchId: dev-branch
parent: ${this.name}
spec:
noExpiry: true
primary:
type: databricks:PostgresEndpoint
properties:
endpointId: primary
parent: ${dev.name}
spec:
endpointType: ENDPOINT_TYPE_READ_WRITE
autoscalingLimitMinCu: 0.5
autoscalingLimitMaxCu: 4
suspendTimeoutDuration: 600s
replaceExisting: true
Example coming soon!
Read-Only Endpoint with Autoscaling
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,
},
});
import pulumi
import pulumi_databricks as databricks
read_replica = databricks.PostgresEndpoint("read_replica",
endpoint_id="read-replica-1",
parent=dev["name"],
spec={
"endpoint_type": "ENDPOINT_TYPE_READ_ONLY",
"autoscaling_limit_min_cu": 0.5,
"autoscaling_limit_max_cu": float(4),
})
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databricks.NewPostgresEndpoint(ctx, "read_replica", &databricks.PostgresEndpointArgs{
EndpointId: pulumi.String("read-replica-1"),
Parent: pulumi.Any(dev.Name),
Spec: &databricks.PostgresEndpointSpecArgs{
EndpointType: pulumi.String("ENDPOINT_TYPE_READ_ONLY"),
AutoscalingLimitMinCu: pulumi.Float64(0.5),
AutoscalingLimitMaxCu: pulumi.Float64(4),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var readReplica = new Databricks.PostgresEndpoint("read_replica", new()
{
EndpointId = "read-replica-1",
Parent = dev.Name,
Spec = new Databricks.Inputs.PostgresEndpointSpecArgs
{
EndpointType = "ENDPOINT_TYPE_READ_ONLY",
AutoscalingLimitMinCu = 0.5,
AutoscalingLimitMaxCu = 4,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.PostgresEndpoint;
import com.pulumi.databricks.PostgresEndpointArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var readReplica = new PostgresEndpoint("readReplica", PostgresEndpointArgs.builder()
.endpointId("read-replica-1")
.parent(dev.name())
.spec(PostgresEndpointSpecArgs.builder()
.endpointType("ENDPOINT_TYPE_READ_ONLY")
.autoscalingLimitMinCu(0.5)
.autoscalingLimitMaxCu(4.0)
.build())
.build());
}
}
resources:
readReplica:
type: databricks:PostgresEndpoint
name: read_replica
properties:
endpointId: read-replica-1
parent: ${dev.name}
spec:
endpointType: ENDPOINT_TYPE_READ_ONLY
autoscalingLimitMinCu: 0.5
autoscalingLimitMaxCu: 4
Example coming soon!
Endpoint with Custom Autoscaling and Suspension
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",
},
});
import pulumi
import pulumi_databricks as databricks
analytics = databricks.PostgresEndpoint("analytics",
endpoint_id="analytics",
parent=dev["name"],
spec={
"endpoint_type": "ENDPOINT_TYPE_READ_ONLY",
"autoscaling_limit_min_cu": float(1),
"autoscaling_limit_max_cu": float(8),
"suspend_timeout_duration": "600s",
})
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databricks.NewPostgresEndpoint(ctx, "analytics", &databricks.PostgresEndpointArgs{
EndpointId: pulumi.String("analytics"),
Parent: pulumi.Any(dev.Name),
Spec: &databricks.PostgresEndpointSpecArgs{
EndpointType: pulumi.String("ENDPOINT_TYPE_READ_ONLY"),
AutoscalingLimitMinCu: pulumi.Float64(1),
AutoscalingLimitMaxCu: pulumi.Float64(8),
SuspendTimeoutDuration: pulumi.String("600s"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var analytics = new Databricks.PostgresEndpoint("analytics", new()
{
EndpointId = "analytics",
Parent = dev.Name,
Spec = new Databricks.Inputs.PostgresEndpointSpecArgs
{
EndpointType = "ENDPOINT_TYPE_READ_ONLY",
AutoscalingLimitMinCu = 1,
AutoscalingLimitMaxCu = 8,
SuspendTimeoutDuration = "600s",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.PostgresEndpoint;
import com.pulumi.databricks.PostgresEndpointArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var analytics = new PostgresEndpoint("analytics", PostgresEndpointArgs.builder()
.endpointId("analytics")
.parent(dev.name())
.spec(PostgresEndpointSpecArgs.builder()
.endpointType("ENDPOINT_TYPE_READ_ONLY")
.autoscalingLimitMinCu(1.0)
.autoscalingLimitMaxCu(8.0)
.suspendTimeoutDuration("600s")
.build())
.build());
}
}
resources:
analytics:
type: databricks:PostgresEndpoint
properties:
endpointId: analytics
parent: ${dev.name}
spec:
endpointType: ENDPOINT_TYPE_READ_ONLY
autoscalingLimitMinCu: 1
autoscalingLimitMaxCu: 8
suspendTimeoutDuration: 600s
Example coming soon!
Disabled Endpoint
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,
},
});
import pulumi
import pulumi_databricks as databricks
maintenance = databricks.PostgresEndpoint("maintenance",
endpoint_id="primary",
parent=dev["name"],
spec={
"endpoint_type": "ENDPOINT_TYPE_READ_WRITE",
"disabled": True,
})
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databricks.NewPostgresEndpoint(ctx, "maintenance", &databricks.PostgresEndpointArgs{
EndpointId: pulumi.String("primary"),
Parent: pulumi.Any(dev.Name),
Spec: &databricks.PostgresEndpointSpecArgs{
EndpointType: pulumi.String("ENDPOINT_TYPE_READ_WRITE"),
Disabled: pulumi.Bool(true),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var maintenance = new Databricks.PostgresEndpoint("maintenance", new()
{
EndpointId = "primary",
Parent = dev.Name,
Spec = new Databricks.Inputs.PostgresEndpointSpecArgs
{
EndpointType = "ENDPOINT_TYPE_READ_WRITE",
Disabled = true,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.PostgresEndpoint;
import com.pulumi.databricks.PostgresEndpointArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var maintenance = new PostgresEndpoint("maintenance", PostgresEndpointArgs.builder()
.endpointId("primary")
.parent(dev.name())
.spec(PostgresEndpointSpecArgs.builder()
.endpointType("ENDPOINT_TYPE_READ_WRITE")
.disabled(true)
.build())
.build());
}
}
resources:
maintenance:
type: databricks:PostgresEndpoint
properties:
endpointId: primary
parent: ${dev.name}
spec:
endpointType: ENDPOINT_TYPE_READ_WRITE
disabled: true
Example coming soon!
Endpoint with No Suspension
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,
},
});
import pulumi
import pulumi_databricks as databricks
always_on = databricks.PostgresEndpoint("always_on",
endpoint_id="always-on",
parent=dev["name"],
spec={
"endpoint_type": "ENDPOINT_TYPE_READ_WRITE",
"no_suspension": True,
})
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databricks.NewPostgresEndpoint(ctx, "always_on", &databricks.PostgresEndpointArgs{
EndpointId: pulumi.String("always-on"),
Parent: pulumi.Any(dev.Name),
Spec: &databricks.PostgresEndpointSpecArgs{
EndpointType: pulumi.String("ENDPOINT_TYPE_READ_WRITE"),
NoSuspension: pulumi.Bool(true),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var alwaysOn = new Databricks.PostgresEndpoint("always_on", new()
{
EndpointId = "always-on",
Parent = dev.Name,
Spec = new Databricks.Inputs.PostgresEndpointSpecArgs
{
EndpointType = "ENDPOINT_TYPE_READ_WRITE",
NoSuspension = true,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.PostgresEndpoint;
import com.pulumi.databricks.PostgresEndpointArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var alwaysOn = new PostgresEndpoint("alwaysOn", PostgresEndpointArgs.builder()
.endpointId("always-on")
.parent(dev.name())
.spec(PostgresEndpointSpecArgs.builder()
.endpointType("ENDPOINT_TYPE_READ_WRITE")
.noSuspension(true)
.build())
.build());
}
}
resources:
alwaysOn:
type: databricks:PostgresEndpoint
name: always_on
properties:
endpointId: always-on
parent: ${dev.name}
spec:
endpointType: ENDPOINT_TYPE_READ_WRITE
noSuspension: true
Example coming soon!
High Availability Endpoint
Configure a single endpoint with multiple compute instances for high availability. One compute instance acts as the read-write primary, while the remaining secondary compute instances stand ready for automatic failover.
High availability requires scale-to-zero to be disabled.
Set noSuspension = true in spec as shown in the example below.
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const haPrimary = new databricks.PostgresEndpoint("ha_primary", {
endpointId: "primary",
parent: dev.name,
spec: {
endpointType: "ENDPOINT_TYPE_READ_WRITE",
noSuspension: true,
autoscalingLimitMinCu: 0.5,
autoscalingLimitMaxCu: 4,
group: {
min: 2,
max: 2,
},
},
replaceExisting: true,
});
import pulumi
import pulumi_databricks as databricks
ha_primary = databricks.PostgresEndpoint("ha_primary",
endpoint_id="primary",
parent=dev["name"],
spec={
"endpoint_type": "ENDPOINT_TYPE_READ_WRITE",
"no_suspension": True,
"autoscaling_limit_min_cu": 0.5,
"autoscaling_limit_max_cu": float(4),
"group": {
"min": 2,
"max": 2,
},
},
replace_existing=True)
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databricks.NewPostgresEndpoint(ctx, "ha_primary", &databricks.PostgresEndpointArgs{
EndpointId: pulumi.String("primary"),
Parent: pulumi.Any(dev.Name),
Spec: &databricks.PostgresEndpointSpecArgs{
EndpointType: pulumi.String("ENDPOINT_TYPE_READ_WRITE"),
NoSuspension: pulumi.Bool(true),
AutoscalingLimitMinCu: pulumi.Float64(0.5),
AutoscalingLimitMaxCu: pulumi.Float64(4),
Group: &databricks.PostgresEndpointSpecGroupArgs{
Min: pulumi.Int(2),
Max: pulumi.Int(2),
},
},
ReplaceExisting: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var haPrimary = new Databricks.PostgresEndpoint("ha_primary", new()
{
EndpointId = "primary",
Parent = dev.Name,
Spec = new Databricks.Inputs.PostgresEndpointSpecArgs
{
EndpointType = "ENDPOINT_TYPE_READ_WRITE",
NoSuspension = true,
AutoscalingLimitMinCu = 0.5,
AutoscalingLimitMaxCu = 4,
Group = new Databricks.Inputs.PostgresEndpointSpecGroupArgs
{
Min = 2,
Max = 2,
},
},
ReplaceExisting = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.PostgresEndpoint;
import com.pulumi.databricks.PostgresEndpointArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var haPrimary = new PostgresEndpoint("haPrimary", PostgresEndpointArgs.builder()
.endpointId("primary")
.parent(dev.name())
.spec(PostgresEndpointSpecArgs.builder()
.endpointType("ENDPOINT_TYPE_READ_WRITE")
.noSuspension(true)
.autoscalingLimitMinCu(0.5)
.autoscalingLimitMaxCu(4.0)
.group(PostgresEndpointSpecGroupArgs.builder()
.min(2)
.max(2)
.build())
.build())
.replaceExisting(true)
.build());
}
}
resources:
haPrimary:
type: databricks:PostgresEndpoint
name: ha_primary
properties:
endpointId: primary
parent: ${dev.name}
spec:
endpointType: ENDPOINT_TYPE_READ_WRITE
noSuspension: true
autoscalingLimitMinCu: 0.5
autoscalingLimitMaxCu: 4
group:
min: 2
max: 2
replaceExisting: true # for managing implicitly created read-write endpoint
Example coming soon!
High Availability Endpoint with Readable Secondaries
Enable readable secondaries to offload read traffic to replica computes via a
dedicated read-only host, in addition to hot-standby failover. Only supported
on read-write endpoints with more than one compute. The secondaries are optionally
exposed as read-only host via enableReadableSecondaries.
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const haReadable = new databricks.PostgresEndpoint("ha_readable", {
endpointId: "primary",
parent: dev.name,
spec: {
endpointType: "ENDPOINT_TYPE_READ_WRITE",
noSuspension: true,
autoscalingLimitMinCu: 0.5,
autoscalingLimitMaxCu: 4,
group: {
min: 2,
max: 2,
enableReadableSecondaries: true,
},
},
replaceExisting: true,
});
import pulumi
import pulumi_databricks as databricks
ha_readable = databricks.PostgresEndpoint("ha_readable",
endpoint_id="primary",
parent=dev["name"],
spec={
"endpoint_type": "ENDPOINT_TYPE_READ_WRITE",
"no_suspension": True,
"autoscaling_limit_min_cu": 0.5,
"autoscaling_limit_max_cu": float(4),
"group": {
"min": 2,
"max": 2,
"enable_readable_secondaries": True,
},
},
replace_existing=True)
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databricks.NewPostgresEndpoint(ctx, "ha_readable", &databricks.PostgresEndpointArgs{
EndpointId: pulumi.String("primary"),
Parent: pulumi.Any(dev.Name),
Spec: &databricks.PostgresEndpointSpecArgs{
EndpointType: pulumi.String("ENDPOINT_TYPE_READ_WRITE"),
NoSuspension: pulumi.Bool(true),
AutoscalingLimitMinCu: pulumi.Float64(0.5),
AutoscalingLimitMaxCu: pulumi.Float64(4),
Group: &databricks.PostgresEndpointSpecGroupArgs{
Min: pulumi.Int(2),
Max: pulumi.Int(2),
EnableReadableSecondaries: pulumi.Bool(true),
},
},
ReplaceExisting: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var haReadable = new Databricks.PostgresEndpoint("ha_readable", new()
{
EndpointId = "primary",
Parent = dev.Name,
Spec = new Databricks.Inputs.PostgresEndpointSpecArgs
{
EndpointType = "ENDPOINT_TYPE_READ_WRITE",
NoSuspension = true,
AutoscalingLimitMinCu = 0.5,
AutoscalingLimitMaxCu = 4,
Group = new Databricks.Inputs.PostgresEndpointSpecGroupArgs
{
Min = 2,
Max = 2,
EnableReadableSecondaries = true,
},
},
ReplaceExisting = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.PostgresEndpoint;
import com.pulumi.databricks.PostgresEndpointArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var haReadable = new PostgresEndpoint("haReadable", PostgresEndpointArgs.builder()
.endpointId("primary")
.parent(dev.name())
.spec(PostgresEndpointSpecArgs.builder()
.endpointType("ENDPOINT_TYPE_READ_WRITE")
.noSuspension(true)
.autoscalingLimitMinCu(0.5)
.autoscalingLimitMaxCu(4.0)
.group(PostgresEndpointSpecGroupArgs.builder()
.min(2)
.max(2)
.enableReadableSecondaries(true)
.build())
.build())
.replaceExisting(true)
.build());
}
}
resources:
haReadable:
type: databricks:PostgresEndpoint
name: ha_readable
properties:
endpointId: primary
parent: ${dev.name}
spec:
endpointType: ENDPOINT_TYPE_READ_WRITE
noSuspension: true
autoscalingLimitMinCu: 0.5
autoscalingLimitMaxCu: 4
group:
min: 2
max: 2
enableReadableSecondaries: true
replaceExisting: true # for managing implicitly created read-write endpoint
Example coming soon!
Complete Example
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: "86400s",
},
},
});
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,
group: {
min: 2,
max: 2,
enableReadableSecondaries: true,
},
},
replaceExisting: 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 pulumi
import pulumi_databricks as databricks
prod = databricks.PostgresProject("prod",
project_id="production",
spec={
"pg_version": 17,
"display_name": "Production Workloads",
"history_retention_duration": "2592000s",
"default_endpoint_settings": {
"autoscaling_limit_min_cu": float(1),
"autoscaling_limit_max_cu": float(8),
"suspend_timeout_duration": "86400s",
},
})
main = databricks.PostgresBranch("main",
branch_id="main",
parent=prod.name,
spec={
"no_expiry": True,
})
primary = databricks.PostgresEndpoint("primary",
endpoint_id="primary",
parent=main.name,
spec={
"endpoint_type": "ENDPOINT_TYPE_READ_WRITE",
"autoscaling_limit_min_cu": float(1),
"autoscaling_limit_max_cu": float(9),
"no_suspension": True,
"group": {
"min": 2,
"max": 2,
"enable_readable_secondaries": True,
},
},
replace_existing=True)
read_replica = databricks.PostgresEndpoint("read_replica",
endpoint_id="read-replica",
parent=main.name,
spec={
"endpoint_type": "ENDPOINT_TYPE_READ_ONLY",
"autoscaling_limit_min_cu": 0.5,
"autoscaling_limit_max_cu": float(8),
"suspend_timeout_duration": "600s",
})
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
prod, err := databricks.NewPostgresProject(ctx, "prod", &databricks.PostgresProjectArgs{
ProjectId: pulumi.String("production"),
Spec: &databricks.PostgresProjectSpecArgs{
PgVersion: pulumi.Int(17),
DisplayName: pulumi.String("Production Workloads"),
HistoryRetentionDuration: pulumi.String("2592000s"),
DefaultEndpointSettings: &databricks.PostgresProjectSpecDefaultEndpointSettingsArgs{
AutoscalingLimitMinCu: pulumi.Float64(1),
AutoscalingLimitMaxCu: pulumi.Float64(8),
SuspendTimeoutDuration: pulumi.String("86400s"),
},
},
})
if err != nil {
return err
}
main, err := databricks.NewPostgresBranch(ctx, "main", &databricks.PostgresBranchArgs{
BranchId: pulumi.String("main"),
Parent: prod.Name,
Spec: &databricks.PostgresBranchSpecArgs{
NoExpiry: pulumi.Bool(true),
},
})
if err != nil {
return err
}
_, err = databricks.NewPostgresEndpoint(ctx, "primary", &databricks.PostgresEndpointArgs{
EndpointId: pulumi.String("primary"),
Parent: main.Name,
Spec: &databricks.PostgresEndpointSpecArgs{
EndpointType: pulumi.String("ENDPOINT_TYPE_READ_WRITE"),
AutoscalingLimitMinCu: pulumi.Float64(1),
AutoscalingLimitMaxCu: pulumi.Float64(9),
NoSuspension: pulumi.Bool(true),
Group: &databricks.PostgresEndpointSpecGroupArgs{
Min: pulumi.Int(2),
Max: pulumi.Int(2),
EnableReadableSecondaries: pulumi.Bool(true),
},
},
ReplaceExisting: pulumi.Bool(true),
})
if err != nil {
return err
}
_, err = databricks.NewPostgresEndpoint(ctx, "read_replica", &databricks.PostgresEndpointArgs{
EndpointId: pulumi.String("read-replica"),
Parent: main.Name,
Spec: &databricks.PostgresEndpointSpecArgs{
EndpointType: pulumi.String("ENDPOINT_TYPE_READ_ONLY"),
AutoscalingLimitMinCu: pulumi.Float64(0.5),
AutoscalingLimitMaxCu: pulumi.Float64(8),
SuspendTimeoutDuration: pulumi.String("600s"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var prod = new Databricks.PostgresProject("prod", new()
{
ProjectId = "production",
Spec = new Databricks.Inputs.PostgresProjectSpecArgs
{
PgVersion = 17,
DisplayName = "Production Workloads",
HistoryRetentionDuration = "2592000s",
DefaultEndpointSettings = new Databricks.Inputs.PostgresProjectSpecDefaultEndpointSettingsArgs
{
AutoscalingLimitMinCu = 1,
AutoscalingLimitMaxCu = 8,
SuspendTimeoutDuration = "86400s",
},
},
});
var main = new Databricks.PostgresBranch("main", new()
{
BranchId = "main",
Parent = prod.Name,
Spec = new Databricks.Inputs.PostgresBranchSpecArgs
{
NoExpiry = true,
},
});
var primary = new Databricks.PostgresEndpoint("primary", new()
{
EndpointId = "primary",
Parent = main.Name,
Spec = new Databricks.Inputs.PostgresEndpointSpecArgs
{
EndpointType = "ENDPOINT_TYPE_READ_WRITE",
AutoscalingLimitMinCu = 1,
AutoscalingLimitMaxCu = 9,
NoSuspension = true,
Group = new Databricks.Inputs.PostgresEndpointSpecGroupArgs
{
Min = 2,
Max = 2,
EnableReadableSecondaries = true,
},
},
ReplaceExisting = true,
});
var readReplica = new Databricks.PostgresEndpoint("read_replica", new()
{
EndpointId = "read-replica",
Parent = main.Name,
Spec = new Databricks.Inputs.PostgresEndpointSpecArgs
{
EndpointType = "ENDPOINT_TYPE_READ_ONLY",
AutoscalingLimitMinCu = 0.5,
AutoscalingLimitMaxCu = 8,
SuspendTimeoutDuration = "600s",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.PostgresProject;
import com.pulumi.databricks.PostgresProjectArgs;
import com.pulumi.databricks.inputs.PostgresProjectSpecArgs;
import com.pulumi.databricks.inputs.PostgresProjectSpecDefaultEndpointSettingsArgs;
import com.pulumi.databricks.PostgresBranch;
import com.pulumi.databricks.PostgresBranchArgs;
import com.pulumi.databricks.inputs.PostgresBranchSpecArgs;
import com.pulumi.databricks.PostgresEndpoint;
import com.pulumi.databricks.PostgresEndpointArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecArgs;
import com.pulumi.databricks.inputs.PostgresEndpointSpecGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var prod = new PostgresProject("prod", PostgresProjectArgs.builder()
.projectId("production")
.spec(PostgresProjectSpecArgs.builder()
.pgVersion(17)
.displayName("Production Workloads")
.historyRetentionDuration("2592000s")
.defaultEndpointSettings(PostgresProjectSpecDefaultEndpointSettingsArgs.builder()
.autoscalingLimitMinCu(1.0)
.autoscalingLimitMaxCu(8.0)
.suspendTimeoutDuration("86400s")
.build())
.build())
.build());
var main = new PostgresBranch("main", PostgresBranchArgs.builder()
.branchId("main")
.parent(prod.name())
.spec(PostgresBranchSpecArgs.builder()
.noExpiry(true)
.build())
.build());
var primary = new PostgresEndpoint("primary", PostgresEndpointArgs.builder()
.endpointId("primary")
.parent(main.name())
.spec(PostgresEndpointSpecArgs.builder()
.endpointType("ENDPOINT_TYPE_READ_WRITE")
.autoscalingLimitMinCu(1.0)
.autoscalingLimitMaxCu(9.0)
.noSuspension(true)
.group(PostgresEndpointSpecGroupArgs.builder()
.min(2)
.max(2)
.enableReadableSecondaries(true)
.build())
.build())
.replaceExisting(true)
.build());
var readReplica = new PostgresEndpoint("readReplica", PostgresEndpointArgs.builder()
.endpointId("read-replica")
.parent(main.name())
.spec(PostgresEndpointSpecArgs.builder()
.endpointType("ENDPOINT_TYPE_READ_ONLY")
.autoscalingLimitMinCu(0.5)
.autoscalingLimitMaxCu(8.0)
.suspendTimeoutDuration("600s")
.build())
.build());
}
}
resources:
prod:
type: databricks:PostgresProject
properties:
projectId: production
spec:
pgVersion: 17
displayName: Production Workloads
historyRetentionDuration: 2592000s
defaultEndpointSettings:
autoscalingLimitMinCu: 1
autoscalingLimitMaxCu: 8
suspendTimeoutDuration: 86400s
main:
type: databricks:PostgresBranch
properties:
branchId: main
parent: ${prod.name}
spec:
noExpiry: true
primary:
type: databricks:PostgresEndpoint
properties:
endpointId: primary
parent: ${main.name}
spec:
endpointType: ENDPOINT_TYPE_READ_WRITE
autoscalingLimitMinCu: 1
autoscalingLimitMaxCu: 9
noSuspension: true
group:
min: 2
max: 2
enableReadableSecondaries: true
replaceExisting: true
readReplica:
type: databricks:PostgresEndpoint
name: read_replica
properties:
endpointId: read-replica
parent: ${main.name}
spec:
endpointType: ENDPOINT_TYPE_READ_ONLY
autoscalingLimitMinCu: 0.5
autoscalingLimitMaxCu: 8
suspendTimeoutDuration: 600s
Example coming soon!
Create PostgresEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PostgresEndpoint(name: string, args: PostgresEndpointArgs, opts?: CustomResourceOptions);@overload
def PostgresEndpoint(resource_name: str,
args: PostgresEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PostgresEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
endpoint_id: Optional[str] = None,
parent: Optional[str] = None,
provider_config: Optional[PostgresEndpointProviderConfigArgs] = None,
replace_existing: Optional[bool] = None,
spec: Optional[PostgresEndpointSpecArgs] = None)func NewPostgresEndpoint(ctx *Context, name string, args PostgresEndpointArgs, opts ...ResourceOption) (*PostgresEndpoint, error)public PostgresEndpoint(string name, PostgresEndpointArgs args, CustomResourceOptions? opts = null)
public PostgresEndpoint(String name, PostgresEndpointArgs args)
public PostgresEndpoint(String name, PostgresEndpointArgs args, CustomResourceOptions options)
type: databricks:PostgresEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "databricks_postgresendpoint" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args PostgresEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PostgresEndpointArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PostgresEndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PostgresEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PostgresEndpointArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var postgresEndpointResource = new Databricks.PostgresEndpoint("postgresEndpointResource", new()
{
EndpointId = "string",
Parent = "string",
ProviderConfig = new Databricks.Inputs.PostgresEndpointProviderConfigArgs
{
WorkspaceId = "string",
},
ReplaceExisting = false,
Spec = new Databricks.Inputs.PostgresEndpointSpecArgs
{
EndpointType = "string",
AutoscalingLimitMaxCu = 0,
AutoscalingLimitMinCu = 0,
Disabled = false,
Group = new Databricks.Inputs.PostgresEndpointSpecGroupArgs
{
Max = 0,
Min = 0,
EnableReadableSecondaries = false,
},
NoSuspension = false,
Settings = new Databricks.Inputs.PostgresEndpointSpecSettingsArgs
{
PgSettings =
{
{ "string", "string" },
},
},
SuspendTimeoutDuration = "string",
},
});
example, err := databricks.NewPostgresEndpoint(ctx, "postgresEndpointResource", &databricks.PostgresEndpointArgs{
EndpointId: pulumi.String("string"),
Parent: pulumi.String("string"),
ProviderConfig: &databricks.PostgresEndpointProviderConfigArgs{
WorkspaceId: pulumi.String("string"),
},
ReplaceExisting: pulumi.Bool(false),
Spec: &databricks.PostgresEndpointSpecArgs{
EndpointType: pulumi.String("string"),
AutoscalingLimitMaxCu: pulumi.Float64(0),
AutoscalingLimitMinCu: pulumi.Float64(0),
Disabled: pulumi.Bool(false),
Group: &databricks.PostgresEndpointSpecGroupArgs{
Max: pulumi.Int(0),
Min: pulumi.Int(0),
EnableReadableSecondaries: pulumi.Bool(false),
},
NoSuspension: pulumi.Bool(false),
Settings: &databricks.PostgresEndpointSpecSettingsArgs{
PgSettings: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
SuspendTimeoutDuration: pulumi.String("string"),
},
})
resource "databricks_postgresendpoint" "postgresEndpointResource" {
endpoint_id = "string"
parent = "string"
provider_config = {
workspace_id = "string"
}
replace_existing = false
spec = {
endpoint_type = "string"
autoscaling_limit_max_cu = 0
autoscaling_limit_min_cu = 0
disabled = false
group = {
max = 0
min = 0
enable_readable_secondaries = false
}
no_suspension = false
settings = {
pg_settings = {
"string" = "string"
}
}
suspend_timeout_duration = "string"
}
}
var postgresEndpointResource = new PostgresEndpoint("postgresEndpointResource", PostgresEndpointArgs.builder()
.endpointId("string")
.parent("string")
.providerConfig(PostgresEndpointProviderConfigArgs.builder()
.workspaceId("string")
.build())
.replaceExisting(false)
.spec(PostgresEndpointSpecArgs.builder()
.endpointType("string")
.autoscalingLimitMaxCu(0.0)
.autoscalingLimitMinCu(0.0)
.disabled(false)
.group(PostgresEndpointSpecGroupArgs.builder()
.max(0)
.min(0)
.enableReadableSecondaries(false)
.build())
.noSuspension(false)
.settings(PostgresEndpointSpecSettingsArgs.builder()
.pgSettings(Map.of("string", "string"))
.build())
.suspendTimeoutDuration("string")
.build())
.build());
postgres_endpoint_resource = databricks.PostgresEndpoint("postgresEndpointResource",
endpoint_id="string",
parent="string",
provider_config={
"workspace_id": "string",
},
replace_existing=False,
spec={
"endpoint_type": "string",
"autoscaling_limit_max_cu": float(0),
"autoscaling_limit_min_cu": float(0),
"disabled": False,
"group": {
"max": 0,
"min": 0,
"enable_readable_secondaries": False,
},
"no_suspension": False,
"settings": {
"pg_settings": {
"string": "string",
},
},
"suspend_timeout_duration": "string",
})
const postgresEndpointResource = new databricks.PostgresEndpoint("postgresEndpointResource", {
endpointId: "string",
parent: "string",
providerConfig: {
workspaceId: "string",
},
replaceExisting: false,
spec: {
endpointType: "string",
autoscalingLimitMaxCu: 0,
autoscalingLimitMinCu: 0,
disabled: false,
group: {
max: 0,
min: 0,
enableReadableSecondaries: false,
},
noSuspension: false,
settings: {
pgSettings: {
string: "string",
},
},
suspendTimeoutDuration: "string",
},
});
type: databricks:PostgresEndpoint
properties:
endpointId: string
parent: string
providerConfig:
workspaceId: string
replaceExisting: false
spec:
autoscalingLimitMaxCu: 0
autoscalingLimitMinCu: 0
disabled: false
endpointType: string
group:
enableReadableSecondaries: false
max: 0
min: 0
noSuspension: false
settings:
pgSettings:
string: string
suspendTimeoutDuration: string
PostgresEndpoint Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PostgresEndpoint resource accepts the following input properties:
- Endpoint
Id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - Parent string
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- Provider
Config PostgresEndpoint Provider Config - Configure the provider for management through account provider.
- Replace
Existing bool - If true, update the endpoint if it already exists instead of returning an error
- Spec
Postgres
Endpoint Spec - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- Endpoint
Id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - Parent string
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- Provider
Config PostgresEndpoint Provider Config Args - Configure the provider for management through account provider.
- Replace
Existing bool - If true, update the endpoint if it already exists instead of returning an error
- Spec
Postgres
Endpoint Spec Args - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- endpoint_
id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - parent string
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- provider_
config object - Configure the provider for management through account provider.
- replace_
existing bool - If true, update the endpoint if it already exists instead of returning an error
- spec object
- The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- endpoint
Id String - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - parent String
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- provider
Config PostgresEndpoint Provider Config - Configure the provider for management through account provider.
- replace
Existing Boolean - If true, update the endpoint if it already exists instead of returning an error
- spec
Postgres
Endpoint Spec - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- endpoint
Id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - parent string
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- provider
Config PostgresEndpoint Provider Config - Configure the provider for management through account provider.
- replace
Existing boolean - If true, update the endpoint if it already exists instead of returning an error
- spec
Postgres
Endpoint Spec - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- endpoint_
id str - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - parent str
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- provider_
config PostgresEndpoint Provider Config Args - Configure the provider for management through account provider.
- replace_
existing bool - If true, update the endpoint if it already exists instead of returning an error
- spec
Postgres
Endpoint Spec Args - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- endpoint
Id String - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - parent String
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- provider
Config Property Map - Configure the provider for management through account provider.
- replace
Existing Boolean - If true, update the endpoint if it already exists instead of returning an error
- spec Property Map
- The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
Outputs
All input properties are implicitly available as output properties. Additionally, the PostgresEndpoint resource produces the following output properties:
- Create
Time string - (string) - A timestamp indicating when the compute endpoint was created
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- Status
Postgres
Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- Uid string
- (string) - System-generated unique ID for the endpoint
- Update
Time string - (string) - A timestamp indicating when the compute endpoint was last updated
- Create
Time string - (string) - A timestamp indicating when the compute endpoint was created
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- Status
Postgres
Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- Uid string
- (string) - System-generated unique ID for the endpoint
- Update
Time string - (string) - A timestamp indicating when the compute endpoint was last updated
- create_
time string - (string) - A timestamp indicating when the compute endpoint was created
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- status object
- (EndpointStatus) - Current operational status of the compute endpoint
- uid string
- (string) - System-generated unique ID for the endpoint
- update_
time string - (string) - A timestamp indicating when the compute endpoint was last updated
- create
Time String - (string) - A timestamp indicating when the compute endpoint was created
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- status
Postgres
Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- uid String
- (string) - System-generated unique ID for the endpoint
- update
Time String - (string) - A timestamp indicating when the compute endpoint was last updated
- create
Time string - (string) - A timestamp indicating when the compute endpoint was created
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- status
Postgres
Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- uid string
- (string) - System-generated unique ID for the endpoint
- update
Time string - (string) - A timestamp indicating when the compute endpoint was last updated
- create_
time str - (string) - A timestamp indicating when the compute endpoint was created
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- status
Postgres
Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- uid str
- (string) - System-generated unique ID for the endpoint
- update_
time str - (string) - A timestamp indicating when the compute endpoint was last updated
- create
Time String - (string) - A timestamp indicating when the compute endpoint was created
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- status Property Map
- (EndpointStatus) - Current operational status of the compute endpoint
- uid String
- (string) - System-generated unique ID for the endpoint
- update
Time String - (string) - A timestamp indicating when the compute endpoint was last updated
Look up Existing PostgresEndpoint Resource
Get an existing PostgresEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PostgresEndpointState, opts?: CustomResourceOptions): PostgresEndpoint@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
endpoint_id: Optional[str] = None,
name: Optional[str] = None,
parent: Optional[str] = None,
provider_config: Optional[PostgresEndpointProviderConfigArgs] = None,
replace_existing: Optional[bool] = None,
spec: Optional[PostgresEndpointSpecArgs] = None,
status: Optional[PostgresEndpointStatusArgs] = None,
uid: Optional[str] = None,
update_time: Optional[str] = None) -> PostgresEndpointfunc GetPostgresEndpoint(ctx *Context, name string, id IDInput, state *PostgresEndpointState, opts ...ResourceOption) (*PostgresEndpoint, error)public static PostgresEndpoint Get(string name, Input<string> id, PostgresEndpointState? state, CustomResourceOptions? opts = null)public static PostgresEndpoint get(String name, Output<String> id, PostgresEndpointState state, CustomResourceOptions options)resources: _: type: databricks:PostgresEndpoint get: id: ${id}import {
to = databricks_postgresendpoint.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Create
Time string - (string) - A timestamp indicating when the compute endpoint was created
- Endpoint
Id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - Name string
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- Parent string
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- Provider
Config PostgresEndpoint Provider Config - Configure the provider for management through account provider.
- Replace
Existing bool - If true, update the endpoint if it already exists instead of returning an error
- Spec
Postgres
Endpoint Spec - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- Status
Postgres
Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- Uid string
- (string) - System-generated unique ID for the endpoint
- Update
Time string - (string) - A timestamp indicating when the compute endpoint was last updated
- Create
Time string - (string) - A timestamp indicating when the compute endpoint was created
- Endpoint
Id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - Name string
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- Parent string
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- Provider
Config PostgresEndpoint Provider Config Args - Configure the provider for management through account provider.
- Replace
Existing bool - If true, update the endpoint if it already exists instead of returning an error
- Spec
Postgres
Endpoint Spec Args - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- Status
Postgres
Endpoint Status Args - (EndpointStatus) - Current operational status of the compute endpoint
- Uid string
- (string) - System-generated unique ID for the endpoint
- Update
Time string - (string) - A timestamp indicating when the compute endpoint was last updated
- create_
time string - (string) - A timestamp indicating when the compute endpoint was created
- endpoint_
id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - name string
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- parent string
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- provider_
config object - Configure the provider for management through account provider.
- replace_
existing bool - If true, update the endpoint if it already exists instead of returning an error
- spec object
- The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status object
- (EndpointStatus) - Current operational status of the compute endpoint
- uid string
- (string) - System-generated unique ID for the endpoint
- update_
time string - (string) - A timestamp indicating when the compute endpoint was last updated
- create
Time String - (string) - A timestamp indicating when the compute endpoint was created
- endpoint
Id String - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - name String
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- parent String
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- provider
Config PostgresEndpoint Provider Config - Configure the provider for management through account provider.
- replace
Existing Boolean - If true, update the endpoint if it already exists instead of returning an error
- spec
Postgres
Endpoint Spec - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status
Postgres
Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- uid String
- (string) - System-generated unique ID for the endpoint
- update
Time String - (string) - A timestamp indicating when the compute endpoint was last updated
- create
Time string - (string) - A timestamp indicating when the compute endpoint was created
- endpoint
Id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - name string
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- parent string
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- provider
Config PostgresEndpoint Provider Config - Configure the provider for management through account provider.
- replace
Existing boolean - If true, update the endpoint if it already exists instead of returning an error
- spec
Postgres
Endpoint Spec - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status
Postgres
Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- uid string
- (string) - System-generated unique ID for the endpoint
- update
Time string - (string) - A timestamp indicating when the compute endpoint was last updated
- create_
time str - (string) - A timestamp indicating when the compute endpoint was created
- endpoint_
id str - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - name str
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- parent str
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- provider_
config PostgresEndpoint Provider Config Args - Configure the provider for management through account provider.
- replace_
existing bool - If true, update the endpoint if it already exists instead of returning an error
- spec
Postgres
Endpoint Spec Args - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status
Postgres
Endpoint Status Args - (EndpointStatus) - Current operational status of the compute endpoint
- uid str
- (string) - System-generated unique ID for the endpoint
- update_
time str - (string) - A timestamp indicating when the compute endpoint was last updated
- create
Time String - (string) - A timestamp indicating when the compute endpoint was created
- endpoint
Id String - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - name String
- (string) - Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- parent String
- The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- provider
Config Property Map - Configure the provider for management through account provider.
- replace
Existing Boolean - If true, update the endpoint if it already exists instead of returning an error
- spec Property Map
- The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status Property Map
- (EndpointStatus) - Current operational status of the compute endpoint
- uid String
- (string) - System-generated unique ID for the endpoint
- update
Time String - (string) - A timestamp indicating when the compute endpoint was last updated
Supporting Types
PostgresEndpointProviderConfig, PostgresEndpointProviderConfigArgs
- Workspace
Id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- Workspace
Id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace_
id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace
Id String - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace
Id string - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace_
id str - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
- workspace
Id String - Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
PostgresEndpointSpec, PostgresEndpointSpecArgs
- Endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - Autoscaling
Limit doubleMax Cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- Autoscaling
Limit doubleMin Cu - (number) - The minimum number of Compute Units
- Disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- Group
Postgres
Endpoint Spec Group - (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- No
Suspension bool - When set to true, explicitly disables automatic suspension (never suspend).
Should be set to true when provided.
Mutually exclusive with
suspendTimeoutDuration. When updating, usespec.suspensionin the update_mask - Settings
Postgres
Endpoint Spec Settings - (EndpointSettings)
- Suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- Endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - Autoscaling
Limit float64Max Cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- Autoscaling
Limit float64Min Cu - (number) - The minimum number of Compute Units
- Disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- Group
Postgres
Endpoint Spec Group - (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- No
Suspension bool - When set to true, explicitly disables automatic suspension (never suspend).
Should be set to true when provided.
Mutually exclusive with
suspendTimeoutDuration. When updating, usespec.suspensionin the update_mask - Settings
Postgres
Endpoint Spec Settings - (EndpointSettings)
- Suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- endpoint_
type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - autoscaling_
limit_ numbermax_ cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- autoscaling_
limit_ numbermin_ cu - (number) - The minimum number of Compute Units
- disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- group object
- (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- no_
suspension bool - When set to true, explicitly disables automatic suspension (never suspend).
Should be set to true when provided.
Mutually exclusive with
suspendTimeoutDuration. When updating, usespec.suspensionin the update_mask - settings object
- (EndpointSettings)
- suspend_
timeout_ stringduration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- endpoint
Type String - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - autoscaling
Limit DoubleMax Cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- autoscaling
Limit DoubleMin Cu - (number) - The minimum number of Compute Units
- disabled Boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- group
Postgres
Endpoint Spec Group - (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- no
Suspension Boolean - When set to true, explicitly disables automatic suspension (never suspend).
Should be set to true when provided.
Mutually exclusive with
suspendTimeoutDuration. When updating, usespec.suspensionin the update_mask - settings
Postgres
Endpoint Spec Settings - (EndpointSettings)
- suspend
Timeout StringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - autoscaling
Limit numberMax Cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- autoscaling
Limit numberMin Cu - (number) - The minimum number of Compute Units
- disabled boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- group
Postgres
Endpoint Spec Group - (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- no
Suspension boolean - When set to true, explicitly disables automatic suspension (never suspend).
Should be set to true when provided.
Mutually exclusive with
suspendTimeoutDuration. When updating, usespec.suspensionin the update_mask - settings
Postgres
Endpoint Spec Settings - (EndpointSettings)
- suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- endpoint_
type str - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - autoscaling_
limit_ floatmax_ cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- autoscaling_
limit_ floatmin_ cu - (number) - The minimum number of Compute Units
- disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- group
Postgres
Endpoint Spec Group - (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- no_
suspension bool - When set to true, explicitly disables automatic suspension (never suspend).
Should be set to true when provided.
Mutually exclusive with
suspendTimeoutDuration. When updating, usespec.suspensionin the update_mask - settings
Postgres
Endpoint Spec Settings - (EndpointSettings)
- suspend_
timeout_ strduration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- endpoint
Type String - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - autoscaling
Limit NumberMax Cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- autoscaling
Limit NumberMin Cu - (number) - The minimum number of Compute Units
- disabled Boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- group Property Map
- (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- no
Suspension Boolean - When set to true, explicitly disables automatic suspension (never suspend).
Should be set to true when provided.
Mutually exclusive with
suspendTimeoutDuration. When updating, usespec.suspensionin the update_mask - settings Property Map
- (EndpointSettings)
- suspend
Timeout StringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
PostgresEndpointSpecGroup, PostgresEndpointSpecGroupArgs
- Max int
- Min int
- Enable
Readable boolSecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- Max int
- Min int
- Enable
Readable boolSecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- max number
- min number
- enable_
readable_ boolsecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- max Integer
- min Integer
- enable
Readable BooleanSecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- max number
- min number
- enable
Readable booleanSecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- max int
- min int
- enable_
readable_ boolsecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- max Number
- min Number
- enable
Readable BooleanSecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
PostgresEndpointSpecSettings, PostgresEndpointSpecSettingsArgs
- Pg
Settings Dictionary<string, string> - A raw representation of Postgres settings
- Pg
Settings map[string]string - A raw representation of Postgres settings
- pg_
settings map(string) - A raw representation of Postgres settings
- pg
Settings Map<String,String> - A raw representation of Postgres settings
- pg
Settings {[key: string]: string} - A raw representation of Postgres settings
- pg_
settings Mapping[str, str] - A raw representation of Postgres settings
- pg
Settings Map<String> - A raw representation of Postgres settings
PostgresEndpointStatus, PostgresEndpointStatusArgs
- Autoscaling
Limit doubleMax Cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- Autoscaling
Limit doubleMin Cu - (number) - The minimum number of Compute Units
- Current
State string - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - Disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- Endpoint
Id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - Endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - Group
Postgres
Endpoint Status Group - (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- Hosts
Postgres
Endpoint Status Hosts - (EndpointHosts) - Contains host information for connecting to the endpoint
- Pending
State string - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - Settings
Postgres
Endpoint Status Settings - (EndpointSettings)
- Suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- Autoscaling
Limit float64Max Cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- Autoscaling
Limit float64Min Cu - (number) - The minimum number of Compute Units
- Current
State string - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - Disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- Endpoint
Id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - Endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - Group
Postgres
Endpoint Status Group - (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- Hosts
Postgres
Endpoint Status Hosts - (EndpointHosts) - Contains host information for connecting to the endpoint
- Pending
State string - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - Settings
Postgres
Endpoint Status Settings - (EndpointSettings)
- Suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- autoscaling_
limit_ numbermax_ cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- autoscaling_
limit_ numbermin_ cu - (number) - The minimum number of Compute Units
- current_
state string - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- endpoint_
id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - endpoint_
type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - group object
- (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- hosts object
- (EndpointHosts) - Contains host information for connecting to the endpoint
- pending_
state string - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - settings object
- (EndpointSettings)
- suspend_
timeout_ stringduration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- autoscaling
Limit DoubleMax Cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- autoscaling
Limit DoubleMin Cu - (number) - The minimum number of Compute Units
- current
State String - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - disabled Boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- endpoint
Id String - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - endpoint
Type String - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - group
Postgres
Endpoint Status Group - (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- hosts
Postgres
Endpoint Status Hosts - (EndpointHosts) - Contains host information for connecting to the endpoint
- pending
State String - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - settings
Postgres
Endpoint Status Settings - (EndpointSettings)
- suspend
Timeout StringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- autoscaling
Limit numberMax Cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- autoscaling
Limit numberMin Cu - (number) - The minimum number of Compute Units
- current
State string - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - disabled boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- endpoint
Id string - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - group
Postgres
Endpoint Status Group - (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- hosts
Postgres
Endpoint Status Hosts - (EndpointHosts) - Contains host information for connecting to the endpoint
- pending
State string - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - settings
Postgres
Endpoint Status Settings - (EndpointSettings)
- suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- autoscaling_
limit_ floatmax_ cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- autoscaling_
limit_ floatmin_ cu - (number) - The minimum number of Compute Units
- current_
state str - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- endpoint_
id str - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - endpoint_
type str - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - group
Postgres
Endpoint Status Group - (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- hosts
Postgres
Endpoint Status Hosts - (EndpointHosts) - Contains host information for connecting to the endpoint
- pending_
state str - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - settings
Postgres
Endpoint Status Settings - (EndpointSettings)
- suspend_
timeout_ strduration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- autoscaling
Limit NumberMax Cu - (number) - The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16
- autoscaling
Limit NumberMin Cu - (number) - The minimum number of Compute Units
- current
State String - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - disabled Boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- endpoint
Id String - The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
For example,
primarybecomesprojects/my-app/branches/development/endpoints/primary - endpoint
Type String - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - group Property Map
- (EndpointGroupStatus) - Details on the HA configuration of the endpoint
- hosts Property Map
- (EndpointHosts) - Contains host information for connecting to the endpoint
- pending
State String - (string) - Possible values are:
ACTIVE,DEGRADED,IDLE,INIT - settings Property Map
- (EndpointSettings)
- suspend
Timeout StringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
PostgresEndpointStatusGroup, PostgresEndpointStatusGroupArgs
- Max int
- Min int
- Enable
Readable boolSecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- Max int
- Min int
- Enable
Readable boolSecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- max number
- min number
- enable_
readable_ boolsecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- max Integer
- min Integer
- enable
Readable BooleanSecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- max number
- min number
- enable
Readable booleanSecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- max int
- min int
- enable_
readable_ boolsecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
- max Number
- min Number
- enable
Readable BooleanSecondaries - (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
PostgresEndpointStatusHosts, PostgresEndpointStatusHostsArgs
- Host string
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- Read
Only stringHost - (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
- Host string
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- Read
Only stringHost - (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
- host string
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- read_
only_ stringhost - (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
- host String
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- read
Only StringHost - (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
- host string
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- read
Only stringHost - (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
- host str
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- read_
only_ strhost - (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
- host String
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- read
Only StringHost - (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
PostgresEndpointStatusSettings, PostgresEndpointStatusSettingsArgs
- Pg
Settings Dictionary<string, string> - A raw representation of Postgres settings
- Pg
Settings map[string]string - A raw representation of Postgres settings
- pg_
settings map(string) - A raw representation of Postgres settings
- pg
Settings Map<String,String> - A raw representation of Postgres settings
- pg
Settings {[key: string]: string} - A raw representation of Postgres settings
- pg_
settings Mapping[str, str] - A raw representation of Postgres settings
- pg
Settings Map<String> - A raw representation of Postgres settings
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi
published on Tuesday, May 12, 2026 by Pulumi
