PostgresInstance

Snowflake v2.18.0, Jul 8 26

Viewing docs for Snowflake v2.18.0
published on Wednesday, Jul 8, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Viewing docs for Snowflake v2.18.0
published on Wednesday, Jul 8, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to previewFeaturesEnabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

Note Postgres instance operations (create, update, delete) can take significantly longer than the default provider timeout values. If you encounter timeout errors, use a timeouts block to set higher limits for your environment.

Known limitation postgresVersion is required in this provider even though Snowflake treats it as optional. Modeling the optional-with-computed-default behavior correctly in Terraform requires non-trivial logic, so the field is required for now to keep the resource predictable.

Resource used to manage Postgres instance objects. For more information, check Postgres instance documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

// basic resource
const basic = new snowflake.PostgresInstance("basic", {
    name: "my_postgres_instance",
    computeFamily: "STANDARD_M",
    storageSizeGb: 10,
    authenticationAuthority: "POSTGRES",
});
// with custom timeouts (postgres operations can take longer than the defaults)
const withTimeouts = new snowflake.PostgresInstance("with_timeouts", {
    name: "my_postgres_instance",
    computeFamily: "STANDARD_M",
    storageSizeGb: 10,
    authenticationAuthority: "POSTGRES",
});
// complete resource
const complete = new snowflake.PostgresInstance("complete", {
    name: "my_postgres_instance_complete",
    computeFamily: "STANDARD_M",
    storageSizeGb: 10,
    authenticationAuthority: "POSTGRES_OR_SNOWFLAKE",
    postgresVersion: 16,
    networkPolicy: "my_network_policy",
    storageIntegration: "my_storage_integration",
    highAvailability: "true",
    postgresSettings: "{\"max_connections\": 100}",
    maintenanceWindowStart: 8,
    comment: "My Postgres instance",
});

import pulumi
import pulumi_snowflake as snowflake

# basic resource
basic = snowflake.PostgresInstance("basic",
    name="my_postgres_instance",
    compute_family="STANDARD_M",
    storage_size_gb=10,
    authentication_authority="POSTGRES")
# with custom timeouts (postgres operations can take longer than the defaults)
with_timeouts = snowflake.PostgresInstance("with_timeouts",
    name="my_postgres_instance",
    compute_family="STANDARD_M",
    storage_size_gb=10,
    authentication_authority="POSTGRES")
# complete resource
complete = snowflake.PostgresInstance("complete",
    name="my_postgres_instance_complete",
    compute_family="STANDARD_M",
    storage_size_gb=10,
    authentication_authority="POSTGRES_OR_SNOWFLAKE",
    postgres_version=16,
    network_policy="my_network_policy",
    storage_integration="my_storage_integration",
    high_availability="true",
    postgres_settings="{\"max_connections\": 100}",
    maintenance_window_start=8,
    comment="My Postgres instance")

package main

