Example Usage
Basic Project Creation
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 Application Project",
},
});
import pulumi
import pulumi_databricks as databricks
this = databricks.PostgresProject("this",
project_id="my-project",
spec={
"pg_version": 17,
"display_name": "My Application Project",
})
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.NewPostgresProject(ctx, "this", &databricks.PostgresProjectArgs{
ProjectId: pulumi.String("my-project"),
Spec: &databricks.PostgresProjectSpecArgs{
PgVersion: pulumi.Int(17),
DisplayName: pulumi.String("My Application Project"),
},
})
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 Application Project",
},
});
});
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 java.util.List;
import java.util.ArrayList;
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 Application Project")
.build())
.build());
}
}
resources:
this:
type: databricks:PostgresProject
properties:
projectId: my-project
spec:
pgVersion: 17
displayName: My Application Project
Project with Custom Settings
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const _this = new databricks.PostgresProject("this", {
projectId: "analytics-project",
spec: {
pgVersion: 16,
displayName: "Analytics Workloads",
historyRetentionDuration: "1209600s",
defaultEndpointSettings: {
autoscalingLimitMinCu: 1,
autoscalingLimitMaxCu: 8,
suspendTimeoutDuration: "300s",
},
},
});
import pulumi
import pulumi_databricks as databricks
this = databricks.PostgresProject("this",
project_id="analytics-project",
spec={
"pg_version": 16,
"display_name": "Analytics Workloads",
"history_retention_duration": "1209600s",
"default_endpoint_settings": {
"autoscaling_limit_min_cu": 1,
"autoscaling_limit_max_cu": 8,
"suspend_timeout_duration": "300s",
},
})
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.NewPostgresProject(ctx, "this", &databricks.PostgresProjectArgs{
ProjectId: pulumi.String("analytics-project"),
Spec: &databricks.PostgresProjectSpecArgs{
PgVersion: pulumi.Int(16),
DisplayName: pulumi.String("Analytics Workloads"),
HistoryRetentionDuration: pulumi.String("1209600s"),
DefaultEndpointSettings: &databricks.PostgresProjectSpecDefaultEndpointSettingsArgs{
AutoscalingLimitMinCu: pulumi.Float64(1),
AutoscalingLimitMaxCu: pulumi.Float64(8),
SuspendTimeoutDuration: pulumi.String("300s"),
},
},
})
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 = "analytics-project",
Spec = new Databricks.Inputs.PostgresProjectSpecArgs
{
PgVersion = 16,
DisplayName = "Analytics Workloads",
HistoryRetentionDuration = "1209600s",
DefaultEndpointSettings = new Databricks.Inputs.PostgresProjectSpecDefaultEndpointSettingsArgs
{
AutoscalingLimitMinCu = 1,
AutoscalingLimitMaxCu = 8,
SuspendTimeoutDuration = "300s",
},
},
});
});
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 java.util.List;
import java.util.ArrayList;
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("analytics-project")
.spec(PostgresProjectSpecArgs.builder()
.pgVersion(16)
.displayName("Analytics Workloads")
.historyRetentionDuration("1209600s")
.defaultEndpointSettings(PostgresProjectSpecDefaultEndpointSettingsArgs.builder()
.autoscalingLimitMinCu(1.0)
.autoscalingLimitMaxCu(8.0)
.suspendTimeoutDuration("300s")
.build())
.build())
.build());
}
}
resources:
this:
type: databricks:PostgresProject
properties:
projectId: analytics-project
spec:
pgVersion: 16
displayName: Analytics Workloads
historyRetentionDuration: 1209600s
defaultEndpointSettings:
autoscalingLimitMinCu: 1
autoscalingLimitMaxCu: 8
suspendTimeoutDuration: 300s
Referencing in Other Resources
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,
},
});
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,
})
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
}
_, 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
}
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,
},
});
});
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 java.util.List;
import java.util.ArrayList;
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());
}
}
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
Create PostgresProject Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PostgresProject(name: string, args: PostgresProjectArgs, opts?: CustomResourceOptions);@overload
def PostgresProject(resource_name: str,
args: PostgresProjectArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PostgresProject(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
spec: Optional[PostgresProjectSpecArgs] = None)func NewPostgresProject(ctx *Context, name string, args PostgresProjectArgs, opts ...ResourceOption) (*PostgresProject, error)public PostgresProject(string name, PostgresProjectArgs args, CustomResourceOptions? opts = null)
public PostgresProject(String name, PostgresProjectArgs args)
public PostgresProject(String name, PostgresProjectArgs args, CustomResourceOptions options)
type: databricks:PostgresProject
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PostgresProjectArgs
- 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 PostgresProjectArgs
- 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 PostgresProjectArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PostgresProjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PostgresProjectArgs
- 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 postgresProjectResource = new Databricks.PostgresProject("postgresProjectResource", new()
{
ProjectId = "string",
Spec = new Databricks.Inputs.PostgresProjectSpecArgs
{
DefaultEndpointSettings = new Databricks.Inputs.PostgresProjectSpecDefaultEndpointSettingsArgs
{
AutoscalingLimitMaxCu = 0,
AutoscalingLimitMinCu = 0,
NoSuspension = false,
PgSettings =
{
{ "string", "string" },
},
SuspendTimeoutDuration = "string",
},
DisplayName = "string",
HistoryRetentionDuration = "string",
PgVersion = 0,
},
});
example, err := databricks.NewPostgresProject(ctx, "postgresProjectResource", &databricks.PostgresProjectArgs{
ProjectId: pulumi.String("string"),
Spec: &databricks.PostgresProjectSpecArgs{
DefaultEndpointSettings: &databricks.PostgresProjectSpecDefaultEndpointSettingsArgs{
AutoscalingLimitMaxCu: pulumi.Float64(0),
AutoscalingLimitMinCu: pulumi.Float64(0),
NoSuspension: pulumi.Bool(false),
PgSettings: pulumi.StringMap{
"string": pulumi.String("string"),
},
SuspendTimeoutDuration: pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
HistoryRetentionDuration: pulumi.String("string"),
PgVersion: pulumi.Int(0),
},
})
var postgresProjectResource = new PostgresProject("postgresProjectResource", PostgresProjectArgs.builder()
.projectId("string")
.spec(PostgresProjectSpecArgs.builder()
.defaultEndpointSettings(PostgresProjectSpecDefaultEndpointSettingsArgs.builder()
.autoscalingLimitMaxCu(0.0)
.autoscalingLimitMinCu(0.0)
.noSuspension(false)
.pgSettings(Map.of("string", "string"))
.suspendTimeoutDuration("string")
.build())
.displayName("string")
.historyRetentionDuration("string")
.pgVersion(0)
.build())
.build());
postgres_project_resource = databricks.PostgresProject("postgresProjectResource",
project_id="string",
spec={
"default_endpoint_settings": {
"autoscaling_limit_max_cu": 0,
"autoscaling_limit_min_cu": 0,
"no_suspension": False,
"pg_settings": {
"string": "string",
},
"suspend_timeout_duration": "string",
},
"display_name": "string",
"history_retention_duration": "string",
"pg_version": 0,
})
const postgresProjectResource = new databricks.PostgresProject("postgresProjectResource", {
projectId: "string",
spec: {
defaultEndpointSettings: {
autoscalingLimitMaxCu: 0,
autoscalingLimitMinCu: 0,
noSuspension: false,
pgSettings: {
string: "string",
},
suspendTimeoutDuration: "string",
},
displayName: "string",
historyRetentionDuration: "string",
pgVersion: 0,
},
});
type: databricks:PostgresProject
properties:
projectId: string
spec:
defaultEndpointSettings:
autoscalingLimitMaxCu: 0
autoscalingLimitMinCu: 0
noSuspension: false
pgSettings:
string: string
suspendTimeoutDuration: string
displayName: string
historyRetentionDuration: string
pgVersion: 0
PostgresProject 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 PostgresProject resource accepts the following input properties:
- Project
Id string - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- Spec
Postgres
Project Spec - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- Project
Id string - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- Spec
Postgres
Project Spec Args - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- project
Id String - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- spec
Postgres
Project Spec - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- project
Id string - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- spec
Postgres
Project Spec - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- project_
id str - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- spec
Postgres
Project Spec Args - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- project
Id String - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- spec Property Map
- The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
Outputs
All input properties are implicitly available as output properties. Additionally, the PostgresProject resource produces the following output properties:
- Create
Time string - (string) - A timestamp indicating when the project was created
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - Status
Postgres
Project Status - (ProjectStatus) - The current status of a Project
- Uid string
- (string) - System-generated unique ID for the project
- Update
Time string - (string) - A timestamp indicating when the project was last updated
- Create
Time string - (string) - A timestamp indicating when the project was created
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - Status
Postgres
Project Status - (ProjectStatus) - The current status of a Project
- Uid string
- (string) - System-generated unique ID for the project
- Update
Time string - (string) - A timestamp indicating when the project was last updated
- create
Time String - (string) - A timestamp indicating when the project was created
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - status
Postgres
Project Status - (ProjectStatus) - The current status of a Project
- uid String
- (string) - System-generated unique ID for the project
- update
Time String - (string) - A timestamp indicating when the project was last updated
- create
Time string - (string) - A timestamp indicating when the project was created
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - status
Postgres
Project Status - (ProjectStatus) - The current status of a Project
- uid string
- (string) - System-generated unique ID for the project
- update
Time string - (string) - A timestamp indicating when the project was last updated
- create_
time str - (string) - A timestamp indicating when the project was created
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - status
Postgres
Project Status - (ProjectStatus) - The current status of a Project
- uid str
- (string) - System-generated unique ID for the project
- update_
time str - (string) - A timestamp indicating when the project was last updated
- create
Time String - (string) - A timestamp indicating when the project was created
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - status Property Map
- (ProjectStatus) - The current status of a Project
- uid String
- (string) - System-generated unique ID for the project
- update
Time String - (string) - A timestamp indicating when the project was last updated
Look up Existing PostgresProject Resource
Get an existing PostgresProject 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?: PostgresProjectState, opts?: CustomResourceOptions): PostgresProject@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
spec: Optional[PostgresProjectSpecArgs] = None,
status: Optional[PostgresProjectStatusArgs] = None,
uid: Optional[str] = None,
update_time: Optional[str] = None) -> PostgresProjectfunc GetPostgresProject(ctx *Context, name string, id IDInput, state *PostgresProjectState, opts ...ResourceOption) (*PostgresProject, error)public static PostgresProject Get(string name, Input<string> id, PostgresProjectState? state, CustomResourceOptions? opts = null)public static PostgresProject get(String name, Output<String> id, PostgresProjectState state, CustomResourceOptions options)resources: _: type: databricks:PostgresProject get: 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 project was created
- Name string
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - Project
Id string - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- Spec
Postgres
Project Spec - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- Status
Postgres
Project Status - (ProjectStatus) - The current status of a Project
- Uid string
- (string) - System-generated unique ID for the project
- Update
Time string - (string) - A timestamp indicating when the project was last updated
- Create
Time string - (string) - A timestamp indicating when the project was created
- Name string
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - Project
Id string - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- Spec
Postgres
Project Spec Args - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- Status
Postgres
Project Status Args - (ProjectStatus) - The current status of a Project
- Uid string
- (string) - System-generated unique ID for the project
- Update
Time string - (string) - A timestamp indicating when the project was last updated
- create
Time String - (string) - A timestamp indicating when the project was created
- name String
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - project
Id String - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- spec
Postgres
Project Spec - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- status
Postgres
Project Status - (ProjectStatus) - The current status of a Project
- uid String
- (string) - System-generated unique ID for the project
- update
Time String - (string) - A timestamp indicating when the project was last updated
- create
Time string - (string) - A timestamp indicating when the project was created
- name string
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - project
Id string - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- spec
Postgres
Project Spec - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- status
Postgres
Project Status - (ProjectStatus) - The current status of a Project
- uid string
- (string) - System-generated unique ID for the project
- update
Time string - (string) - A timestamp indicating when the project was last updated
- create_
time str - (string) - A timestamp indicating when the project was created
- name str
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - project_
id str - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- spec
Postgres
Project Spec Args - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- status
Postgres
Project Status Args - (ProjectStatus) - The current status of a Project
- uid str
- (string) - System-generated unique ID for the project
- update_
time str - (string) - A timestamp indicating when the project was last updated
- create
Time String - (string) - A timestamp indicating when the project was created
- name String
- (string) - The resource name of the project. This field is output-only and constructed by the system.
Format:
projects/{project_id} - project
Id String - The ID to use for the Project. This becomes the final component of the project's resource name.
The ID must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens (RFC 1123).
Examples:
- With custom ID:
production→ name becomesprojects/production - Without custom ID: system generates UUID → name becomes
projects/a7f89b2c-3d4e-5f6g-7h8i-9j0k1l2m3n4o
- With custom ID:
- spec Property Map
- The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
- status Property Map
- (ProjectStatus) - The current status of a Project
- uid String
- (string) - System-generated unique ID for the project
- update
Time String - (string) - A timestamp indicating when the project was last updated
Supporting Types
PostgresProjectSpec, PostgresProjectSpecArgs
- Default
Endpoint PostgresSettings Project Spec Default Endpoint Settings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- Display
Name string - (string) - The effective human-readable project name
- History
Retention stringDuration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- Pg
Version int - (integer) - The effective major Postgres version number
- Default
Endpoint PostgresSettings Project Spec Default Endpoint Settings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- Display
Name string - (string) - The effective human-readable project name
- History
Retention stringDuration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- Pg
Version int - (integer) - The effective major Postgres version number
- default
Endpoint PostgresSettings Project Spec Default Endpoint Settings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- display
Name String - (string) - The effective human-readable project name
- history
Retention StringDuration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- pg
Version Integer - (integer) - The effective major Postgres version number
- default
Endpoint PostgresSettings Project Spec Default Endpoint Settings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- display
Name string - (string) - The effective human-readable project name
- history
Retention stringDuration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- pg
Version number - (integer) - The effective major Postgres version number
- default_
endpoint_ Postgressettings Project Spec Default Endpoint Settings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- display_
name str - (string) - The effective human-readable project name
- history_
retention_ strduration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- pg_
version int - (integer) - The effective major Postgres version number
- default
Endpoint Property MapSettings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- display
Name String - (string) - The effective human-readable project name
- history
Retention StringDuration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- pg
Version Number - (integer) - The effective major Postgres version number
PostgresProjectSpecDefaultEndpointSettings, PostgresProjectSpecDefaultEndpointSettingsArgs
- Autoscaling
Limit doubleMax Cu - The maximum number of Compute Units. Minimum value is 0.5
- Autoscaling
Limit doubleMin Cu - The minimum number of Compute Units. Minimum value is 0.5
- No
Suspension bool - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- Pg
Settings Dictionary<string, string> - A raw representation of Postgres settings
- Suspend
Timeout stringDuration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
- Autoscaling
Limit float64Max Cu - The maximum number of Compute Units. Minimum value is 0.5
- Autoscaling
Limit float64Min Cu - The minimum number of Compute Units. Minimum value is 0.5
- No
Suspension bool - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- Pg
Settings map[string]string - A raw representation of Postgres settings
- Suspend
Timeout stringDuration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
- autoscaling
Limit DoubleMax Cu - The maximum number of Compute Units. Minimum value is 0.5
- autoscaling
Limit DoubleMin Cu - The minimum number of Compute Units. Minimum value is 0.5
- no
Suspension Boolean - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- pg
Settings Map<String,String> - A raw representation of Postgres settings
- suspend
Timeout StringDuration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
- autoscaling
Limit numberMax Cu - The maximum number of Compute Units. Minimum value is 0.5
- autoscaling
Limit numberMin Cu - The minimum number of Compute Units. Minimum value is 0.5
- no
Suspension boolean - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- pg
Settings {[key: string]: string} - A raw representation of Postgres settings
- suspend
Timeout stringDuration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
- autoscaling_
limit_ floatmax_ cu - The maximum number of Compute Units. Minimum value is 0.5
- autoscaling_
limit_ floatmin_ cu - The minimum number of Compute Units. Minimum value is 0.5
- no_
suspension bool - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- pg_
settings Mapping[str, str] - A raw representation of Postgres settings
- suspend_
timeout_ strduration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
- autoscaling
Limit NumberMax Cu - The maximum number of Compute Units. Minimum value is 0.5
- autoscaling
Limit NumberMin Cu - The minimum number of Compute Units. Minimum value is 0.5
- no
Suspension Boolean - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- pg
Settings Map<String> - A raw representation of Postgres settings
- suspend
Timeout StringDuration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
PostgresProjectStatus, PostgresProjectStatusArgs
- Branch
Logical intSize Limit Bytes - (integer) - The logical size limit for a branch
- Default
Endpoint PostgresSettings Project Status Default Endpoint Settings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- Display
Name string - (string) - The effective human-readable project name
- History
Retention stringDuration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- Owner string
- (string) - The email of the project owner
- Pg
Version int - (integer) - The effective major Postgres version number
- Synthetic
Storage intSize Bytes - (integer) - The current space occupied by the project in storage
- Branch
Logical intSize Limit Bytes - (integer) - The logical size limit for a branch
- Default
Endpoint PostgresSettings Project Status Default Endpoint Settings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- Display
Name string - (string) - The effective human-readable project name
- History
Retention stringDuration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- Owner string
- (string) - The email of the project owner
- Pg
Version int - (integer) - The effective major Postgres version number
- Synthetic
Storage intSize Bytes - (integer) - The current space occupied by the project in storage
- branch
Logical IntegerSize Limit Bytes - (integer) - The logical size limit for a branch
- default
Endpoint PostgresSettings Project Status Default Endpoint Settings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- display
Name String - (string) - The effective human-readable project name
- history
Retention StringDuration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- owner String
- (string) - The email of the project owner
- pg
Version Integer - (integer) - The effective major Postgres version number
- synthetic
Storage IntegerSize Bytes - (integer) - The current space occupied by the project in storage
- branch
Logical numberSize Limit Bytes - (integer) - The logical size limit for a branch
- default
Endpoint PostgresSettings Project Status Default Endpoint Settings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- display
Name string - (string) - The effective human-readable project name
- history
Retention stringDuration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- owner string
- (string) - The email of the project owner
- pg
Version number - (integer) - The effective major Postgres version number
- synthetic
Storage numberSize Bytes - (integer) - The current space occupied by the project in storage
- branch_
logical_ intsize_ limit_ bytes - (integer) - The logical size limit for a branch
- default_
endpoint_ Postgressettings Project Status Default Endpoint Settings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- display_
name str - (string) - The effective human-readable project name
- history_
retention_ strduration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- owner str
- (string) - The email of the project owner
- pg_
version int - (integer) - The effective major Postgres version number
- synthetic_
storage_ intsize_ bytes - (integer) - The current space occupied by the project in storage
- branch
Logical NumberSize Limit Bytes - (integer) - The logical size limit for a branch
- default
Endpoint Property MapSettings - (ProjectDefaultEndpointSettings) - The effective default endpoint settings
- display
Name String - (string) - The effective human-readable project name
- history
Retention StringDuration - (string) - The effective number of seconds to retain the shared history for point in time recovery
- owner String
- (string) - The email of the project owner
- pg
Version Number - (integer) - The effective major Postgres version number
- synthetic
Storage NumberSize Bytes - (integer) - The current space occupied by the project in storage
PostgresProjectStatusDefaultEndpointSettings, PostgresProjectStatusDefaultEndpointSettingsArgs
- Autoscaling
Limit doubleMax Cu - The maximum number of Compute Units. Minimum value is 0.5
- Autoscaling
Limit doubleMin Cu - The minimum number of Compute Units. Minimum value is 0.5
- No
Suspension bool - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- Pg
Settings Dictionary<string, string> - A raw representation of Postgres settings
- Suspend
Timeout stringDuration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
- Autoscaling
Limit float64Max Cu - The maximum number of Compute Units. Minimum value is 0.5
- Autoscaling
Limit float64Min Cu - The minimum number of Compute Units. Minimum value is 0.5
- No
Suspension bool - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- Pg
Settings map[string]string - A raw representation of Postgres settings
- Suspend
Timeout stringDuration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
- autoscaling
Limit DoubleMax Cu - The maximum number of Compute Units. Minimum value is 0.5
- autoscaling
Limit DoubleMin Cu - The minimum number of Compute Units. Minimum value is 0.5
- no
Suspension Boolean - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- pg
Settings Map<String,String> - A raw representation of Postgres settings
- suspend
Timeout StringDuration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
- autoscaling
Limit numberMax Cu - The maximum number of Compute Units. Minimum value is 0.5
- autoscaling
Limit numberMin Cu - The minimum number of Compute Units. Minimum value is 0.5
- no
Suspension boolean - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- pg
Settings {[key: string]: string} - A raw representation of Postgres settings
- suspend
Timeout stringDuration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
- autoscaling_
limit_ floatmax_ cu - The maximum number of Compute Units. Minimum value is 0.5
- autoscaling_
limit_ floatmin_ cu - The minimum number of Compute Units. Minimum value is 0.5
- no_
suspension bool - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- pg_
settings Mapping[str, str] - A raw representation of Postgres settings
- suspend_
timeout_ strduration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
- autoscaling
Limit NumberMax Cu - The maximum number of Compute Units. Minimum value is 0.5
- autoscaling
Limit NumberMin Cu - The minimum number of Compute Units. Minimum value is 0.5
- no
Suspension Boolean - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- pg
Settings Map<String> - A raw representation of Postgres settings
- suspend
Timeout StringDuration - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
Import
As of Pulumi v1.5, resources can be imported through configuration.
hcl
import {
id = “name”
to = databricks_postgres_project.this
}
If you are using an older version of Pulumi, import the resource using the pulumi import command as follows:
$ pulumi import databricks:index/postgresProject:PostgresProject this "name"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
