Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. Postgres
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
Schema (JSON)
dimeskigj/pulumi-dokploy

dokploy.Postgres

dokploy logo Dokploy
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
Schema (JSON)
dimeskigj/pulumi-dokploy

    A Dokploy PostgreSQL database.

    Create Postgres Resource

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

    Constructor syntax

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

@overload
def Postgres(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             database_name: Optional[str] = None,
             database_password: Optional[str] = None,
             database_user: Optional[str] = None,
             environment_id: Optional[str] = None,
             name: Optional[str] = None,
             app_name: Optional[str] = None,
             description: Optional[str] = None,
             docker_image: Optional[str] = None,
             environment: Optional[str] = None,
             external_port: Optional[int] = None,
             server_id: Optional[str] = None)
    func NewPostgres(ctx *Context, name string, args PostgresArgs, opts ...ResourceOption) (*Postgres, error)
    public Postgres(string name, PostgresArgs args, CustomResourceOptions? opts = null)
    public Postgres(String name, PostgresArgs args)
public Postgres(String name, PostgresArgs args, CustomResourceOptions options)

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


    resource "dokploy_postgres" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PostgresArgs
    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 PostgresArgs
    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 PostgresArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PostgresArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PostgresArgs
    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 postgresResource = new Dokploy.Postgres("postgresResource", new()
{
    DatabaseName = "string",
    DatabasePassword = "string",
    DatabaseUser = "string",
    EnvironmentId = "string",
    Name = "string",
    AppName = "string",
    Description = "string",
    DockerImage = "string",
    Environment = "string",
    ExternalPort = 0,
    ServerId = "string",
});

    example, err := dokploy.NewPostgres(ctx, "postgresResource", &dokploy.PostgresArgs{
	DatabaseName:     pulumi.String("string"),
	DatabasePassword: pulumi.String("string"),
	DatabaseUser:     pulumi.String("string"),
	EnvironmentId:    pulumi.String("string"),
	Name:             pulumi.String("string"),
	AppName:          pulumi.String("string"),
	Description:      pulumi.String("string"),
	DockerImage:      pulumi.String("string"),
	Environment:      pulumi.String("string"),
	ExternalPort:     pulumi.Int(0),
	ServerId:         pulumi.String("string"),
})

    resource "dokploy_postgres" "postgresResource" {
  pulumi {
    replace_on_changes = [environment_id, server_id]
  }
  lifecycle {
    create_before_destroy = true
  }
  database_name     = "string"
  database_password = "string"
  database_user     = "string"
  environment_id    = "string"
  name              = "string"
  app_name          = "string"
  description       = "string"
  docker_image      = "string"
  environment       = "string"
  external_port     = 0
  server_id         = "string"
}

    var postgresResource = new Postgres("postgresResource", PostgresArgs.builder()
    .databaseName("string")
    .databasePassword("string")
    .databaseUser("string")
    .environmentId("string")
    .name("string")
    .appName("string")
    .description("string")
    .dockerImage("string")
    .environment("string")
    .externalPort(0)
    .serverId("string")
    .build());

    postgres_resource = dokploy.Postgres("postgresResource",
    database_name="string",
    database_password="string",
    database_user="string",
    environment_id="string",
    name="string",
    app_name="string",
    description="string",
    docker_image="string",
    environment="string",
    external_port=0,
    server_id="string")

    const postgresResource = new dokploy.Postgres("postgresResource", {
    databaseName: "string",
    databasePassword: "string",
    databaseUser: "string",
    environmentId: "string",
    name: "string",
    appName: "string",
    description: "string",
    dockerImage: "string",
    environment: "string",
    externalPort: 0,
    serverId: "string",
});

    type: dokploy:Postgres
