Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Neon Provider
  3. API Docs
  4. Project
neon 0.9.0 published on Tuesday, May 6, 2025 by kislerdm
kislerdm/terraform-provider-neon

neon.Project

Explore with Pulumi AI

neon logo
neon 0.9.0 published on Tuesday, May 6, 2025 by kislerdm
kislerdm/terraform-provider-neon

    Neon Project.

    See details: https://neon.tech/docs/get-started-with-neon/setting-up-a-project/ API: https://api-docs.neon.tech/reference/createproject

    Example Usage

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

const example = new neon.Project("example", {branch: {
    databaseName: "baz",
    name: "bar",
    roleName: "qux",
}});
//## Set the logical replication
// See: https://neon.tech/docs/guides/logical-replication-guide
const exampleWithLogicalReplication = new neon.Project("exampleWithLogicalReplication", {enableLogicalReplication: "yes"});
//## Set the allow list of IP addresses
// Note that the feature is only available to the users of the Business plan:
// https://neon.tech/docs/introduction/ip-allow
const exampleWithAllowedIps = new neon.Project("exampleWithAllowedIps", {allowedIps: [
    "1.2.3.4/24",
    "99.1.20.93",
]});
//## Set the allow list of IP addresses for protected branches only
// Note that the feature is only available to the users of the Business, or Scale plans:
// https://neon.tech/docs/guides/protected-branches
const exampleWithAllowedIpsProtectedBranchOnly = new neon.Project("exampleWithAllowedIpsProtectedBranchOnly", {
    allowedIps: [
        "1.2.3.4/24",
        "99.1.20.93",
    ],
    allowedIpsProtectedBranchesOnly: "yes",
});
//## Create project in the organisation
const exampleInOrg = new neon.Project("exampleInOrg", {orgId: "org-restless-silence-28866559"});

    import pulumi
import pulumi_neon as neon

example = neon.Project("example", branch={
    "database_name": "baz",
    "name": "bar",
    "role_name": "qux",
})
### Set the logical replication
# See: https://neon.tech/docs/guides/logical-replication-guide
example_with_logical_replication = neon.Project("exampleWithLogicalReplication", enable_logical_replication="yes")
### Set the allow list of IP addresses
# Note that the feature is only available to the users of the Business plan:
# https://neon.tech/docs/introduction/ip-allow
example_with_allowed_ips = neon.Project("exampleWithAllowedIps", allowed_ips=[
    "1.2.3.4/24",
    "99.1.20.93",
])
### Set the allow list of IP addresses for protected branches only
# Note that the feature is only available to the users of the Business, or Scale plans:
# https://neon.tech/docs/guides/protected-branches
example_with_allowed_ips_protected_branch_only = neon.Project("exampleWithAllowedIpsProtectedBranchOnly",
    allowed_ips=[
        "1.2.3.4/24",
        "99.1.20.93",
    ],
    allowed_ips_protected_branches_only="yes")
### Create project in the organisation
example_in_org = neon.Project("exampleInOrg", org_id="org-restless-silence-28866559")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/neon/neon"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := neon.NewProject(ctx, "example", &neon.ProjectArgs{
			Branch: &neon.ProjectBranchArgs{
				DatabaseName: pulumi.String("baz"),
				Name:         pulumi.String("bar"),
				RoleName:     pulumi.String("qux"),
			},
		})
		if err != nil {
			return err
		}
		// ## Set the logical replication
		// See: https://neon.tech/docs/guides/logical-replication-guide
		_, err = neon.NewProject(ctx, "exampleWithLogicalReplication", &neon.ProjectArgs{
			EnableLogicalReplication: pulumi.String("yes"),
		})
		if err != nil {
			return err
		}
		// ## Set the allow list of IP addresses
		// Note that the feature is only available to the users of the Business plan:
		// https://neon.tech/docs/introduction/ip-allow
		_, err = neon.NewProject(ctx, "exampleWithAllowedIps", &neon.ProjectArgs{
			AllowedIps: pulumi.StringArray{
				pulumi.String("1.2.3.4/24"),
				pulumi.String("99.1.20.93"),
			},
		})
		if err != nil {
			return err
		}
		// ## Set the allow list of IP addresses for protected branches only
		// Note that the feature is only available to the users of the Business, or Scale plans:
		// https://neon.tech/docs/guides/protected-branches
		_, err = neon.NewProject(ctx, "exampleWithAllowedIpsProtectedBranchOnly", &neon.ProjectArgs{
			AllowedIps: pulumi.StringArray{
				pulumi.String("1.2.3.4/24"),
				pulumi.String("99.1.20.93"),
			},
			AllowedIpsProtectedBranchesOnly: pulumi.String("yes"),
		})
		if err != nil {
			return err
		}
		// ## Create project in the organisation
		_, err = neon.NewProject(ctx, "exampleInOrg", &neon.ProjectArgs{
			OrgId: pulumi.String("org-restless-silence-28866559"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Neon.Project("example", new()
    {
        Branch = new Neon.Inputs.ProjectBranchArgs
        {
            DatabaseName = "baz",
            Name = "bar",
            RoleName = "qux",
        },
    });

    //## Set the logical replication
    // See: https://neon.tech/docs/guides/logical-replication-guide
    var exampleWithLogicalReplication = new Neon.Project("exampleWithLogicalReplication", new()
    {
        EnableLogicalReplication = "yes",
    });

    //## Set the allow list of IP addresses
    // Note that the feature is only available to the users of the Business plan:
    // https://neon.tech/docs/introduction/ip-allow
    var exampleWithAllowedIps = new Neon.Project("exampleWithAllowedIps", new()
    {
        AllowedIps = new[]
        {
            "1.2.3.4/24",
            "99.1.20.93",
        },
    });

    //## Set the allow list of IP addresses for protected branches only
    // Note that the feature is only available to the users of the Business, or Scale plans:
    // https://neon.tech/docs/guides/protected-branches
    var exampleWithAllowedIpsProtectedBranchOnly = new Neon.Project("exampleWithAllowedIpsProtectedBranchOnly", new()
    {
        AllowedIps = new[]
        {
            "1.2.3.4/24",
            "99.1.20.93",
        },
        AllowedIpsProtectedBranchesOnly = "yes",
    });

    //## Create project in the organisation
    var exampleInOrg = new Neon.Project("exampleInOrg", new()
    {
        OrgId = "org-restless-silence-28866559",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.neon.Project;
import com.pulumi.neon.ProjectArgs;
import com.pulumi.neon.inputs.ProjectBranchArgs;
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 example = new Project("example", ProjectArgs.builder()
            .branch(ProjectBranchArgs.builder()
                .databaseName("baz")
                .name("bar")
                .roleName("qux")
                .build())
            .build());

        //## Set the logical replication
        // See: https://neon.tech/docs/guides/logical-replication-guide
        var exampleWithLogicalReplication = new Project("exampleWithLogicalReplication", ProjectArgs.builder()
            .enableLogicalReplication("yes")
            .build());

        //## Set the allow list of IP addresses
        // Note that the feature is only available to the users of the Business plan:
        // https://neon.tech/docs/introduction/ip-allow
        var exampleWithAllowedIps = new Project("exampleWithAllowedIps", ProjectArgs.builder()
            .allowedIps(            
                "1.2.3.4/24",
                "99.1.20.93")
            .build());

        //## Set the allow list of IP addresses for protected branches only
        // Note that the feature is only available to the users of the Business, or Scale plans:
        // https://neon.tech/docs/guides/protected-branches
        var exampleWithAllowedIpsProtectedBranchOnly = new Project("exampleWithAllowedIpsProtectedBranchOnly", ProjectArgs.builder()
            .allowedIps(            
                "1.2.3.4/24",
                "99.1.20.93")
            .allowedIpsProtectedBranchesOnly("yes")
            .build());

        //## Create project in the organisation
        var exampleInOrg = new Project("exampleInOrg", ProjectArgs.builder()
            .orgId("org-restless-silence-28866559")
            .build());

    }
}

    resources:
  example:
    type: neon:Project
    properties:
      branch:
        databaseName: baz
        name: bar
        roleName: qux
  ## Set the logical replication
  # // See: https://neon.tech/docs/guides/logical-replication-guide
  exampleWithLogicalReplication:
    type: neon:Project
    properties:
      enableLogicalReplication: yes
  ## Set the allow list of IP addresses
  # // Note that the feature is only available to the users of the Business plan:
  # // https://neon.tech/docs/introduction/ip-allow
  exampleWithAllowedIps:
    type: neon:Project
    properties:
      allowedIps:
        - 1.2.3.4/24
        - 99.1.20.93
  ## Set the allow list of IP addresses for protected branches only
  # // Note that the feature is only available to the users of the Business, or Scale plans:
  # // https://neon.tech/docs/guides/protected-branches
  exampleWithAllowedIpsProtectedBranchOnly:
    type: neon:Project
    properties:
      allowedIps:
        - 1.2.3.4/24
        - 99.1.20.93
      allowedIpsProtectedBranchesOnly: yes
  ## Create project in the organisation
  exampleInOrg:
    type: neon:Project
    properties:
      orgId: org-restless-silence-28866559

    Create Project Resource

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

    Constructor syntax

    new Project(name: string, args?: ProjectArgs, opts?: CustomResourceOptions);
    @overload
def Project(resource_name: str,
            args: Optional[ProjectArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Project(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            allowed_ips: Optional[Sequence[str]] = None,
            allowed_ips_protected_branches_only: Optional[str] = None,
            branch: Optional[ProjectBranchArgs] = None,
            compute_provisioner: Optional[str] = None,
            default_endpoint_settings: Optional[ProjectDefaultEndpointSettingsArgs] = None,
            enable_logical_replication: Optional[str] = None,
            history_retention_seconds: Optional[float] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            pg_version: Optional[float] = None,
            quota: Optional[ProjectQuotaArgs] = None,
            region_id: Optional[str] = None,
            store_password: Optional[str] = None)
    func NewProject(ctx *Context, name string, args *ProjectArgs, opts ...ResourceOption) (*Project, error)
    public Project(string name, ProjectArgs? args = null, CustomResourceOptions? opts = null)
    public Project(String name, ProjectArgs args)
public Project(String name, ProjectArgs args, CustomResourceOptions options)

    type: neon:Project
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 ProjectArgs
    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 ProjectArgs
    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 ProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectArgs
    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 projectResource = new Neon.Project("projectResource", new()
{
    AllowedIps = new[]
    {
        "string",
    },
    AllowedIpsProtectedBranchesOnly = "string",
    Branch = new Neon.Inputs.ProjectBranchArgs
    {
        DatabaseName = "string",
        Id = "string",
        Name = "string",
        RoleName = "string",
    },
    ComputeProvisioner = "string",
    DefaultEndpointSettings = new Neon.Inputs.ProjectDefaultEndpointSettingsArgs
    {
        AutoscalingLimitMaxCu = 0,
        AutoscalingLimitMinCu = 0,
        Id = "string",
        SuspendTimeoutSeconds = 0,
    },
    EnableLogicalReplication = "string",
    HistoryRetentionSeconds = 0,
    Name = "string",
    OrgId = "string",
    PgVersion = 0,
    Quota = new Neon.Inputs.ProjectQuotaArgs
    {
        ActiveTimeSeconds = 0,
        ComputeTimeSeconds = 0,
        DataTransferBytes = 0,
        LogicalSizeBytes = 0,
        WrittenDataBytes = 0,
    },
    RegionId = "string",
    StorePassword = "string",
});

    example, err := neon.NewProject(ctx, "projectResource", &neon.ProjectArgs{
	AllowedIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllowedIpsProtectedBranchesOnly: pulumi.String("string"),
	Branch: &neon.ProjectBranchArgs{
		DatabaseName: pulumi.String("string"),
		Id:           pulumi.String("string"),
		Name:         pulumi.String("string"),
		RoleName:     pulumi.String("string"),
	},
	ComputeProvisioner: pulumi.String("string"),
	DefaultEndpointSettings: &neon.ProjectDefaultEndpointSettingsArgs{
		AutoscalingLimitMaxCu: pulumi.Float64(0),
		AutoscalingLimitMinCu: pulumi.Float64(0),
		Id:                    pulumi.String("string"),
		SuspendTimeoutSeconds: pulumi.Float64(0),
	},
	EnableLogicalReplication: pulumi.String("string"),
	HistoryRetentionSeconds:  pulumi.Float64(0),
	Name:                     pulumi.String("string"),
	OrgId:                    pulumi.String("string"),
	PgVersion:                pulumi.Float64(0),
	Quota: &neon.ProjectQuotaArgs{
		ActiveTimeSeconds:  pulumi.Float64(0),
		ComputeTimeSeconds: pulumi.Float64(0),
		DataTransferBytes:  pulumi.Float64(0),
		LogicalSizeBytes:   pulumi.Float64(0),
		WrittenDataBytes:   pulumi.Float64(0),
	},
	RegionId:      pulumi.String("string"),
	StorePassword: pulumi.String("string"),
})

    var projectResource = new Project("projectResource", ProjectArgs.builder()
    .allowedIps("string")
    .allowedIpsProtectedBranchesOnly("string")
    .branch(ProjectBranchArgs.builder()
        .databaseName("string")
        .id("string")
        .name("string")
        .roleName("string")
        .build())
    .computeProvisioner("string")
    .defaultEndpointSettings(ProjectDefaultEndpointSettingsArgs.builder()
        .autoscalingLimitMaxCu(0.0)
        .autoscalingLimitMinCu(0.0)
        .id("string")
        .suspendTimeoutSeconds(0.0)
        .build())
    .enableLogicalReplication("string")
    .historyRetentionSeconds(0.0)
    .name("string")
    .orgId("string")
    .pgVersion(0.0)
    .quota(ProjectQuotaArgs.builder()
        .activeTimeSeconds(0.0)
        .computeTimeSeconds(0.0)
        .dataTransferBytes(0.0)
        .logicalSizeBytes(0.0)
        .writtenDataBytes(0.0)
        .build())
    .regionId("string")
    .storePassword("string")
    .build());

    project_resource = neon.Project("projectResource",
    allowed_ips=["string"],
    allowed_ips_protected_branches_only="string",
    branch={
        "database_name": "string",
        "id": "string",
        "name": "string",
        "role_name": "string",
    },
    compute_provisioner="string",
    default_endpoint_settings={
        "autoscaling_limit_max_cu": 0,
        "autoscaling_limit_min_cu": 0,
        "id": "string",
        "suspend_timeout_seconds": 0,
    },
    enable_logical_replication="string",
    history_retention_seconds=0,
    name="string",
    org_id="string",
    pg_version=0,
    quota={
        "active_time_seconds": 0,
        "compute_time_seconds": 0,
        "data_transfer_bytes": 0,
        "logical_size_bytes": 0,
        "written_data_bytes": 0,
    },
    region_id="string",
    store_password="string")

    const projectResource = new neon.Project("projectResource", {
    allowedIps: ["string"],
    allowedIpsProtectedBranchesOnly: "string",
    branch: {
        databaseName: "string",
        id: "string",
        name: "string",
        roleName: "string",
    },
    computeProvisioner: "string",
    defaultEndpointSettings: {
        autoscalingLimitMaxCu: 0,
        autoscalingLimitMinCu: 0,
        id: "string",
        suspendTimeoutSeconds: 0,
    },
    enableLogicalReplication: "string",
    historyRetentionSeconds: 0,
    name: "string",
    orgId: "string",
    pgVersion: 0,
    quota: {
        activeTimeSeconds: 0,
        computeTimeSeconds: 0,
        dataTransferBytes: 0,
        logicalSizeBytes: 0,
        writtenDataBytes: 0,
    },
    regionId: "string",
    storePassword: "string",
});

    type: neon:Project
properties:
    allowedIps:
        - string
    allowedIpsProtectedBranchesOnly: string
    branch:
        databaseName: string
        id: string
        name: string
        roleName: string
    computeProvisioner: string
    defaultEndpointSettings:
        autoscalingLimitMaxCu: 0
        autoscalingLimitMinCu: 0
        id: string
        suspendTimeoutSeconds: 0
    enableLogicalReplication: string
    historyRetentionSeconds: 0
    name: string
    orgId: string
    pgVersion: 0
    quota:
        activeTimeSeconds: 0
        computeTimeSeconds: 0
        dataTransferBytes: 0
        logicalSizeBytes: 0
        writtenDataBytes: 0
    regionId: string
    storePassword: string

    Project 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 Project resource accepts the following input properties:

    AllowedIps List<string>
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    AllowedIpsProtectedBranchesOnly string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    Branch ProjectBranch
    ComputeProvisioner string
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    DefaultEndpointSettings ProjectDefaultEndpointSettings
    EnableLogicalReplication string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    HistoryRetentionSeconds double
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    Name string
    Project name.
    OrgId string
    Identifier of the organisation to which this project belongs.
    PgVersion double
    Postgres version
    Quota ProjectQuota
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    RegionId string
    Deployment region: https://neon.tech/docs/introduction/regions
    StorePassword string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
    AllowedIps []string
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    AllowedIpsProtectedBranchesOnly string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    Branch ProjectBranchArgs
    ComputeProvisioner string
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    DefaultEndpointSettings ProjectDefaultEndpointSettingsArgs
    EnableLogicalReplication string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    HistoryRetentionSeconds float64
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    Name string
    Project name.
    OrgId string
    Identifier of the organisation to which this project belongs.
    PgVersion float64
    Postgres version
    Quota ProjectQuotaArgs
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    RegionId string
    Deployment region: https://neon.tech/docs/introduction/regions
    StorePassword string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
    allowedIps List<String>
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    allowedIpsProtectedBranchesOnly String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    branch ProjectBranch
    computeProvisioner String
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    defaultEndpointSettings ProjectDefaultEndpointSettings
    enableLogicalReplication String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    historyRetentionSeconds Double
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    name String
    Project name.
    orgId String
    Identifier of the organisation to which this project belongs.
    pgVersion Double
    Postgres version
    quota ProjectQuota
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    regionId String
    Deployment region: https://neon.tech/docs/introduction/regions
    storePassword String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
    allowedIps string[]
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    allowedIpsProtectedBranchesOnly string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    branch ProjectBranch
    computeProvisioner string
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    defaultEndpointSettings ProjectDefaultEndpointSettings
    enableLogicalReplication string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    historyRetentionSeconds number
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    name string
    Project name.
    orgId string
    Identifier of the organisation to which this project belongs.
    pgVersion number
    Postgres version
    quota ProjectQuota
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    regionId string
    Deployment region: https://neon.tech/docs/introduction/regions
    storePassword string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
    allowed_ips Sequence[str]
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    allowed_ips_protected_branches_only str
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    branch ProjectBranchArgs
    compute_provisioner str
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    default_endpoint_settings ProjectDefaultEndpointSettingsArgs
    enable_logical_replication str
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    history_retention_seconds float
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    name str
    Project name.
    org_id str
    Identifier of the organisation to which this project belongs.
    pg_version float
    Postgres version
    quota ProjectQuotaArgs
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    region_id str
    Deployment region: https://neon.tech/docs/introduction/regions
    store_password str
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
    allowedIps List<String>
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    allowedIpsProtectedBranchesOnly String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    branch Property Map
    computeProvisioner String
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    defaultEndpointSettings Property Map
    enableLogicalReplication String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    historyRetentionSeconds Number
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    name String
    Project name.
    orgId String
    Identifier of the organisation to which this project belongs.
    pgVersion Number
    Postgres version
    quota Property Map
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    regionId String
    Deployment region: https://neon.tech/docs/introduction/regions
    storePassword String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Project resource produces the following output properties:

    ConnectionUri string
    Default connection uri. Note that it contains access credentials.
    ConnectionUriPooler string
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    DatabaseHost string
    Default database host.
    DatabaseHostPooler string
    Default endpoint host via pooler.
    DatabaseName string
    Default database name.
    DatabasePassword string
    Default database access password.
    DatabaseUser string
    Default database role.
    DefaultBranchId string
    Default branch ID.
    DefaultEndpointId string
    Default endpoint ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    ConnectionUri string
    Default connection uri. Note that it contains access credentials.
    ConnectionUriPooler string
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    DatabaseHost string
    Default database host.
    DatabaseHostPooler string
    Default endpoint host via pooler.
    DatabaseName string
    Default database name.
    DatabasePassword string
    Default database access password.
    DatabaseUser string
    Default database role.
    DefaultBranchId string
    Default branch ID.
    DefaultEndpointId string
    Default endpoint ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    connectionUri String
    Default connection uri. Note that it contains access credentials.
    connectionUriPooler String
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    databaseHost String
    Default database host.
    databaseHostPooler String
    Default endpoint host via pooler.
    databaseName String
    Default database name.
    databasePassword String
    Default database access password.
    databaseUser String
    Default database role.
    defaultBranchId String
    Default branch ID.
    defaultEndpointId String
    Default endpoint ID.
    id String
    The provider-assigned unique ID for this managed resource.
    connectionUri string
    Default connection uri. Note that it contains access credentials.
    connectionUriPooler string
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    databaseHost string
    Default database host.
    databaseHostPooler string
    Default endpoint host via pooler.
    databaseName string
    Default database name.
    databasePassword string
    Default database access password.
    databaseUser string
    Default database role.
    defaultBranchId string
    Default branch ID.
    defaultEndpointId string
    Default endpoint ID.
    id string
    The provider-assigned unique ID for this managed resource.
    connection_uri str
    Default connection uri. Note that it contains access credentials.
    connection_uri_pooler str
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    database_host str
    Default database host.
    database_host_pooler str
    Default endpoint host via pooler.
    database_name str
    Default database name.
    database_password str
    Default database access password.
    database_user str
    Default database role.
    default_branch_id str
    Default branch ID.
    default_endpoint_id str
    Default endpoint ID.
    id str
    The provider-assigned unique ID for this managed resource.
    connectionUri String
    Default connection uri. Note that it contains access credentials.
    connectionUriPooler String
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    databaseHost String
    Default database host.
    databaseHostPooler String
    Default endpoint host via pooler.
    databaseName String
    Default database name.
    databasePassword String
    Default database access password.
    databaseUser String
    Default database role.
    defaultBranchId String
    Default branch ID.
    defaultEndpointId String
    Default endpoint ID.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Project Resource

    Get an existing Project 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?: ProjectState, opts?: CustomResourceOptions): Project
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_ips: Optional[Sequence[str]] = None,
        allowed_ips_protected_branches_only: Optional[str] = None,
        branch: Optional[ProjectBranchArgs] = None,
        compute_provisioner: Optional[str] = None,
        connection_uri: Optional[str] = None,
        connection_uri_pooler: Optional[str] = None,
        database_host: Optional[str] = None,
        database_host_pooler: Optional[str] = None,
        database_name: Optional[str] = None,
        database_password: Optional[str] = None,
        database_user: Optional[str] = None,
        default_branch_id: Optional[str] = None,
        default_endpoint_id: Optional[str] = None,
        default_endpoint_settings: Optional[ProjectDefaultEndpointSettingsArgs] = None,
        enable_logical_replication: Optional[str] = None,
        history_retention_seconds: Optional[float] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        pg_version: Optional[float] = None,
        quota: Optional[ProjectQuotaArgs] = None,
        region_id: Optional[str] = None,
        store_password: Optional[str] = None) -> Project
    func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)
    public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)
    public static Project get(String name, Output<String> id, ProjectState state, CustomResourceOptions options)
    resources:  _:    type: neon:Project    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.
    The following state arguments are supported:
    AllowedIps List<string>
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    AllowedIpsProtectedBranchesOnly string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    Branch ProjectBranch
    ComputeProvisioner string
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    ConnectionUri string
    Default connection uri. Note that it contains access credentials.
    ConnectionUriPooler string
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    DatabaseHost string
    Default database host.
    DatabaseHostPooler string
    Default endpoint host via pooler.
    DatabaseName string
    Default database name.
    DatabasePassword string
    Default database access password.
    DatabaseUser string
    Default database role.
    DefaultBranchId string
    Default branch ID.
    DefaultEndpointId string
    Default endpoint ID.
    DefaultEndpointSettings ProjectDefaultEndpointSettings
    EnableLogicalReplication string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    HistoryRetentionSeconds double
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    Name string
    Project name.
    OrgId string
    Identifier of the organisation to which this project belongs.
    PgVersion double
    Postgres version
    Quota ProjectQuota
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    RegionId string
    Deployment region: https://neon.tech/docs/introduction/regions
    StorePassword string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
    AllowedIps []string
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    AllowedIpsProtectedBranchesOnly string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    Branch ProjectBranchArgs
    ComputeProvisioner string
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    ConnectionUri string
    Default connection uri. Note that it contains access credentials.
    ConnectionUriPooler string
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    DatabaseHost string
    Default database host.
    DatabaseHostPooler string
    Default endpoint host via pooler.
    DatabaseName string
    Default database name.
    DatabasePassword string
    Default database access password.
    DatabaseUser string
    Default database role.
    DefaultBranchId string
    Default branch ID.
    DefaultEndpointId string
    Default endpoint ID.
    DefaultEndpointSettings ProjectDefaultEndpointSettingsArgs
    EnableLogicalReplication string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    HistoryRetentionSeconds float64
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    Name string
    Project name.
    OrgId string
    Identifier of the organisation to which this project belongs.
    PgVersion float64
    Postgres version
    Quota ProjectQuotaArgs
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    RegionId string
    Deployment region: https://neon.tech/docs/introduction/regions
    StorePassword string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
    allowedIps List<String>
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    allowedIpsProtectedBranchesOnly String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    branch ProjectBranch
    computeProvisioner String
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    connectionUri String
    Default connection uri. Note that it contains access credentials.
    connectionUriPooler String
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    databaseHost String
    Default database host.
    databaseHostPooler String
    Default endpoint host via pooler.
    databaseName String
    Default database name.
    databasePassword String
    Default database access password.
    databaseUser String
    Default database role.
    defaultBranchId String
    Default branch ID.
    defaultEndpointId String
    Default endpoint ID.
    defaultEndpointSettings ProjectDefaultEndpointSettings
    enableLogicalReplication String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    historyRetentionSeconds Double
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    name String
    Project name.
    orgId String
    Identifier of the organisation to which this project belongs.
    pgVersion Double
    Postgres version
    quota ProjectQuota
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    regionId String
    Deployment region: https://neon.tech/docs/introduction/regions
    storePassword String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
    allowedIps string[]
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    allowedIpsProtectedBranchesOnly string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    branch ProjectBranch
    computeProvisioner string
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    connectionUri string
    Default connection uri. Note that it contains access credentials.
    connectionUriPooler string
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    databaseHost string
    Default database host.
    databaseHostPooler string
    Default endpoint host via pooler.
    databaseName string
    Default database name.
    databasePassword string
    Default database access password.
    databaseUser string
    Default database role.
    defaultBranchId string
    Default branch ID.
    defaultEndpointId string
    Default endpoint ID.
    defaultEndpointSettings ProjectDefaultEndpointSettings
    enableLogicalReplication string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    historyRetentionSeconds number
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    name string
    Project name.
    orgId string
    Identifier of the organisation to which this project belongs.
    pgVersion number
    Postgres version
    quota ProjectQuota
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    regionId string
    Deployment region: https://neon.tech/docs/introduction/regions
    storePassword string
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
    allowed_ips Sequence[str]
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    allowed_ips_protected_branches_only str
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    branch ProjectBranchArgs
    compute_provisioner str
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    connection_uri str
    Default connection uri. Note that it contains access credentials.
    connection_uri_pooler str
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    database_host str
    Default database host.
    database_host_pooler str
    Default endpoint host via pooler.
    database_name str
    Default database name.
    database_password str
    Default database access password.
    database_user str
    Default database role.
    default_branch_id str
    Default branch ID.
    default_endpoint_id str
    Default endpoint ID.
    default_endpoint_settings ProjectDefaultEndpointSettingsArgs
    enable_logical_replication str
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    history_retention_seconds float
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    name str
    Project name.
    org_id str
    Identifier of the organisation to which this project belongs.
    pg_version float
    Postgres version
    quota ProjectQuotaArgs
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    region_id str
    Deployment region: https://neon.tech/docs/introduction/regions
    store_password str
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
    allowedIps List<String>
    A list of IP addresses that are allowed to connect to the endpoints. Note that the feature is available to the Neon Scale plans only. Details: https://neon.tech/docs/manage/projects#configure-ip-allow
    allowedIpsProtectedBranchesOnly String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Apply the allow-list to the protected branches only. Note that the feature is available to the Neon Scale plans only.
    branch Property Map
    computeProvisioner String
    Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
    connectionUri String
    Default connection uri. Note that it contains access credentials.
    connectionUriPooler String
    Default connection uri with the traffic via pooler. Note that it contains access credentials.
    databaseHost String
    Default database host.
    databaseHostPooler String
    Default endpoint host via pooler.
    databaseName String
    Default database name.
    databasePassword String
    Default database access password.
    databaseUser String
    Default database role.
    defaultBranchId String
    Default branch ID.
    defaultEndpointId String
    Default endpoint ID.
    defaultEndpointSettings Property Map
    enableLogicalReplication String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled. See details: https://neon.tech/docs/introduction/logical-replication
    historyRetentionSeconds Number
    The number of seconds to retain the point-in-time restore (PITR) backup history for this project. Default: 1 day, see https://neon.tech/docs/reference/glossary#point-in-time-restore.
    name String
    Project name.
    orgId String
    Identifier of the organisation to which this project belongs.
    pgVersion Number
    Postgres version
    quota Property Map
    Per-project consumption quota. If the quota is exceeded, all active computes are automatically suspended and it will not be possible to start them with an API method call or incoming proxy connections. The only exception is logicalsizebytes, which is applied on per-branch basis, i.e., only the compute on the branch that exceeds the logical_size quota will be suspended.
    regionId String
    Deployment region: https://neon.tech/docs/introduction/regions
    storePassword String
    Set to 'yes' to activate, 'no' to deactivate explicitly, and omit to keep the default value. Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.

    Supporting Types

    ProjectBranch, ProjectBranchArgs

    DatabaseName string
    The name of the default database provisioned upon creation of new project. It's owned by the default role (role_name). If not specified, the default database name will be used.
    Id string
    Branch ID.
    Name string
    The name of the default branch provisioned upon creation of new project. If not specified, the default branch name will be used.
    RoleName string
    The name of the default role provisioned upon creation of new project. If not specified, the default role name will be used.
    DatabaseName string
    The name of the default database provisioned upon creation of new project. It's owned by the default role (role_name). If not specified, the default database name will be used.
    Id string
    Branch ID.
    Name string
    The name of the default branch provisioned upon creation of new project. If not specified, the default branch name will be used.
    RoleName string
    The name of the default role provisioned upon creation of new project. If not specified, the default role name will be used.
    databaseName String
    The name of the default database provisioned upon creation of new project. It's owned by the default role (role_name). If not specified, the default database name will be used.
    id String
    Branch ID.
    name String
    The name of the default branch provisioned upon creation of new project. If not specified, the default branch name will be used.
    roleName String
    The name of the default role provisioned upon creation of new project. If not specified, the default role name will be used.
    databaseName string
    The name of the default database provisioned upon creation of new project. It's owned by the default role (role_name). If not specified, the default database name will be used.
    id string
    Branch ID.
    name string
    The name of the default branch provisioned upon creation of new project. If not specified, the default branch name will be used.
    roleName string
    The name of the default role provisioned upon creation of new project. If not specified, the default role name will be used.
    database_name str
    The name of the default database provisioned upon creation of new project. It's owned by the default role (role_name). If not specified, the default database name will be used.
    id str
    Branch ID.
    name str
    The name of the default branch provisioned upon creation of new project. If not specified, the default branch name will be used.
    role_name str
    The name of the default role provisioned upon creation of new project. If not specified, the default role name will be used.
    databaseName String
    The name of the default database provisioned upon creation of new project. It's owned by the default role (role_name). If not specified, the default database name will be used.
    id String
    Branch ID.
    name String
    The name of the default branch provisioned upon creation of new project. If not specified, the default branch name will be used.
    roleName String
    The name of the default role provisioned upon creation of new project. If not specified, the default role name will be used.

    ProjectDefaultEndpointSettings, ProjectDefaultEndpointSettingsArgs

    AutoscalingLimitMaxCu double
    AutoscalingLimitMinCu double
    Id string
    Endpoint ID.
    SuspendTimeoutSeconds double
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value 0 means use the global default. The value -1 means never suspend. The default value is 300 seconds (5 minutes). The maximum value is 604800 seconds (1 week)
    AutoscalingLimitMaxCu float64
    AutoscalingLimitMinCu float64
    Id string
    Endpoint ID.
    SuspendTimeoutSeconds float64
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value 0 means use the global default. The value -1 means never suspend. The default value is 300 seconds (5 minutes). The maximum value is 604800 seconds (1 week)
    autoscalingLimitMaxCu Double
    autoscalingLimitMinCu Double
    id String
    Endpoint ID.
    suspendTimeoutSeconds Double
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value 0 means use the global default. The value -1 means never suspend. The default value is 300 seconds (5 minutes). The maximum value is 604800 seconds (1 week)
    autoscalingLimitMaxCu number
    autoscalingLimitMinCu number
    id string
    Endpoint ID.
    suspendTimeoutSeconds number
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value 0 means use the global default. The value -1 means never suspend. The default value is 300 seconds (5 minutes). The maximum value is 604800 seconds (1 week)
    autoscaling_limit_max_cu float
    autoscaling_limit_min_cu float
    id str
    Endpoint ID.
    suspend_timeout_seconds float
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value 0 means use the global default. The value -1 means never suspend. The default value is 300 seconds (5 minutes). The maximum value is 604800 seconds (1 week)
    autoscalingLimitMaxCu Number
    autoscalingLimitMinCu Number
    id String
    Endpoint ID.
    suspendTimeoutSeconds Number
    Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value 0 means use the global default. The value -1 means never suspend. The default value is 300 seconds (5 minutes). The maximum value is 604800 seconds (1 week)

    ProjectQuota, ProjectQuotaArgs

    ActiveTimeSeconds double
    The total amount of wall-clock time allowed to be spent by the project's compute endpoints.
    ComputeTimeSeconds double
    The total amount of CPU seconds allowed to be spent by the project's compute endpoints.
    DataTransferBytes double
    Total amount of data transferred from all of a project's branches using the proxy.
    LogicalSizeBytes double
    Limit on the logical size of every project's branch.
    WrittenDataBytes double
    Total amount of data written to all of a project's branches.
    ActiveTimeSeconds float64
    The total amount of wall-clock time allowed to be spent by the project's compute endpoints.
    ComputeTimeSeconds float64
    The total amount of CPU seconds allowed to be spent by the project's compute endpoints.
    DataTransferBytes float64
    Total amount of data transferred from all of a project's branches using the proxy.
    LogicalSizeBytes float64
    Limit on the logical size of every project's branch.
    WrittenDataBytes float64
    Total amount of data written to all of a project's branches.
    activeTimeSeconds Double
    The total amount of wall-clock time allowed to be spent by the project's compute endpoints.
    computeTimeSeconds Double
    The total amount of CPU seconds allowed to be spent by the project's compute endpoints.
    dataTransferBytes Double
    Total amount of data transferred from all of a project's branches using the proxy.
    logicalSizeBytes Double
    Limit on the logical size of every project's branch.
    writtenDataBytes Double
    Total amount of data written to all of a project's branches.
    activeTimeSeconds number
    The total amount of wall-clock time allowed to be spent by the project's compute endpoints.
    computeTimeSeconds number
    The total amount of CPU seconds allowed to be spent by the project's compute endpoints.
    dataTransferBytes number
    Total amount of data transferred from all of a project's branches using the proxy.
    logicalSizeBytes number
    Limit on the logical size of every project's branch.
    writtenDataBytes number
    Total amount of data written to all of a project's branches.
    active_time_seconds float
    The total amount of wall-clock time allowed to be spent by the project's compute endpoints.
    compute_time_seconds float
    The total amount of CPU seconds allowed to be spent by the project's compute endpoints.
    data_transfer_bytes float
    Total amount of data transferred from all of a project's branches using the proxy.
    logical_size_bytes float
    Limit on the logical size of every project's branch.
    written_data_bytes float
    Total amount of data written to all of a project's branches.
    activeTimeSeconds Number
    The total amount of wall-clock time allowed to be spent by the project's compute endpoints.
    computeTimeSeconds Number
    The total amount of CPU seconds allowed to be spent by the project's compute endpoints.
    dataTransferBytes Number
    Total amount of data transferred from all of a project's branches using the proxy.
    logicalSizeBytes Number
    Limit on the logical size of every project's branch.
    writtenDataBytes Number
    Total amount of data written to all of a project's branches.

    Import

    The Neon Project can be imported to the terraform state by its identifier.

    Import using the import block:

    For example:

    hcl

    import {

    to = neon_project.example

    id = “shiny-cell-31746257”

    }

    Import using the command pulumi import:

    commandline

    $ pulumi import neon:index/project:Project example shiny-cell-31746257

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    neon kislerdm/terraform-provider-neon
    License
    Notes
    This Pulumi package is based on the neon Terraform Provider.
    neon logo
    neon 0.9.0 published on Tuesday, May 6, 2025 by kislerdm
    kislerdm/terraform-provider-neon