import (
	"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// basic resource
		_, err := snowflake.NewPostgresInstance(ctx, "basic", &snowflake.PostgresInstanceArgs{
			Name:                    pulumi.String("my_postgres_instance"),
			ComputeFamily:           pulumi.String("STANDARD_M"),
			StorageSizeGb:           pulumi.Int(10),
			AuthenticationAuthority: pulumi.String("POSTGRES"),
		})
		if err != nil {
			return err
		}
		// with custom timeouts (postgres operations can take longer than the defaults)
		_, err = snowflake.NewPostgresInstance(ctx, "with_timeouts", &snowflake.PostgresInstanceArgs{
			Name:                    pulumi.String("my_postgres_instance"),
			ComputeFamily:           pulumi.String("STANDARD_M"),
			StorageSizeGb:           pulumi.Int(10),
			AuthenticationAuthority: pulumi.String("POSTGRES"),
		})
		if err != nil {
			return err
		}
		// complete resource
		_, err = snowflake.NewPostgresInstance(ctx, "complete", &snowflake.PostgresInstanceArgs{
			Name:                    pulumi.String("my_postgres_instance_complete"),
			ComputeFamily:           pulumi.String("STANDARD_M"),
			StorageSizeGb:           pulumi.Int(10),
			AuthenticationAuthority: pulumi.String("POSTGRES_OR_SNOWFLAKE"),
			PostgresVersion:         pulumi.Int(16),
			NetworkPolicy:           pulumi.String("my_network_policy"),
			StorageIntegration:      pulumi.String("my_storage_integration"),
			HighAvailability:        pulumi.String("true"),
			PostgresSettings:        pulumi.String("{\"max_connections\": 100}"),
			MaintenanceWindowStart:  pulumi.Int(8),
			Comment:                 pulumi.String("My Postgres instance"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;

return await Deployment.RunAsync(() => 
{
    // basic resource
    var basic = new Snowflake.PostgresInstance("basic", new()
    {
        Name = "my_postgres_instance",
        ComputeFamily = "STANDARD_M",
        StorageSizeGb = 10,
        AuthenticationAuthority = "POSTGRES",
    });

    // with custom timeouts (postgres operations can take longer than the defaults)
    var withTimeouts = new Snowflake.PostgresInstance("with_timeouts", new()
    {
        Name = "my_postgres_instance",
        ComputeFamily = "STANDARD_M",
        StorageSizeGb = 10,
        AuthenticationAuthority = "POSTGRES",
    });

    // complete resource
    var complete = new Snowflake.PostgresInstance("complete", new()
    {
        Name = "my_postgres_instance_complete",
        ComputeFamily = "STANDARD_M",
        StorageSizeGb = 10,
        AuthenticationAuthority = "POSTGRES_OR_SNOWFLAKE",
        PostgresVersion = 16,
        NetworkPolicy = "my_network_policy",
        StorageIntegration = "my_storage_integration",
        HighAvailability = "true",
        PostgresSettings = "{\"max_connections\": 100}",
        MaintenanceWindowStart = 8,
        Comment = "My Postgres instance",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.PostgresInstance;
import com.pulumi.snowflake.PostgresInstanceArgs;
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) {
        // basic resource
        var basic = new PostgresInstance("basic", PostgresInstanceArgs.builder()
            .name("my_postgres_instance")
            .computeFamily("STANDARD_M")
            .storageSizeGb(10)
            .authenticationAuthority("POSTGRES")
            .build());

        // with custom timeouts (postgres operations can take longer than the defaults)
        var withTimeouts = new PostgresInstance("withTimeouts", PostgresInstanceArgs.builder()
            .name("my_postgres_instance")
            .computeFamily("STANDARD_M")
            .storageSizeGb(10)
            .authenticationAuthority("POSTGRES")
            .build());

        // complete resource
        var complete = new PostgresInstance("complete", PostgresInstanceArgs.builder()
            .name("my_postgres_instance_complete")
            .computeFamily("STANDARD_M")
            .storageSizeGb(10)
            .authenticationAuthority("POSTGRES_OR_SNOWFLAKE")
            .postgresVersion(16)
            .networkPolicy("my_network_policy")
            .storageIntegration("my_storage_integration")
            .highAvailability("true")
            .postgresSettings("{\"max_connections\": 100}")
            .maintenanceWindowStart(8)
            .comment("My Postgres instance")
            .build());

    }
}

resources:
  # basic resource
  basic:
    type: snowflake:PostgresInstance
    properties:
      name: my_postgres_instance
      computeFamily: STANDARD_M
      storageSizeGb: 10
      authenticationAuthority: POSTGRES
  # with custom timeouts (postgres operations can take longer than the defaults)
  withTimeouts:
    type: snowflake:PostgresInstance
    name: with_timeouts
    properties:
      name: my_postgres_instance
      computeFamily: STANDARD_M
      storageSizeGb: 10
      authenticationAuthority: POSTGRES
  # complete resource
  complete:
    type: snowflake:PostgresInstance
    properties:
      name: my_postgres_instance_complete
      computeFamily: STANDARD_M
      storageSizeGb: 10
      authenticationAuthority: POSTGRES_OR_SNOWFLAKE
      postgresVersion: 16
      networkPolicy: my_network_policy
      storageIntegration: my_storage_integration
      highAvailability: 'true'
      postgresSettings: '{"max_connections": 100}'
      maintenanceWindowStart: 8
      comment: My Postgres instance

pulumi {
  required_providers {
    snowflake = {
      source = "pulumi/snowflake"
    }
  }
}

# basic resource
resource "snowflake_postgresinstance" "basic" {
  name                     = "my_postgres_instance"
  compute_family           = "STANDARD_M"
  storage_size_gb          = 10
  authentication_authority = "POSTGRES"
}
# with custom timeouts (postgres operations can take longer than the defaults)
resource "snowflake_postgresinstance" "with_timeouts" {
  name                     = "my_postgres_instance"
  compute_family           = "STANDARD_M"
  storage_size_gb          = 10
  authentication_authority = "POSTGRES"
}
# complete resource
resource "snowflake_postgresinstance" "complete" {
  name                     = "my_postgres_instance_complete"
  compute_family           = "STANDARD_M"
  storage_size_gb          = 10
  authentication_authority = "POSTGRES_OR_SNOWFLAKE"
  postgres_version         = 16
  network_policy           = "my_network_policy"
  storage_integration      = "my_storage_integration"
  high_availability        = "true"
  postgres_settings        = "{\"max_connections\": 100}"
  maintenance_window_start = 8
  comment                  = "My Postgres instance"
}

Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.

Note If a field has a default value, it is shown next to the type in the schema.

Create PostgresInstance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PostgresInstance(name: string, args: PostgresInstanceArgs, opts?: CustomResourceOptions);

@overload
def PostgresInstance(resource_name: str,
                     args: PostgresInstanceArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def PostgresInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     authentication_authority: Optional[str] = None,
                     compute_family: Optional[str] = None,
                     postgres_version: Optional[int] = None,
                     storage_size_gb: Optional[int] = None,
                     comment: Optional[str] = None,
                     high_availability: Optional[str] = None,
                     maintenance_window_start: Optional[int] = None,
                     name: Optional[str] = None,
                     network_policy: Optional[str] = None,
                     postgres_settings: Optional[str] = None,
                     storage_integration: Optional[str] = None)

func NewPostgresInstance(ctx *Context, name string, args PostgresInstanceArgs, opts ...ResourceOption) (*PostgresInstance, error)

public PostgresInstance(string name, PostgresInstanceArgs args, CustomResourceOptions? opts = null)

public PostgresInstance(String name, PostgresInstanceArgs args)
public PostgresInstance(String name, PostgresInstanceArgs args, CustomResourceOptions options)

type: snowflake:PostgresInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "snowflake_postgres_instance" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args PostgresInstanceArgs: 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 PostgresInstanceArgs: 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 PostgresInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PostgresInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PostgresInstanceArgs: 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 postgresInstanceResource = new Snowflake.PostgresInstance("postgresInstanceResource", new()
{
    AuthenticationAuthority = "string",
    ComputeFamily = "string",
    PostgresVersion = 0,
    StorageSizeGb = 0,
    Comment = "string",
    HighAvailability = "string",
    MaintenanceWindowStart = 0,
    Name = "string",
    NetworkPolicy = "string",
    PostgresSettings = "string",
    StorageIntegration = "string",
});

example, err := snowflake.NewPostgresInstance(ctx, "postgresInstanceResource", &snowflake.PostgresInstanceArgs{
	AuthenticationAuthority: pulumi.String("string"),
	ComputeFamily:           pulumi.String("string"),
	PostgresVersion:         pulumi.Int(0),
	StorageSizeGb:           pulumi.Int(0),
	Comment:                 pulumi.String("string"),
	HighAvailability:        pulumi.String("string"),
	MaintenanceWindowStart:  pulumi.Int(0),
	Name:                    pulumi.String("string"),
	NetworkPolicy:           pulumi.String("string"),
	PostgresSettings:        pulumi.String("string"),
	StorageIntegration:      pulumi.String("string"),
})

resource "snowflake_postgres_instance" "postgresInstanceResource" {
  lifecycle {
    create_before_destroy = true
  }
  authentication_authority = "string"
  compute_family           = "string"
  postgres_version         = 0
  storage_size_gb          = 0
  comment                  = "string"
  high_availability        = "string"
  maintenance_window_start = 0
  name                     = "string"
  network_policy           = "string"
  postgres_settings        = "string"
  storage_integration      = "string"
}

var postgresInstanceResource = new PostgresInstance("postgresInstanceResource", PostgresInstanceArgs.builder()
    .authenticationAuthority("string")
    .computeFamily("string")
    .postgresVersion(0)
    .storageSizeGb(0)
    .comment("string")
    .highAvailability("string")
    .maintenanceWindowStart(0)
    .name("string")
    .networkPolicy("string")
    .postgresSettings("string")
    .storageIntegration("string")
    .build());

postgres_instance_resource = snowflake.PostgresInstance("postgresInstanceResource",
    authentication_authority="string",
    compute_family="string",
    postgres_version=0,
    storage_size_gb=0,
    comment="string",
    high_availability="string",
    maintenance_window_start=0,
    name="string",
    network_policy="string",
    postgres_settings="string",
    storage_integration="string")

const postgresInstanceResource = new snowflake.PostgresInstance("postgresInstanceResource", {
    authenticationAuthority: "string",
    computeFamily: "string",
    postgresVersion: 0,
    storageSizeGb: 0,
    comment: "string",
    highAvailability: "string",
    maintenanceWindowStart: 0,
    name: "string",
    networkPolicy: "string",
    postgresSettings: "string",
    storageIntegration: "string",
});

type: snowflake:PostgresInstance
properties:
    authenticationAuthority: string
    comment: string
    computeFamily: string
    highAvailability: string
    maintenanceWindowStart: 0
    name: string
    networkPolicy: string
    postgresSettings: string
    postgresVersion: 0
    storageIntegration: string
    storageSizeGb: 0