neon.Endpoint
Explore with Pulumi AI
Project Endpoint. See details: https://neon.tech/docs/manage/endpoints/
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as neon from "@pulumi/neon";
const exampleProject = new neon.Project("exampleProject", {});
const exampleBranch = new neon.Branch("exampleBranch", {projectId: exampleProject.id});
const exampleEndpoint = new neon.Endpoint("exampleEndpoint", {
projectId: exampleProject.id,
branchId: exampleBranch.id,
type: "read_write",
});
import pulumi
import pulumi_neon as neon
example_project = neon.Project("exampleProject")
example_branch = neon.Branch("exampleBranch", project_id=example_project.id)
example_endpoint = neon.Endpoint("exampleEndpoint",
project_id=example_project.id,
branch_id=example_branch.id,
type="read_write")
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 {
exampleProject, err := neon.NewProject(ctx, "exampleProject", nil)
if err != nil {
return err
}
exampleBranch, err := neon.NewBranch(ctx, "exampleBranch", &neon.BranchArgs{
ProjectId: exampleProject.ID(),
})
if err != nil {
return err
}
_, err = neon.NewEndpoint(ctx, "exampleEndpoint", &neon.EndpointArgs{
ProjectId: exampleProject.ID(),
BranchId: exampleBranch.ID(),
Type: pulumi.String("read_write"),
})
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 exampleProject = new Neon.Project("exampleProject");
var exampleBranch = new Neon.Branch("exampleBranch", new()
{
ProjectId = exampleProject.Id,
});
var exampleEndpoint = new Neon.Endpoint("exampleEndpoint", new()
{
ProjectId = exampleProject.Id,
BranchId = exampleBranch.Id,
Type = "read_write",
});
});
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.Branch;
import com.pulumi.neon.BranchArgs;
import com.pulumi.neon.Endpoint;
import com.pulumi.neon.EndpointArgs;
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 exampleProject = new Project("exampleProject");
var exampleBranch = new Branch("exampleBranch", BranchArgs.builder()
.projectId(exampleProject.id())
.build());
var exampleEndpoint = new Endpoint("exampleEndpoint", EndpointArgs.builder()
.projectId(exampleProject.id())
.branchId(exampleBranch.id())
.type("read_write")
.build());
}
}
resources:
exampleProject:
type: neon:Project
exampleBranch:
type: neon:Branch
properties:
projectId: ${exampleProject.id}
exampleEndpoint:
type: neon:Endpoint
properties:
projectId: ${exampleProject.id}
branchId: ${exampleBranch.id}
type: read_write
Create Endpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
@overload
def Endpoint(resource_name: str,
args: EndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Endpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
branch_id: Optional[str] = None,
project_id: Optional[str] = None,
autoscaling_limit_max_cu: Optional[float] = None,
autoscaling_limit_min_cu: Optional[float] = None,
compute_provisioner: Optional[str] = None,
disabled: Optional[bool] = None,
pg_settings: Optional[Mapping[str, str]] = None,
pooler_enabled: Optional[bool] = None,
pooler_mode: Optional[str] = None,
region_id: Optional[str] = None,
suspend_timeout_seconds: Optional[float] = None,
type: Optional[str] = None)
func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)
public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)
type: neon:Endpoint
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 EndpointArgs
- 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 EndpointArgs
- 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 EndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EndpointArgs
- 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 endpointResource = new Neon.Endpoint("endpointResource", new()
{
BranchId = "string",
ProjectId = "string",
AutoscalingLimitMaxCu = 0,
AutoscalingLimitMinCu = 0,
ComputeProvisioner = "string",
Disabled = false,
PgSettings =
{
{ "string", "string" },
},
PoolerEnabled = false,
PoolerMode = "string",
RegionId = "string",
SuspendTimeoutSeconds = 0,
Type = "string",
});
example, err := neon.NewEndpoint(ctx, "endpointResource", &neon.EndpointArgs{
BranchId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
AutoscalingLimitMaxCu: pulumi.Float64(0),
AutoscalingLimitMinCu: pulumi.Float64(0),
ComputeProvisioner: pulumi.String("string"),
Disabled: pulumi.Bool(false),
PgSettings: pulumi.StringMap{
"string": pulumi.String("string"),
},
PoolerEnabled: pulumi.Bool(false),
PoolerMode: pulumi.String("string"),
RegionId: pulumi.String("string"),
SuspendTimeoutSeconds: pulumi.Float64(0),
Type: pulumi.String("string"),
})
var endpointResource = new Endpoint("endpointResource", EndpointArgs.builder()
.branchId("string")
.projectId("string")
.autoscalingLimitMaxCu(0.0)
.autoscalingLimitMinCu(0.0)
.computeProvisioner("string")
.disabled(false)
.pgSettings(Map.of("string", "string"))
.poolerEnabled(false)
.poolerMode("string")
.regionId("string")
.suspendTimeoutSeconds(0.0)
.type("string")
.build());
endpoint_resource = neon.Endpoint("endpointResource",
branch_id="string",
project_id="string",
autoscaling_limit_max_cu=0,
autoscaling_limit_min_cu=0,
compute_provisioner="string",
disabled=False,
pg_settings={
"string": "string",
},
pooler_enabled=False,
pooler_mode="string",
region_id="string",
suspend_timeout_seconds=0,
type="string")
const endpointResource = new neon.Endpoint("endpointResource", {
branchId: "string",
projectId: "string",
autoscalingLimitMaxCu: 0,
autoscalingLimitMinCu: 0,
computeProvisioner: "string",
disabled: false,
pgSettings: {
string: "string",
},
poolerEnabled: false,
poolerMode: "string",
regionId: "string",
suspendTimeoutSeconds: 0,
type: "string",
});
type: neon:Endpoint
properties:
autoscalingLimitMaxCu: 0
autoscalingLimitMinCu: 0
branchId: string
computeProvisioner: string
disabled: false
pgSettings:
string: string
poolerEnabled: false
poolerMode: string
projectId: string
regionId: string
suspendTimeoutSeconds: 0
type: string
Endpoint 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 Endpoint resource accepts the following input properties:
- Branch
Id string - Branch ID.
- Project
Id string - Project ID.
- Autoscaling
Limit doubleMax Cu - Autoscaling
Limit doubleMin Cu - Compute
Provisioner string - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- Disabled bool
- Disable the endpoint.
- Pg
Settings Dictionary<string, string> - Pooler
Enabled bool - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- Pooler
Mode string - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- Region
Id string - Deployment region: https://neon.tech/docs/introduction/regions
- Suspend
Timeout doubleSeconds - 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)
- Type string
- Access type. Note that a single branch can have only one "read_write" endpoint.
- Branch
Id string - Branch ID.
- Project
Id string - Project ID.
- Autoscaling
Limit float64Max Cu - Autoscaling
Limit float64Min Cu - Compute
Provisioner string - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- Disabled bool
- Disable the endpoint.
- Pg
Settings map[string]string - Pooler
Enabled bool - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- Pooler
Mode string - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- Region
Id string - Deployment region: https://neon.tech/docs/introduction/regions
- Suspend
Timeout float64Seconds - 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)
- Type string
- Access type. Note that a single branch can have only one "read_write" endpoint.
- branch
Id String - Branch ID.
- project
Id String - Project ID.
- autoscaling
Limit DoubleMax Cu - autoscaling
Limit DoubleMin Cu - compute
Provisioner String - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- disabled Boolean
- Disable the endpoint.
- pg
Settings Map<String,String> - pooler
Enabled Boolean - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- pooler
Mode String - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- region
Id String - Deployment region: https://neon.tech/docs/introduction/regions
- suspend
Timeout DoubleSeconds - 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)
- type String
- Access type. Note that a single branch can have only one "read_write" endpoint.
- branch
Id string - Branch ID.
- project
Id string - Project ID.
- autoscaling
Limit numberMax Cu - autoscaling
Limit numberMin Cu - compute
Provisioner string - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- disabled boolean
- Disable the endpoint.
- pg
Settings {[key: string]: string} - pooler
Enabled boolean - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- pooler
Mode string - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- region
Id string - Deployment region: https://neon.tech/docs/introduction/regions
- suspend
Timeout numberSeconds - 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)
- type string
- Access type. Note that a single branch can have only one "read_write" endpoint.
- branch_
id str - Branch ID.
- project_
id str - Project ID.
- autoscaling_
limit_ floatmax_ cu - autoscaling_
limit_ floatmin_ cu - compute_
provisioner str - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- disabled bool
- Disable the endpoint.
- pg_
settings Mapping[str, str] - pooler_
enabled bool - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- pooler_
mode str - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- region_
id str - Deployment region: https://neon.tech/docs/introduction/regions
- suspend_
timeout_ floatseconds - 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)
- type str
- Access type. Note that a single branch can have only one "read_write" endpoint.
- branch
Id String - Branch ID.
- project
Id String - Project ID.
- autoscaling
Limit NumberMax Cu - autoscaling
Limit NumberMin Cu - compute
Provisioner String - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- disabled Boolean
- Disable the endpoint.
- pg
Settings Map<String> - pooler
Enabled Boolean - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- pooler
Mode String - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- region
Id String - Deployment region: https://neon.tech/docs/introduction/regions
- suspend
Timeout NumberSeconds - 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)
- type String
- Access type. Note that a single branch can have only one "read_write" endpoint.
Outputs
All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:
- host str
- Endpoint URI.
- id str
- The provider-assigned unique ID for this managed resource.
- proxy_
host str
Look up Existing Endpoint Resource
Get an existing Endpoint 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?: EndpointState, opts?: CustomResourceOptions): Endpoint
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
autoscaling_limit_max_cu: Optional[float] = None,
autoscaling_limit_min_cu: Optional[float] = None,
branch_id: Optional[str] = None,
compute_provisioner: Optional[str] = None,
disabled: Optional[bool] = None,
host: Optional[str] = None,
pg_settings: Optional[Mapping[str, str]] = None,
pooler_enabled: Optional[bool] = None,
pooler_mode: Optional[str] = None,
project_id: Optional[str] = None,
proxy_host: Optional[str] = None,
region_id: Optional[str] = None,
suspend_timeout_seconds: Optional[float] = None,
type: Optional[str] = None) -> Endpoint
func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)
public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)
public static Endpoint get(String name, Output<String> id, EndpointState state, CustomResourceOptions options)
resources: _: type: neon:Endpoint 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.
- Autoscaling
Limit doubleMax Cu - Autoscaling
Limit doubleMin Cu - Branch
Id string - Branch ID.
- Compute
Provisioner string - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- Disabled bool
- Disable the endpoint.
- Host string
- Endpoint URI.
- Pg
Settings Dictionary<string, string> - Pooler
Enabled bool - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- Pooler
Mode string - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- Project
Id string - Project ID.
- Proxy
Host string - Region
Id string - Deployment region: https://neon.tech/docs/introduction/regions
- Suspend
Timeout doubleSeconds - 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)
- Type string
- Access type. Note that a single branch can have only one "read_write" endpoint.
- Autoscaling
Limit float64Max Cu - Autoscaling
Limit float64Min Cu - Branch
Id string - Branch ID.
- Compute
Provisioner string - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- Disabled bool
- Disable the endpoint.
- Host string
- Endpoint URI.
- Pg
Settings map[string]string - Pooler
Enabled bool - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- Pooler
Mode string - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- Project
Id string - Project ID.
- Proxy
Host string - Region
Id string - Deployment region: https://neon.tech/docs/introduction/regions
- Suspend
Timeout float64Seconds - 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)
- Type string
- Access type. Note that a single branch can have only one "read_write" endpoint.
- autoscaling
Limit DoubleMax Cu - autoscaling
Limit DoubleMin Cu - branch
Id String - Branch ID.
- compute
Provisioner String - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- disabled Boolean
- Disable the endpoint.
- host String
- Endpoint URI.
- pg
Settings Map<String,String> - pooler
Enabled Boolean - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- pooler
Mode String - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- project
Id String - Project ID.
- proxy
Host String - region
Id String - Deployment region: https://neon.tech/docs/introduction/regions
- suspend
Timeout DoubleSeconds - 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)
- type String
- Access type. Note that a single branch can have only one "read_write" endpoint.
- autoscaling
Limit numberMax Cu - autoscaling
Limit numberMin Cu - branch
Id string - Branch ID.
- compute
Provisioner string - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- disabled boolean
- Disable the endpoint.
- host string
- Endpoint URI.
- pg
Settings {[key: string]: string} - pooler
Enabled boolean - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- pooler
Mode string - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- project
Id string - Project ID.
- proxy
Host string - region
Id string - Deployment region: https://neon.tech/docs/introduction/regions
- suspend
Timeout numberSeconds - 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)
- type string
- Access type. Note that a single branch can have only one "read_write" endpoint.
- autoscaling_
limit_ floatmax_ cu - autoscaling_
limit_ floatmin_ cu - branch_
id str - Branch ID.
- compute_
provisioner str - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- disabled bool
- Disable the endpoint.
- host str
- Endpoint URI.
- pg_
settings Mapping[str, str] - pooler_
enabled bool - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- pooler_
mode str - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- project_
id str - Project ID.
- proxy_
host str - region_
id str - Deployment region: https://neon.tech/docs/introduction/regions
- suspend_
timeout_ floatseconds - 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)
- type str
- Access type. Note that a single branch can have only one "read_write" endpoint.
- autoscaling
Limit NumberMax Cu - autoscaling
Limit NumberMin Cu - branch
Id String - Branch ID.
- compute
Provisioner String - Provisioner The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling.
- disabled Boolean
- Disable the endpoint.
- host String
- Endpoint URI.
- pg
Settings Map<String> - pooler
Enabled Boolean - Activate connection pooling. See details: https://neon.tech/docs/connect/connection-pooling
- pooler
Mode String - Mode of connections pooling. See details: https://neon.tech/docs/connect/connection-pooling
- project
Id String - Project ID.
- proxy
Host String - region
Id String - Deployment region: https://neon.tech/docs/introduction/regions
- suspend
Timeout NumberSeconds - 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)
- type String
- Access type. Note that a single branch can have only one "read_write" endpoint.
Import
The Neon Endpoint can be imported to the terraform state by its identifier.
Import using the import block:
For example:
hcl
import {
to = neon_endpoint.example
id = “ep-black-mouse-a64dr7wp”
}
Import using the command pulumi import
:
commandline
$ pulumi import neon:index/endpoint:Endpoint example ep-black-mouse-a64dr7wp
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.