1. Packages
  2. Linode
  3. API Docs
  4. DatabasePostgresql
Linode v4.21.0 published on Friday, Jun 7, 2024 by Pulumi

linode.DatabasePostgresql

Explore with Pulumi AI

linode logo
Linode v4.21.0 published on Friday, Jun 7, 2024 by Pulumi

    Provides a Linode PostgreSQL Database resource. This can be used to create, modify, and delete Linode PostgreSQL Databases. For more information, see the Linode APIv4 docs.

    Please keep in mind that Managed Databases can take up to an hour to provision.

    Example Usage

    Creating a simple PostgreSQL database instance:

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const foobar = new linode.DatabasePostgresql("foobar", {
        label: "mydatabase",
        engineId: "postgresql/13.2",
        region: "us-southeast",
        type: "g6-nanode-1",
    });
    
    import pulumi
    import pulumi_linode as linode
    
    foobar = linode.DatabasePostgresql("foobar",
        label="mydatabase",
        engine_id="postgresql/13.2",
        region="us-southeast",
        type="g6-nanode-1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := linode.NewDatabasePostgresql(ctx, "foobar", &linode.DatabasePostgresqlArgs{
    			Label:    pulumi.String("mydatabase"),
    			EngineId: pulumi.String("postgresql/13.2"),
    			Region:   pulumi.String("us-southeast"),
    			Type:     pulumi.String("g6-nanode-1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var foobar = new Linode.DatabasePostgresql("foobar", new()
        {
            Label = "mydatabase",
            EngineId = "postgresql/13.2",
            Region = "us-southeast",
            Type = "g6-nanode-1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.DatabasePostgresql;
    import com.pulumi.linode.DatabasePostgresqlArgs;
    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 foobar = new DatabasePostgresql("foobar", DatabasePostgresqlArgs.builder()
                .label("mydatabase")
                .engineId("postgresql/13.2")
                .region("us-southeast")
                .type("g6-nanode-1")
                .build());
    
        }
    }
    
    resources:
      foobar:
        type: linode:DatabasePostgresql
        properties:
          label: mydatabase
          engineId: postgresql/13.2
          region: us-southeast
          type: g6-nanode-1
    

    Creating a complex PostgreSQL database instance:

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const foobar = new linode.DatabasePostgresql("foobar", {
        label: "mydatabase",
        engineId: "postgresql/13.2",
        region: "us-southeast",
        type: "g6-nanode-1",
        allowLists: ["0.0.0.0/0"],
        clusterSize: 3,
        encrypted: true,
        replicationType: "semi_synch",
        replicationCommitType: "remote_write",
        sslConnection: true,
        updates: {
            dayOfWeek: "saturday",
            duration: 1,
            frequency: "monthly",
            hourOfDay: 22,
            weekOfMonth: 2,
        },
    });
    
    import pulumi
    import pulumi_linode as linode
    
    foobar = linode.DatabasePostgresql("foobar",
        label="mydatabase",
        engine_id="postgresql/13.2",
        region="us-southeast",
        type="g6-nanode-1",
        allow_lists=["0.0.0.0/0"],
        cluster_size=3,
        encrypted=True,
        replication_type="semi_synch",
        replication_commit_type="remote_write",
        ssl_connection=True,
        updates=linode.DatabasePostgresqlUpdatesArgs(
            day_of_week="saturday",
            duration=1,
            frequency="monthly",
            hour_of_day=22,
            week_of_month=2,
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := linode.NewDatabasePostgresql(ctx, "foobar", &linode.DatabasePostgresqlArgs{
    			Label:    pulumi.String("mydatabase"),
    			EngineId: pulumi.String("postgresql/13.2"),
    			Region:   pulumi.String("us-southeast"),
    			Type:     pulumi.String("g6-nanode-1"),
    			AllowLists: pulumi.StringArray{
    				pulumi.String("0.0.0.0/0"),
    			},
    			ClusterSize:           pulumi.Int(3),
    			Encrypted:             pulumi.Bool(true),
    			ReplicationType:       pulumi.String("semi_synch"),
    			ReplicationCommitType: pulumi.String("remote_write"),
    			SslConnection:         pulumi.Bool(true),
    			Updates: &linode.DatabasePostgresqlUpdatesArgs{
    				DayOfWeek:   pulumi.String("saturday"),
    				Duration:    pulumi.Int(1),
    				Frequency:   pulumi.String("monthly"),
    				HourOfDay:   pulumi.Int(22),
    				WeekOfMonth: pulumi.Int(2),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var foobar = new Linode.DatabasePostgresql("foobar", new()
        {
            Label = "mydatabase",
            EngineId = "postgresql/13.2",
            Region = "us-southeast",
            Type = "g6-nanode-1",
            AllowLists = new[]
            {
                "0.0.0.0/0",
            },
            ClusterSize = 3,
            Encrypted = true,
            ReplicationType = "semi_synch",
            ReplicationCommitType = "remote_write",
            SslConnection = true,
            Updates = new Linode.Inputs.DatabasePostgresqlUpdatesArgs
            {
                DayOfWeek = "saturday",
                Duration = 1,
                Frequency = "monthly",
                HourOfDay = 22,
                WeekOfMonth = 2,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.DatabasePostgresql;
    import com.pulumi.linode.DatabasePostgresqlArgs;
    import com.pulumi.linode.inputs.DatabasePostgresqlUpdatesArgs;
    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 foobar = new DatabasePostgresql("foobar", DatabasePostgresqlArgs.builder()
                .label("mydatabase")
                .engineId("postgresql/13.2")
                .region("us-southeast")
                .type("g6-nanode-1")
                .allowLists("0.0.0.0/0")
                .clusterSize(3)
                .encrypted(true)
                .replicationType("semi_synch")
                .replicationCommitType("remote_write")
                .sslConnection(true)
                .updates(DatabasePostgresqlUpdatesArgs.builder()
                    .dayOfWeek("saturday")
                    .duration(1)
                    .frequency("monthly")
                    .hourOfDay(22)
                    .weekOfMonth(2)
                    .build())
                .build());
    
        }
    }
    
    resources:
      foobar:
        type: linode:DatabasePostgresql
        properties:
          label: mydatabase
          engineId: postgresql/13.2
          region: us-southeast
          type: g6-nanode-1
          allowLists:
            - 0.0.0.0/0
          clusterSize: 3
          encrypted: true
          replicationType: semi_synch
          replicationCommitType: remote_write
          sslConnection: true
          updates:
            dayOfWeek: saturday
            duration: 1
            frequency: monthly
            hourOfDay: 22
            weekOfMonth: 2
    

    updates

    The following arguments are supported in the updates specification block:

    • day_of_week - (Required) The day to perform maintenance. (monday, tuesday, …)

    • duration - (Required) The maximum maintenance window time in hours. (1..3)

    • frequency - (Required) Whether maintenance occurs on a weekly or monthly basis. (weekly, monthly)

    • hour_of_day - (Required) The hour to begin maintenance based in UTC time. (0..23)

    • week_of_month - (Optional) The week of the month to perform monthly frequency updates. Required for monthly frequency updates. (1..4)

    Create DatabasePostgresql Resource

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

    Constructor syntax

    new DatabasePostgresql(name: string, args: DatabasePostgresqlArgs, opts?: CustomResourceOptions);
    @overload
    def DatabasePostgresql(resource_name: str,
                           args: DatabasePostgresqlArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def DatabasePostgresql(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           engine_id: Optional[str] = None,
                           label: Optional[str] = None,
                           region: Optional[str] = None,
                           type: Optional[str] = None,
                           allow_lists: Optional[Sequence[str]] = None,
                           cluster_size: Optional[int] = None,
                           encrypted: Optional[bool] = None,
                           replication_commit_type: Optional[str] = None,
                           replication_type: Optional[str] = None,
                           ssl_connection: Optional[bool] = None,
                           updates: Optional[DatabasePostgresqlUpdatesArgs] = None)
    func NewDatabasePostgresql(ctx *Context, name string, args DatabasePostgresqlArgs, opts ...ResourceOption) (*DatabasePostgresql, error)
    public DatabasePostgresql(string name, DatabasePostgresqlArgs args, CustomResourceOptions? opts = null)
    public DatabasePostgresql(String name, DatabasePostgresqlArgs args)
    public DatabasePostgresql(String name, DatabasePostgresqlArgs args, CustomResourceOptions options)
    
    type: linode:DatabasePostgresql
    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 DatabasePostgresqlArgs
    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 DatabasePostgresqlArgs
    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 DatabasePostgresqlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabasePostgresqlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabasePostgresqlArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var databasePostgresqlResource = new Linode.DatabasePostgresql("databasePostgresqlResource", new()
    {
        EngineId = "string",
        Label = "string",
        Region = "string",
        Type = "string",
        AllowLists = new[]
        {
            "string",
        },
        ClusterSize = 0,
        Encrypted = false,
        ReplicationCommitType = "string",
        ReplicationType = "string",
        SslConnection = false,
        Updates = new Linode.Inputs.DatabasePostgresqlUpdatesArgs
        {
            DayOfWeek = "string",
            Duration = 0,
            Frequency = "string",
            HourOfDay = 0,
            WeekOfMonth = 0,
        },
    });
    
    example, err := linode.NewDatabasePostgresql(ctx, "databasePostgresqlResource", &linode.DatabasePostgresqlArgs{
    	EngineId: pulumi.String("string"),
    	Label:    pulumi.String("string"),
    	Region:   pulumi.String("string"),
    	Type:     pulumi.String("string"),
    	AllowLists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ClusterSize:           pulumi.Int(0),
    	Encrypted:             pulumi.Bool(false),
    	ReplicationCommitType: pulumi.String("string"),
    	ReplicationType:       pulumi.String("string"),
    	SslConnection:         pulumi.Bool(false),
    	Updates: &linode.DatabasePostgresqlUpdatesArgs{
    		DayOfWeek:   pulumi.String("string"),
    		Duration:    pulumi.Int(0),
    		Frequency:   pulumi.String("string"),
    		HourOfDay:   pulumi.Int(0),
    		WeekOfMonth: pulumi.Int(0),
    	},
    })
    
    var databasePostgresqlResource = new DatabasePostgresql("databasePostgresqlResource", DatabasePostgresqlArgs.builder()
        .engineId("string")
        .label("string")
        .region("string")
        .type("string")
        .allowLists("string")
        .clusterSize(0)
        .encrypted(false)
        .replicationCommitType("string")
        .replicationType("string")
        .sslConnection(false)
        .updates(DatabasePostgresqlUpdatesArgs.builder()
            .dayOfWeek("string")
            .duration(0)
            .frequency("string")
            .hourOfDay(0)
            .weekOfMonth(0)
            .build())
        .build());
    
    database_postgresql_resource = linode.DatabasePostgresql("databasePostgresqlResource",
        engine_id="string",
        label="string",
        region="string",
        type="string",
        allow_lists=["string"],
        cluster_size=0,
        encrypted=False,
        replication_commit_type="string",
        replication_type="string",
        ssl_connection=False,
        updates=linode.DatabasePostgresqlUpdatesArgs(
            day_of_week="string",
            duration=0,
            frequency="string",
            hour_of_day=0,
            week_of_month=0,
        ))
    
    const databasePostgresqlResource = new linode.DatabasePostgresql("databasePostgresqlResource", {
        engineId: "string",
        label: "string",
        region: "string",
        type: "string",
        allowLists: ["string"],
        clusterSize: 0,
        encrypted: false,
        replicationCommitType: "string",
        replicationType: "string",
        sslConnection: false,
        updates: {
            dayOfWeek: "string",
            duration: 0,
            frequency: "string",
            hourOfDay: 0,
            weekOfMonth: 0,
        },
    });
    
    type: linode:DatabasePostgresql
    properties:
        allowLists:
            - string
        clusterSize: 0
        encrypted: false
        engineId: string
        label: string
        region: string
        replicationCommitType: string
        replicationType: string
        sslConnection: false
        type: string
        updates:
            dayOfWeek: string
            duration: 0
            frequency: string
            hourOfDay: 0
            weekOfMonth: 0
    

    DatabasePostgresql Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DatabasePostgresql resource accepts the following input properties:

    EngineId string
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    Label string
    A unique, user-defined string referring to the Managed Database.
    Region string
    The region to use for the Managed Database.
    Type string
    The Linode Instance type used for the nodes of the Managed Database instance.


    AllowLists List<string>
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    ClusterSize int
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    Encrypted bool
    Whether the Managed Databases is encrypted. (default false)
    ReplicationCommitType string

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    ReplicationType string

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    SslConnection bool
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    Updates DatabasePostgresqlUpdates
    Configuration settings for automated patch update maintenance for the Managed Database.
    EngineId string
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    Label string
    A unique, user-defined string referring to the Managed Database.
    Region string
    The region to use for the Managed Database.
    Type string
    The Linode Instance type used for the nodes of the Managed Database instance.


    AllowLists []string
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    ClusterSize int
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    Encrypted bool
    Whether the Managed Databases is encrypted. (default false)
    ReplicationCommitType string

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    ReplicationType string

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    SslConnection bool
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    Updates DatabasePostgresqlUpdatesArgs
    Configuration settings for automated patch update maintenance for the Managed Database.
    engineId String
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    label String
    A unique, user-defined string referring to the Managed Database.
    region String
    The region to use for the Managed Database.
    type String
    The Linode Instance type used for the nodes of the Managed Database instance.


    allowLists List<String>
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    clusterSize Integer
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    encrypted Boolean
    Whether the Managed Databases is encrypted. (default false)
    replicationCommitType String

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    replicationType String

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    sslConnection Boolean
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    updates DatabasePostgresqlUpdates
    Configuration settings for automated patch update maintenance for the Managed Database.
    engineId string
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    label string
    A unique, user-defined string referring to the Managed Database.
    region string
    The region to use for the Managed Database.
    type string
    The Linode Instance type used for the nodes of the Managed Database instance.


    allowLists string[]
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    clusterSize number
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    encrypted boolean
    Whether the Managed Databases is encrypted. (default false)
    replicationCommitType string

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    replicationType string

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    sslConnection boolean
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    updates DatabasePostgresqlUpdates
    Configuration settings for automated patch update maintenance for the Managed Database.
    engine_id str
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    label str
    A unique, user-defined string referring to the Managed Database.
    region str
    The region to use for the Managed Database.
    type str
    The Linode Instance type used for the nodes of the Managed Database instance.


    allow_lists Sequence[str]
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    cluster_size int
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    encrypted bool
    Whether the Managed Databases is encrypted. (default false)
    replication_commit_type str

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    replication_type str

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    ssl_connection bool
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    updates DatabasePostgresqlUpdatesArgs
    Configuration settings for automated patch update maintenance for the Managed Database.
    engineId String
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    label String
    A unique, user-defined string referring to the Managed Database.
    region String
    The region to use for the Managed Database.
    type String
    The Linode Instance type used for the nodes of the Managed Database instance.


    allowLists List<String>
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    clusterSize Number
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    encrypted Boolean
    Whether the Managed Databases is encrypted. (default false)
    replicationCommitType String

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    replicationType String

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    sslConnection Boolean
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    updates Property Map
    Configuration settings for automated patch update maintenance for the Managed Database.

    Outputs

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

    CaCert string
    The base64-encoded SSL CA certificate for the Managed Database instance.
    Created string
    When this Managed Database was created.
    Engine string
    The Managed Database engine. (e.g. postgresql)
    HostPrimary string
    The primary host for the Managed Database.
    HostSecondary string
    The secondary/private network host for the Managed Database.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port int
    The access port for this Managed Database.
    RootPassword string
    The randomly-generated root password for the Managed Database instance.
    RootUsername string
    The root username for the Managed Database instance.
    Status string
    The operating status of the Managed Database.
    Updated string
    When this Managed Database was last updated.
    Version string
    The Managed Database engine version. (e.g. 13.2)
    CaCert string
    The base64-encoded SSL CA certificate for the Managed Database instance.
    Created string
    When this Managed Database was created.
    Engine string
    The Managed Database engine. (e.g. postgresql)
    HostPrimary string
    The primary host for the Managed Database.
    HostSecondary string
    The secondary/private network host for the Managed Database.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port int
    The access port for this Managed Database.
    RootPassword string
    The randomly-generated root password for the Managed Database instance.
    RootUsername string
    The root username for the Managed Database instance.
    Status string
    The operating status of the Managed Database.
    Updated string
    When this Managed Database was last updated.
    Version string
    The Managed Database engine version. (e.g. 13.2)
    caCert String
    The base64-encoded SSL CA certificate for the Managed Database instance.
    created String
    When this Managed Database was created.
    engine String
    The Managed Database engine. (e.g. postgresql)
    hostPrimary String
    The primary host for the Managed Database.
    hostSecondary String
    The secondary/private network host for the Managed Database.
    id String
    The provider-assigned unique ID for this managed resource.
    port Integer
    The access port for this Managed Database.
    rootPassword String
    The randomly-generated root password for the Managed Database instance.
    rootUsername String
    The root username for the Managed Database instance.
    status String
    The operating status of the Managed Database.
    updated String
    When this Managed Database was last updated.
    version String
    The Managed Database engine version. (e.g. 13.2)
    caCert string
    The base64-encoded SSL CA certificate for the Managed Database instance.
    created string
    When this Managed Database was created.
    engine string
    The Managed Database engine. (e.g. postgresql)
    hostPrimary string
    The primary host for the Managed Database.
    hostSecondary string
    The secondary/private network host for the Managed Database.
    id string
    The provider-assigned unique ID for this managed resource.
    port number
    The access port for this Managed Database.
    rootPassword string
    The randomly-generated root password for the Managed Database instance.
    rootUsername string
    The root username for the Managed Database instance.
    status string
    The operating status of the Managed Database.
    updated string
    When this Managed Database was last updated.
    version string
    The Managed Database engine version. (e.g. 13.2)
    ca_cert str
    The base64-encoded SSL CA certificate for the Managed Database instance.
    created str
    When this Managed Database was created.
    engine str
    The Managed Database engine. (e.g. postgresql)
    host_primary str
    The primary host for the Managed Database.
    host_secondary str
    The secondary/private network host for the Managed Database.
    id str
    The provider-assigned unique ID for this managed resource.
    port int
    The access port for this Managed Database.
    root_password str
    The randomly-generated root password for the Managed Database instance.
    root_username str
    The root username for the Managed Database instance.
    status str
    The operating status of the Managed Database.
    updated str
    When this Managed Database was last updated.
    version str
    The Managed Database engine version. (e.g. 13.2)
    caCert String
    The base64-encoded SSL CA certificate for the Managed Database instance.
    created String
    When this Managed Database was created.
    engine String
    The Managed Database engine. (e.g. postgresql)
    hostPrimary String
    The primary host for the Managed Database.
    hostSecondary String
    The secondary/private network host for the Managed Database.
    id String
    The provider-assigned unique ID for this managed resource.
    port Number
    The access port for this Managed Database.
    rootPassword String
    The randomly-generated root password for the Managed Database instance.
    rootUsername String
    The root username for the Managed Database instance.
    status String
    The operating status of the Managed Database.
    updated String
    When this Managed Database was last updated.
    version String
    The Managed Database engine version. (e.g. 13.2)

    Look up Existing DatabasePostgresql Resource

    Get an existing DatabasePostgresql 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?: DatabasePostgresqlState, opts?: CustomResourceOptions): DatabasePostgresql
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_lists: Optional[Sequence[str]] = None,
            ca_cert: Optional[str] = None,
            cluster_size: Optional[int] = None,
            created: Optional[str] = None,
            encrypted: Optional[bool] = None,
            engine: Optional[str] = None,
            engine_id: Optional[str] = None,
            host_primary: Optional[str] = None,
            host_secondary: Optional[str] = None,
            label: Optional[str] = None,
            port: Optional[int] = None,
            region: Optional[str] = None,
            replication_commit_type: Optional[str] = None,
            replication_type: Optional[str] = None,
            root_password: Optional[str] = None,
            root_username: Optional[str] = None,
            ssl_connection: Optional[bool] = None,
            status: Optional[str] = None,
            type: Optional[str] = None,
            updated: Optional[str] = None,
            updates: Optional[DatabasePostgresqlUpdatesArgs] = None,
            version: Optional[str] = None) -> DatabasePostgresql
    func GetDatabasePostgresql(ctx *Context, name string, id IDInput, state *DatabasePostgresqlState, opts ...ResourceOption) (*DatabasePostgresql, error)
    public static DatabasePostgresql Get(string name, Input<string> id, DatabasePostgresqlState? state, CustomResourceOptions? opts = null)
    public static DatabasePostgresql get(String name, Output<String> id, DatabasePostgresqlState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AllowLists List<string>
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    CaCert string
    The base64-encoded SSL CA certificate for the Managed Database instance.
    ClusterSize int
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    Created string
    When this Managed Database was created.
    Encrypted bool
    Whether the Managed Databases is encrypted. (default false)
    Engine string
    The Managed Database engine. (e.g. postgresql)
    EngineId string
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    HostPrimary string
    The primary host for the Managed Database.
    HostSecondary string
    The secondary/private network host for the Managed Database.
    Label string
    A unique, user-defined string referring to the Managed Database.
    Port int
    The access port for this Managed Database.
    Region string
    The region to use for the Managed Database.
    ReplicationCommitType string

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    ReplicationType string

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    RootPassword string
    The randomly-generated root password for the Managed Database instance.
    RootUsername string
    The root username for the Managed Database instance.
    SslConnection bool
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    Status string
    The operating status of the Managed Database.
    Type string
    The Linode Instance type used for the nodes of the Managed Database instance.


    Updated string
    When this Managed Database was last updated.
    Updates DatabasePostgresqlUpdates
    Configuration settings for automated patch update maintenance for the Managed Database.
    Version string
    The Managed Database engine version. (e.g. 13.2)
    AllowLists []string
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    CaCert string
    The base64-encoded SSL CA certificate for the Managed Database instance.
    ClusterSize int
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    Created string
    When this Managed Database was created.
    Encrypted bool
    Whether the Managed Databases is encrypted. (default false)
    Engine string
    The Managed Database engine. (e.g. postgresql)
    EngineId string
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    HostPrimary string
    The primary host for the Managed Database.
    HostSecondary string
    The secondary/private network host for the Managed Database.
    Label string
    A unique, user-defined string referring to the Managed Database.
    Port int
    The access port for this Managed Database.
    Region string
    The region to use for the Managed Database.
    ReplicationCommitType string

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    ReplicationType string

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    RootPassword string
    The randomly-generated root password for the Managed Database instance.
    RootUsername string
    The root username for the Managed Database instance.
    SslConnection bool
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    Status string
    The operating status of the Managed Database.
    Type string
    The Linode Instance type used for the nodes of the Managed Database instance.


    Updated string
    When this Managed Database was last updated.
    Updates DatabasePostgresqlUpdatesArgs
    Configuration settings for automated patch update maintenance for the Managed Database.
    Version string
    The Managed Database engine version. (e.g. 13.2)
    allowLists List<String>
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    caCert String
    The base64-encoded SSL CA certificate for the Managed Database instance.
    clusterSize Integer
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    created String
    When this Managed Database was created.
    encrypted Boolean
    Whether the Managed Databases is encrypted. (default false)
    engine String
    The Managed Database engine. (e.g. postgresql)
    engineId String
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    hostPrimary String
    The primary host for the Managed Database.
    hostSecondary String
    The secondary/private network host for the Managed Database.
    label String
    A unique, user-defined string referring to the Managed Database.
    port Integer
    The access port for this Managed Database.
    region String
    The region to use for the Managed Database.
    replicationCommitType String

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    replicationType String

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    rootPassword String
    The randomly-generated root password for the Managed Database instance.
    rootUsername String
    The root username for the Managed Database instance.
    sslConnection Boolean
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    status String
    The operating status of the Managed Database.
    type String
    The Linode Instance type used for the nodes of the Managed Database instance.


    updated String
    When this Managed Database was last updated.
    updates DatabasePostgresqlUpdates
    Configuration settings for automated patch update maintenance for the Managed Database.
    version String
    The Managed Database engine version. (e.g. 13.2)
    allowLists string[]
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    caCert string
    The base64-encoded SSL CA certificate for the Managed Database instance.
    clusterSize number
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    created string
    When this Managed Database was created.
    encrypted boolean
    Whether the Managed Databases is encrypted. (default false)
    engine string
    The Managed Database engine. (e.g. postgresql)
    engineId string
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    hostPrimary string
    The primary host for the Managed Database.
    hostSecondary string
    The secondary/private network host for the Managed Database.
    label string
    A unique, user-defined string referring to the Managed Database.
    port number
    The access port for this Managed Database.
    region string
    The region to use for the Managed Database.
    replicationCommitType string

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    replicationType string

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    rootPassword string
    The randomly-generated root password for the Managed Database instance.
    rootUsername string
    The root username for the Managed Database instance.
    sslConnection boolean
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    status string
    The operating status of the Managed Database.
    type string
    The Linode Instance type used for the nodes of the Managed Database instance.


    updated string
    When this Managed Database was last updated.
    updates DatabasePostgresqlUpdates
    Configuration settings for automated patch update maintenance for the Managed Database.
    version string
    The Managed Database engine version. (e.g. 13.2)
    allow_lists Sequence[str]
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    ca_cert str
    The base64-encoded SSL CA certificate for the Managed Database instance.
    cluster_size int
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    created str
    When this Managed Database was created.
    encrypted bool
    Whether the Managed Databases is encrypted. (default false)
    engine str
    The Managed Database engine. (e.g. postgresql)
    engine_id str
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    host_primary str
    The primary host for the Managed Database.
    host_secondary str
    The secondary/private network host for the Managed Database.
    label str
    A unique, user-defined string referring to the Managed Database.
    port int
    The access port for this Managed Database.
    region str
    The region to use for the Managed Database.
    replication_commit_type str

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    replication_type str

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    root_password str
    The randomly-generated root password for the Managed Database instance.
    root_username str
    The root username for the Managed Database instance.
    ssl_connection bool
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    status str
    The operating status of the Managed Database.
    type str
    The Linode Instance type used for the nodes of the Managed Database instance.


    updated str
    When this Managed Database was last updated.
    updates DatabasePostgresqlUpdatesArgs
    Configuration settings for automated patch update maintenance for the Managed Database.
    version str
    The Managed Database engine version. (e.g. 13.2)
    allowLists List<String>
    A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use linode.DatabaseAccessControls to manage your allow list separately.
    caCert String
    The base64-encoded SSL CA certificate for the Managed Database instance.
    clusterSize Number
    The number of Linode Instance nodes deployed to the Managed Database. (default 1)
    created String
    When this Managed Database was created.
    encrypted Boolean
    Whether the Managed Databases is encrypted. (default false)
    engine String
    The Managed Database engine. (e.g. postgresql)
    engineId String
    The Managed Database engine in engine/version format. (e.g. postgresql/13.2)
    hostPrimary String
    The primary host for the Managed Database.
    hostSecondary String
    The secondary/private network host for the Managed Database.
    label String
    A unique, user-defined string referring to the Managed Database.
    port Number
    The access port for this Managed Database.
    region String
    The region to use for the Managed Database.
    replicationCommitType String

    The synchronization level of the replicating server. (on, local, remote_write, remote_apply, off; default off)

    • Must be local or off for the asynch replication type.

    • Must be on, remote_write, or remote_apply for the semi_synch replication type.

    replicationType String

    The replication method used for the Managed Database. (none, asynch, semi_synch; default none)

    • Must be none for a single node cluster.

    • Must be asynch or semi_synch for a high availability cluster.

    rootPassword String
    The randomly-generated root password for the Managed Database instance.
    rootUsername String
    The root username for the Managed Database instance.
    sslConnection Boolean
    Whether to require SSL credentials to establish a connection to the Managed Database. (default false)

    • updates - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
    status String
    The operating status of the Managed Database.
    type String
    The Linode Instance type used for the nodes of the Managed Database instance.


    updated String
    When this Managed Database was last updated.
    updates Property Map
    Configuration settings for automated patch update maintenance for the Managed Database.
    version String
    The Managed Database engine version. (e.g. 13.2)

    Supporting Types

    DatabasePostgresqlUpdates, DatabasePostgresqlUpdatesArgs

    DayOfWeek string
    The day to perform maintenance.
    Duration int
    The maximum maintenance window time in hours.
    Frequency string
    Whether maintenance occurs on a weekly or monthly basis.
    HourOfDay int
    The hour to begin maintenance based in UTC time.
    WeekOfMonth int
    The week of the month to perform monthly frequency updates. Required for monthly frequency updates.
    DayOfWeek string
    The day to perform maintenance.
    Duration int
    The maximum maintenance window time in hours.
    Frequency string
    Whether maintenance occurs on a weekly or monthly basis.
    HourOfDay int
    The hour to begin maintenance based in UTC time.
    WeekOfMonth int
    The week of the month to perform monthly frequency updates. Required for monthly frequency updates.
    dayOfWeek String
    The day to perform maintenance.
    duration Integer
    The maximum maintenance window time in hours.
    frequency String
    Whether maintenance occurs on a weekly or monthly basis.
    hourOfDay Integer
    The hour to begin maintenance based in UTC time.
    weekOfMonth Integer
    The week of the month to perform monthly frequency updates. Required for monthly frequency updates.
    dayOfWeek string
    The day to perform maintenance.
    duration number
    The maximum maintenance window time in hours.
    frequency string
    Whether maintenance occurs on a weekly or monthly basis.
    hourOfDay number
    The hour to begin maintenance based in UTC time.
    weekOfMonth number
    The week of the month to perform monthly frequency updates. Required for monthly frequency updates.
    day_of_week str
    The day to perform maintenance.
    duration int
    The maximum maintenance window time in hours.
    frequency str
    Whether maintenance occurs on a weekly or monthly basis.
    hour_of_day int
    The hour to begin maintenance based in UTC time.
    week_of_month int
    The week of the month to perform monthly frequency updates. Required for monthly frequency updates.
    dayOfWeek String
    The day to perform maintenance.
    duration Number
    The maximum maintenance window time in hours.
    frequency String
    Whether maintenance occurs on a weekly or monthly basis.
    hourOfDay Number
    The hour to begin maintenance based in UTC time.
    weekOfMonth Number
    The week of the month to perform monthly frequency updates. Required for monthly frequency updates.

    Import

    Linode PostgreSQL Databases can be imported using the id, e.g.

    $ pulumi import linode:index/databasePostgresql:DatabasePostgresql foobar 1234567
    

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

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.21.0 published on Friday, Jun 7, 2024 by Pulumi