properties:
    appName: string
    databaseName: string
    databasePassword: string
    databaseUser: string
    description: string
    dockerImage: string
    environment: string
    environmentId: string
    externalPort: 0
    name: string
    serverId: string

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

    DatabaseName string
    The PostgreSQL database name.
    DatabasePassword string
    The PostgreSQL database password.
    DatabaseUser string
    The PostgreSQL database user.
    EnvironmentId string
    The target environment ID.
    Name string
    The database resource name.
    AppName string
    The optional deployed database name.
    Description string
    An optional database description.
    DockerImage string
    The PostgreSQL Docker image.
    Environment string
    Environment variables for PostgreSQL.
    ExternalPort int
    The optional externally exposed port.
    ServerId string
    The optional server ID.
    DatabaseName string
    The PostgreSQL database name.
    DatabasePassword string
    The PostgreSQL database password.
    DatabaseUser string
    The PostgreSQL database user.
    EnvironmentId string
    The target environment ID.
    Name string
    The database resource name.
    AppName string
    The optional deployed database name.
    Description string
    An optional database description.
    DockerImage string
    The PostgreSQL Docker image.
    Environment string
    Environment variables for PostgreSQL.
    ExternalPort int
    The optional externally exposed port.
    ServerId string
    The optional server ID.
    database_name string
    The PostgreSQL database name.
    database_password string
    The PostgreSQL database password.
    database_user string
    The PostgreSQL database user.
    environment_id string
    The target environment ID.
    name string
    The database resource name.
    app_name string
    The optional deployed database name.
    description string
    An optional database description.
    docker_image string
    The PostgreSQL Docker image.
    environment string
    Environment variables for PostgreSQL.
    external_port number
    The optional externally exposed port.
    server_id string
    The optional server ID.
    databaseName String
    The PostgreSQL database name.
    databasePassword String
    The PostgreSQL database password.
    databaseUser String
    The PostgreSQL database user.
    environmentId String
    The target environment ID.
    name String
    The database resource name.
    appName String
    The optional deployed database name.
    description String
    An optional database description.
    dockerImage String
    The PostgreSQL Docker image.
    environment String
    Environment variables for PostgreSQL.
    externalPort Integer
    The optional externally exposed port.
    serverId String
    The optional server ID.
    databaseName string
    The PostgreSQL database name.
    databasePassword string
    The PostgreSQL database password.
    databaseUser string
    The PostgreSQL database user.
    environmentId string
    The target environment ID.
    name string
    The database resource name.
    appName string
    The optional deployed database name.
    description string
    An optional database description.
    dockerImage string
    The PostgreSQL Docker image.
    environment string
    Environment variables for PostgreSQL.
    externalPort number
    The optional externally exposed port.
    serverId string
    The optional server ID.
    database_name str
    The PostgreSQL database name.
    database_password str
    The PostgreSQL database password.
    database_user str
    The PostgreSQL database user.
    environment_id str
    The target environment ID.
    name str
    The database resource name.
    app_name str
    The optional deployed database name.
    description str
    An optional database description.
    docker_image str
    The PostgreSQL Docker image.
    environment str
    Environment variables for PostgreSQL.
    external_port int
    The optional externally exposed port.
    server_id str
    The optional server ID.
    databaseName String
    The PostgreSQL database name.
    databasePassword String
    The PostgreSQL database password.
    databaseUser String
    The PostgreSQL database user.
    environmentId String
    The target environment ID.
    name String
    The database resource name.
    appName String
    The optional deployed database name.
    description String
    An optional database description.
    dockerImage String
    The PostgreSQL Docker image.
    environment String
    Environment variables for PostgreSQL.
    externalPort Number
    The optional externally exposed port.
    serverId String
    The optional server ID.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    PostgresId string
    The stable Dokploy PostgreSQL ID.
    Status string
    The current PostgreSQL deployment status.
    Id string
    The provider-assigned unique ID for this managed resource.
    PostgresId string
    The stable Dokploy PostgreSQL ID.
    Status string
    The current PostgreSQL deployment status.
    id string
    The provider-assigned unique ID for this managed resource.
    postgres_id string
    The stable Dokploy PostgreSQL ID.
    status string
    The current PostgreSQL deployment status.
    id String
    The provider-assigned unique ID for this managed resource.
    postgresId String
    The stable Dokploy PostgreSQL ID.
    status String
    The current PostgreSQL deployment status.
    id string
    The provider-assigned unique ID for this managed resource.
    postgresId string
    The stable Dokploy PostgreSQL ID.
    status string
    The current PostgreSQL deployment status.
    id str
    The provider-assigned unique ID for this managed resource.
    postgres_id str
    The stable Dokploy PostgreSQL ID.
    status str
    The current PostgreSQL deployment status.
    id String
    The provider-assigned unique ID for this managed resource.
    postgresId String
    The stable Dokploy PostgreSQL ID.
    status String
    The current PostgreSQL deployment status.

    Package Details

    Repository
    dokploy dimeskigj/pulumi-dokploy
    License
    Apache-2.0
    dokploy logo Dokploy
    Viewing docs for Dokploy v0.3.1
    published on Tuesday, Sep 29, 2026 by dimeskigj
    Schema (JSON)
    dimeskigj/pulumi-dokploy

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial