Server class

The postgresql.Server resource creates and manages a foreign server on a PostgreSQL server.

Usage

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

const extPostgresFdw = new postgresql.Extension("ext_postgres_fdw", {name: "postgres_fdw"});
const myserverPostgres = new postgresql.Server("myserver_postgres", {
    serverName: "myserver_postgres",
    fdwName: "postgres_fdw",
    options: {
        host: "foo",
        dbname: "foodb",
        port: "5432",
    },
}, {
    dependsOn: [extPostgresFdw],
});
import pulumi
import pulumi_postgresql as postgresql

ext_postgres_fdw = postgresql.Extension("ext_postgres_fdw", name="postgres_fdw")
myserver_postgres = postgresql.Server("myserver_postgres",
    server_name="myserver_postgres",
    fdw_name="postgres_fdw",
    options={
        "host": "foo",
        "dbname": "foodb",
        "port": "5432",
    },
    opts = pulumi.ResourceOptions(depends_on=[ext_postgres_fdw]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;

return await Deployment.RunAsync(() =>
{
    var extPostgresFdw = new PostgreSql.Extension("ext_postgres_fdw", new()
    {
        Name = "postgres_fdw",
    });

    var myserverPostgres = new PostgreSql.Server("myserver_postgres", new()
    {
        ServerName = "myserver_postgres",
        FdwName = "postgres_fdw",
        Options =
        {
            { "host", "foo" },
            { "dbname", "foodb" },
            { "port", "5432" },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            extPostgresFdw,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		extPostgresFdw, err := postgresql.NewExtension(ctx, "ext_postgres_fdw", &postgresql.ExtensionArgs{
			Name: pulumi.String("postgres_fdw"),
		})
		if err != nil {
			return err
		}
		_, err = postgresql.NewServer(ctx, "myserver_postgres", &postgresql.ServerArgs{
			ServerName: pulumi.String("myserver_postgres"),
			FdwName:    pulumi.String("postgres_fdw"),
			Options: pulumi.StringMap{
				"host":   pulumi.String("foo"),
				"dbname": pulumi.String("foodb"),
				"port":   pulumi.String("5432"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			extPostgresFdw,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    postgresql = {
      source = "pulumi/postgresql"
    }
  }
}

resource "postgresql_extension" "ext_postgres_fdw" {
  name = "postgres_fdw"
}
resource "postgresql_server" "myserver_postgres" {
  depends_on  = [postgresql_extension.ext_postgres_fdw]
  server_name = "myserver_postgres"
  fdw_name    = "postgres_fdw"
  options = {
    "host"   = "foo"
    "dbname" = "foodb"
    "port"   = "5432"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.Extension;
import com.pulumi.postgresql.ExtensionArgs;
import com.pulumi.postgresql.Server;
import com.pulumi.postgresql.ServerArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var extPostgresFdw = new Extension("extPostgresFdw", ExtensionArgs.builder()
            .name("postgres_fdw")
            .build());

        var myserverPostgres = new Server("myserverPostgres", ServerArgs.builder()
            .serverName("myserver_postgres")
            .fdwName("postgres_fdw")
            .options(Map.ofEntries(
                Map.entry("host", "foo"),
                Map.entry("dbname", "foodb"),
                Map.entry("port", "5432")
            ))
            .build(), CustomResourceOptions.builder()
                .dependsOn(extPostgresFdw)
                .build());

    }
}
resources:
  extPostgresFdw:
    type: postgresql:Extension
    name: ext_postgres_fdw
    properties:
      name: postgres_fdw
  myserverPostgres:
    type: postgresql:Server
    name: myserver_postgres
    properties:
      serverName: myserver_postgres
      fdwName: postgres_fdw
      options:
        host: foo
        dbname: foodb
        port: '5432'
    options:
      dependsOn:
        - ${extPostgresFdw}
import * as pulumi from "@pulumi/pulumi";
import * as postgresql from "@pulumi/postgresql";

const extFileFdw = new postgresql.Extension("ext_file_fdw", {name: "file_fdw"});
const myserverFile = new postgresql.Server("myserver_file", {
    serverName: "myserver_file",
    fdwName: "file_fdw",
}, {
    dependsOn: [extFileFdw],
});
import pulumi
import pulumi_postgresql as postgresql

ext_file_fdw = postgresql.Extension("ext_file_fdw", name="file_fdw")
myserver_file = postgresql.Server("myserver_file",
    server_name="myserver_file",
    fdw_name="file_fdw",
    opts = pulumi.ResourceOptions(depends_on=[ext_file_fdw]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;

return await Deployment.RunAsync(() =>
{
    var extFileFdw = new PostgreSql.Extension("ext_file_fdw", new()
    {
        Name = "file_fdw",
    });

    var myserverFile = new PostgreSql.Server("myserver_file", new()
    {
        ServerName = "myserver_file",
        FdwName = "file_fdw",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            extFileFdw,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		extFileFdw, err := postgresql.NewExtension(ctx, "ext_file_fdw", &postgresql.ExtensionArgs{
			Name: pulumi.String("file_fdw"),
		})
		if err != nil {
			return err
		}
		_, err = postgresql.NewServer(ctx, "myserver_file", &postgresql.ServerArgs{
			ServerName: pulumi.String("myserver_file"),
			FdwName:    pulumi.String("file_fdw"),
		}, pulumi.DependsOn([]pulumi.Resource{
			extFileFdw,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    postgresql = {
      source = "pulumi/postgresql"
    }
  }
}

resource "postgresql_extension" "ext_file_fdw" {
  name = "file_fdw"
}
resource "postgresql_server" "myserver_file" {
  depends_on  = [postgresql_extension.ext_file_fdw]
  server_name = "myserver_file"
  fdw_name    = "file_fdw"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.Extension;
import com.pulumi.postgresql.ExtensionArgs;
import com.pulumi.postgresql.Server;
import com.pulumi.postgresql.ServerArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var extFileFdw = new Extension("extFileFdw", ExtensionArgs.builder()
            .name("file_fdw")
            .build());

        var myserverFile = new Server("myserverFile", ServerArgs.builder()
            .serverName("myserver_file")
            .fdwName("file_fdw")
            .build(), CustomResourceOptions.builder()
                .dependsOn(extFileFdw)
                .build());

    }
}
resources:
  extFileFdw:
    type: postgresql:Extension
    name: ext_file_fdw
    properties:
      name: file_fdw
  myserverFile:
    type: postgresql:Server
    name: myserver_file
    properties:
      serverName: myserver_file
      fdwName: file_fdw
    options:
      dependsOn:
        - ${extFileFdw}

Constructors

Server(String name, {ServerArgs? args, CustomResourceOptions? options})
Creates a new Server. name The Pulumi resource name. args Arguments used to configure this Server. The set of arguments for Server. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
dropCascade ↔ Output<bool?>
When true, will drop objects that depend on the server (such as user mappings), and in turn all objects that depend on those objects . (Default: false)
latefinal
fdwName ↔ Output<String>
The name of the foreign-data wrapper that manages the server. Changing this value will force the creation of a new resource as this value can only be set when the foreign server is created.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
options ↔ Output<Map<String, String>?>
This clause specifies the options for the server. The options typically define the connection details of the server, but the actual names and values are dependent on the server's foreign-data wrapper.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverName ↔ Output<String>
The name of the foreign server to be created.
latefinal
serverOwner ↔ Output<String>
By default, the user who defines the server becomes its owner. Set this value to configure the new owner of the foreign server.
latefinal
serverType ↔ Output<String?>
Optional server type, potentially useful to foreign-data wrappers. Changing this value will force the creation of a new resource as this value can only be set when the foreign server is created.
latefinal
serverVersion ↔ Output<String?>
Optional server version, potentially useful to foreign-data wrappers.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ServerState? state}) → Server
Gets an existing Server resource's state with the given name and id.