1. Packages
  2. Scaleway
  3. API Docs
  4. DatabaseInstance
Scaleway v1.12.0 published on Monday, Mar 11, 2024 by pulumiverse

scaleway.DatabaseInstance

Explore with Pulumi AI

scaleway logo
Scaleway v1.12.0 published on Monday, Mar 11, 2024 by pulumiverse

    Creates and manages Scaleway Database Instances. For more information, see the documentation.

    Example Usage

    Example Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.DatabaseInstance("main", {
        disableBackup: true,
        engine: "PostgreSQL-11",
        isHaCluster: true,
        nodeType: "DB-DEV-S",
        password: "thiZ_is_v&ry_s3cret",
        userName: "my_initial_user",
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.DatabaseInstance("main",
        disable_backup=True,
        engine="PostgreSQL-11",
        is_ha_cluster=True,
        node_type="DB-DEV-S",
        password="thiZ_is_v&ry_s3cret",
        user_name="my_initial_user")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.NewDatabaseInstance(ctx, "main", &scaleway.DatabaseInstanceArgs{
    			DisableBackup: pulumi.Bool(true),
    			Engine:        pulumi.String("PostgreSQL-11"),
    			IsHaCluster:   pulumi.Bool(true),
    			NodeType:      pulumi.String("DB-DEV-S"),
    			Password:      pulumi.String("thiZ_is_v&ry_s3cret"),
    			UserName:      pulumi.String("my_initial_user"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var main = new Scaleway.DatabaseInstance("main", new()
        {
            DisableBackup = true,
            Engine = "PostgreSQL-11",
            IsHaCluster = true,
            NodeType = "DB-DEV-S",
            Password = "thiZ_is_v&ry_s3cret",
            UserName = "my_initial_user",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.DatabaseInstance;
    import com.pulumi.scaleway.DatabaseInstanceArgs;
    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 main = new DatabaseInstance("main", DatabaseInstanceArgs.builder()        
                .disableBackup(true)
                .engine("PostgreSQL-11")
                .isHaCluster(true)
                .nodeType("DB-DEV-S")
                .password("thiZ_is_v&ry_s3cret")
                .userName("my_initial_user")
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:DatabaseInstance
        properties:
          disableBackup: true
          engine: PostgreSQL-11
          isHaCluster: true
          nodeType: DB-DEV-S
          password: thiZ_is_v&ry_s3cret
          userName: my_initial_user
    

    Example with Settings

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.DatabaseInstance("main", {
        disableBackup: true,
        engine: "MySQL-8",
        initSettings: {
            lower_case_table_names: "1",
        },
        nodeType: "db-dev-s",
        password: "thiZ_is_v&ry_s3cret",
        settings: {
            max_connections: "350",
        },
        userName: "my_initial_user",
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.DatabaseInstance("main",
        disable_backup=True,
        engine="MySQL-8",
        init_settings={
            "lower_case_table_names": "1",
        },
        node_type="db-dev-s",
        password="thiZ_is_v&ry_s3cret",
        settings={
            "max_connections": "350",
        },
        user_name="my_initial_user")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.NewDatabaseInstance(ctx, "main", &scaleway.DatabaseInstanceArgs{
    			DisableBackup: pulumi.Bool(true),
    			Engine:        pulumi.String("MySQL-8"),
    			InitSettings: pulumi.StringMap{
    				"lower_case_table_names": pulumi.String("1"),
    			},
    			NodeType: pulumi.String("db-dev-s"),
    			Password: pulumi.String("thiZ_is_v&ry_s3cret"),
    			Settings: pulumi.StringMap{
    				"max_connections": pulumi.String("350"),
    			},
    			UserName: pulumi.String("my_initial_user"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var main = new Scaleway.DatabaseInstance("main", new()
        {
            DisableBackup = true,
            Engine = "MySQL-8",
            InitSettings = 
            {
                { "lower_case_table_names", "1" },
            },
            NodeType = "db-dev-s",
            Password = "thiZ_is_v&ry_s3cret",
            Settings = 
            {
                { "max_connections", "350" },
            },
            UserName = "my_initial_user",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.DatabaseInstance;
    import com.pulumi.scaleway.DatabaseInstanceArgs;
    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 main = new DatabaseInstance("main", DatabaseInstanceArgs.builder()        
                .disableBackup(true)
                .engine("MySQL-8")
                .initSettings(Map.of("lower_case_table_names", 1))
                .nodeType("db-dev-s")
                .password("thiZ_is_v&ry_s3cret")
                .settings(Map.of("max_connections", "350"))
                .userName("my_initial_user")
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:DatabaseInstance
        properties:
          disableBackup: true
          engine: MySQL-8
          initSettings:
            lower_case_table_names: 1
          nodeType: db-dev-s
          password: thiZ_is_v&ry_s3cret
          settings:
            max_connections: '350'
          userName: my_initial_user
    

    Example with backup schedule

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.DatabaseInstance("main", {
        backupScheduleFrequency: 24,
        backupScheduleRetention: 7,
        disableBackup: false,
        engine: "PostgreSQL-11",
        isHaCluster: true,
        nodeType: "DB-DEV-S",
        password: "thiZ_is_v&ry_s3cret",
        userName: "my_initial_user",
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.DatabaseInstance("main",
        backup_schedule_frequency=24,
        backup_schedule_retention=7,
        disable_backup=False,
        engine="PostgreSQL-11",
        is_ha_cluster=True,
        node_type="DB-DEV-S",
        password="thiZ_is_v&ry_s3cret",
        user_name="my_initial_user")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.NewDatabaseInstance(ctx, "main", &scaleway.DatabaseInstanceArgs{
    			BackupScheduleFrequency: pulumi.Int(24),
    			BackupScheduleRetention: pulumi.Int(7),
    			DisableBackup:           pulumi.Bool(false),
    			Engine:                  pulumi.String("PostgreSQL-11"),
    			IsHaCluster:             pulumi.Bool(true),
    			NodeType:                pulumi.String("DB-DEV-S"),
    			Password:                pulumi.String("thiZ_is_v&ry_s3cret"),
    			UserName:                pulumi.String("my_initial_user"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var main = new Scaleway.DatabaseInstance("main", new()
        {
            BackupScheduleFrequency = 24,
            BackupScheduleRetention = 7,
            DisableBackup = false,
            Engine = "PostgreSQL-11",
            IsHaCluster = true,
            NodeType = "DB-DEV-S",
            Password = "thiZ_is_v&ry_s3cret",
            UserName = "my_initial_user",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.DatabaseInstance;
    import com.pulumi.scaleway.DatabaseInstanceArgs;
    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 main = new DatabaseInstance("main", DatabaseInstanceArgs.builder()        
                .backupScheduleFrequency(24)
                .backupScheduleRetention(7)
                .disableBackup(false)
                .engine("PostgreSQL-11")
                .isHaCluster(true)
                .nodeType("DB-DEV-S")
                .password("thiZ_is_v&ry_s3cret")
                .userName("my_initial_user")
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:DatabaseInstance
        properties:
          backupScheduleFrequency: 24
          # every day
          backupScheduleRetention: 7
          # keep it one week
          disableBackup: false
          engine: PostgreSQL-11
          isHaCluster: true
          nodeType: DB-DEV-S
          password: thiZ_is_v&ry_s3cret
          userName: my_initial_user
    

    Examples of endpoints configuration

    RDB Instances can have a maximum of 1 public endpoint and 1 private endpoint. It can have both, or none.

    1 static private network endpoint

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const pn = new scaleway.VpcPrivateNetwork("pn", {ipv4Subnet: {
        subnet: "172.16.20.0/22",
    }});
    const main = new scaleway.DatabaseInstance("main", {
        nodeType: "db-dev-s",
        engine: "PostgreSQL-11",
        privateNetwork: {
            pnId: pn.id,
            ipNet: "172.16.20.4/22",
        },
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    pn = scaleway.VpcPrivateNetwork("pn", ipv4_subnet=scaleway.VpcPrivateNetworkIpv4SubnetArgs(
        subnet="172.16.20.0/22",
    ))
    main = scaleway.DatabaseInstance("main",
        node_type="db-dev-s",
        engine="PostgreSQL-11",
        private_network=scaleway.DatabaseInstancePrivateNetworkArgs(
            pn_id=pn.id,
            ip_net="172.16.20.4/22",
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		pn, err := scaleway.NewVpcPrivateNetwork(ctx, "pn", &scaleway.VpcPrivateNetworkArgs{
    			Ipv4Subnet: &scaleway.VpcPrivateNetworkIpv4SubnetArgs{
    				Subnet: pulumi.String("172.16.20.0/22"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = scaleway.NewDatabaseInstance(ctx, "main", &scaleway.DatabaseInstanceArgs{
    			NodeType: pulumi.String("db-dev-s"),
    			Engine:   pulumi.String("PostgreSQL-11"),
    			PrivateNetwork: &scaleway.DatabaseInstancePrivateNetworkArgs{
    				PnId:  pn.ID(),
    				IpNet: pulumi.String("172.16.20.4/22"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var pn = new Scaleway.VpcPrivateNetwork("pn", new()
        {
            Ipv4Subnet = new Scaleway.Inputs.VpcPrivateNetworkIpv4SubnetArgs
            {
                Subnet = "172.16.20.0/22",
            },
        });
    
        var main = new Scaleway.DatabaseInstance("main", new()
        {
            NodeType = "db-dev-s",
            Engine = "PostgreSQL-11",
            PrivateNetwork = new Scaleway.Inputs.DatabaseInstancePrivateNetworkArgs
            {
                PnId = pn.Id,
                IpNet = "172.16.20.4/22",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.VpcPrivateNetwork;
    import com.pulumi.scaleway.VpcPrivateNetworkArgs;
    import com.pulumi.scaleway.inputs.VpcPrivateNetworkIpv4SubnetArgs;
    import com.pulumi.scaleway.DatabaseInstance;
    import com.pulumi.scaleway.DatabaseInstanceArgs;
    import com.pulumi.scaleway.inputs.DatabaseInstancePrivateNetworkArgs;
    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 pn = new VpcPrivateNetwork("pn", VpcPrivateNetworkArgs.builder()        
                .ipv4Subnet(VpcPrivateNetworkIpv4SubnetArgs.builder()
                    .subnet("172.16.20.0/22")
                    .build())
                .build());
    
            var main = new DatabaseInstance("main", DatabaseInstanceArgs.builder()        
                .nodeType("db-dev-s")
                .engine("PostgreSQL-11")
                .privateNetwork(DatabaseInstancePrivateNetworkArgs.builder()
                    .pnId(pn.id())
                    .ipNet("172.16.20.4/22")
                    .build())
                .build());
    
        }
    }
    
    resources:
      pn:
        type: scaleway:VpcPrivateNetwork
        properties:
          ipv4Subnet:
            subnet: 172.16.20.0/22
      main:
        type: scaleway:DatabaseInstance
        properties:
          nodeType: db-dev-s
          engine: PostgreSQL-11
          privateNetwork:
            pnId: ${pn.id}
            ipNet: 172.16.20.4/22
    

    1 IPAM private network endpoint + 1 public endpoint

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const pn = new scaleway.VpcPrivateNetwork("pn", {});
    const main = new scaleway.DatabaseInstance("main", {
        nodeType: "DB-DEV-S",
        engine: "PostgreSQL-11",
        privateNetwork: {
            pnId: pn.id,
            enableIpam: true,
        },
        loadBalancers: [{}],
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    pn = scaleway.VpcPrivateNetwork("pn")
    main = scaleway.DatabaseInstance("main",
        node_type="DB-DEV-S",
        engine="PostgreSQL-11",
        private_network=scaleway.DatabaseInstancePrivateNetworkArgs(
            pn_id=pn.id,
            enable_ipam=True,
        ),
        load_balancers=[scaleway.DatabaseInstanceLoadBalancerArgs()])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		pn, err := scaleway.NewVpcPrivateNetwork(ctx, "pn", nil)
    		if err != nil {
    			return err
    		}
    		_, err = scaleway.NewDatabaseInstance(ctx, "main", &scaleway.DatabaseInstanceArgs{
    			NodeType: pulumi.String("DB-DEV-S"),
    			Engine:   pulumi.String("PostgreSQL-11"),
    			PrivateNetwork: &scaleway.DatabaseInstancePrivateNetworkArgs{
    				PnId:       pn.ID(),
    				EnableIpam: pulumi.Bool(true),
    			},
    			LoadBalancers: scaleway.DatabaseInstanceLoadBalancerArray{
    				nil,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var pn = new Scaleway.VpcPrivateNetwork("pn");
    
        var main = new Scaleway.DatabaseInstance("main", new()
        {
            NodeType = "DB-DEV-S",
            Engine = "PostgreSQL-11",
            PrivateNetwork = new Scaleway.Inputs.DatabaseInstancePrivateNetworkArgs
            {
                PnId = pn.Id,
                EnableIpam = true,
            },
            LoadBalancers = new[]
            {
                null,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.VpcPrivateNetwork;
    import com.pulumi.scaleway.DatabaseInstance;
    import com.pulumi.scaleway.DatabaseInstanceArgs;
    import com.pulumi.scaleway.inputs.DatabaseInstancePrivateNetworkArgs;
    import com.pulumi.scaleway.inputs.DatabaseInstanceLoadBalancerArgs;
    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 pn = new VpcPrivateNetwork("pn");
    
            var main = new DatabaseInstance("main", DatabaseInstanceArgs.builder()        
                .nodeType("DB-DEV-S")
                .engine("PostgreSQL-11")
                .privateNetwork(DatabaseInstancePrivateNetworkArgs.builder()
                    .pnId(pn.id())
                    .enableIpam(true)
                    .build())
                .loadBalancers()
                .build());
    
        }
    }
    
    resources:
      pn:
        type: scaleway:VpcPrivateNetwork
      main:
        type: scaleway:DatabaseInstance
        properties:
          nodeType: DB-DEV-S
          engine: PostgreSQL-11
          privateNetwork:
            pnId: ${pn.id}
            enableIpam: true
          loadBalancers:
            - {}
    

    Default: 1 public endpoint

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.DatabaseInstance("main", {
        engine: "PostgreSQL-11",
        nodeType: "db-dev-s",
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.DatabaseInstance("main",
        engine="PostgreSQL-11",
        node_type="db-dev-s")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.NewDatabaseInstance(ctx, "main", &scaleway.DatabaseInstanceArgs{
    			Engine:   pulumi.String("PostgreSQL-11"),
    			NodeType: pulumi.String("db-dev-s"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var main = new Scaleway.DatabaseInstance("main", new()
        {
            Engine = "PostgreSQL-11",
            NodeType = "db-dev-s",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.DatabaseInstance;
    import com.pulumi.scaleway.DatabaseInstanceArgs;
    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 main = new DatabaseInstance("main", DatabaseInstanceArgs.builder()        
                .engine("PostgreSQL-11")
                .nodeType("db-dev-s")
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:DatabaseInstance
        properties:
          engine: PostgreSQL-11
          nodeType: db-dev-s
    

    If nothing is defined, your instance will have a default public load-balancer endpoint

    Limitations

    The Managed Database product is only compliant with the private network in the default availability zone (AZ). i.e. fr-par-1, nl-ams-1, pl-waw-1. To learn more, read our section How to connect a PostgreSQL and MySQL Database Instance to a Private Network

    Create DatabaseInstance Resource

    new DatabaseInstance(name: string, args: DatabaseInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def DatabaseInstance(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         backup_same_region: Optional[bool] = None,
                         backup_schedule_frequency: Optional[int] = None,
                         backup_schedule_retention: Optional[int] = None,
                         disable_backup: Optional[bool] = None,
                         engine: Optional[str] = None,
                         init_settings: Optional[Mapping[str, str]] = None,
                         is_ha_cluster: Optional[bool] = None,
                         load_balancers: Optional[Sequence[DatabaseInstanceLoadBalancerArgs]] = None,
                         name: Optional[str] = None,
                         node_type: Optional[str] = None,
                         password: Optional[str] = None,
                         private_network: Optional[DatabaseInstancePrivateNetworkArgs] = None,
                         project_id: Optional[str] = None,
                         region: Optional[str] = None,
                         settings: Optional[Mapping[str, str]] = None,
                         tags: Optional[Sequence[str]] = None,
                         user_name: Optional[str] = None,
                         volume_size_in_gb: Optional[int] = None,
                         volume_type: Optional[str] = None)
    @overload
    def DatabaseInstance(resource_name: str,
                         args: DatabaseInstanceArgs,
                         opts: Optional[ResourceOptions] = None)
    func NewDatabaseInstance(ctx *Context, name string, args DatabaseInstanceArgs, opts ...ResourceOption) (*DatabaseInstance, error)
    public DatabaseInstance(string name, DatabaseInstanceArgs args, CustomResourceOptions? opts = null)
    public DatabaseInstance(String name, DatabaseInstanceArgs args)
    public DatabaseInstance(String name, DatabaseInstanceArgs args, CustomResourceOptions options)
    
    type: scaleway:DatabaseInstance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DatabaseInstanceArgs
    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 DatabaseInstanceArgs
    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 DatabaseInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Engine string

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    NodeType string

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    BackupSameRegion bool
    Boolean to store logical backups in the same region as the database instance.
    BackupScheduleFrequency int
    Backup schedule frequency in hours.
    BackupScheduleRetention int
    Backup schedule retention in days.
    DisableBackup bool
    Disable automated backup for the database instance.
    InitSettings Dictionary<string, string>

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    IsHaCluster bool

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    LoadBalancers List<Pulumiverse.Scaleway.Inputs.DatabaseInstanceLoadBalancer>
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    Name string
    The name of the Database Instance.
    Password string
    Password for the first user of the database instance.
    PrivateNetwork Pulumiverse.Scaleway.Inputs.DatabaseInstancePrivateNetwork
    List of private networks endpoints of the database instance.
    ProjectId string
    project_id) The ID of the project the Database Instance is associated with.
    Region string
    region) The region in which the Database Instance should be created.
    Settings Dictionary<string, string>
    Map of engine settings to be set. Using this option will override default config.
    Tags List<string>
    The tags associated with the Database Instance.
    UserName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    VolumeSizeInGb int

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    VolumeType string
    Type of volume where data are stored (bssd, lssd or sbs_5k).
    Engine string

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    NodeType string

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    BackupSameRegion bool
    Boolean to store logical backups in the same region as the database instance.
    BackupScheduleFrequency int
    Backup schedule frequency in hours.
    BackupScheduleRetention int
    Backup schedule retention in days.
    DisableBackup bool
    Disable automated backup for the database instance.
    InitSettings map[string]string

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    IsHaCluster bool

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    LoadBalancers []DatabaseInstanceLoadBalancerArgs
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    Name string
    The name of the Database Instance.
    Password string
    Password for the first user of the database instance.
    PrivateNetwork DatabaseInstancePrivateNetworkArgs
    List of private networks endpoints of the database instance.
    ProjectId string
    project_id) The ID of the project the Database Instance is associated with.
    Region string
    region) The region in which the Database Instance should be created.
    Settings map[string]string
    Map of engine settings to be set. Using this option will override default config.
    Tags []string
    The tags associated with the Database Instance.
    UserName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    VolumeSizeInGb int

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    VolumeType string
    Type of volume where data are stored (bssd, lssd or sbs_5k).
    engine String

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    nodeType String

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    backupSameRegion Boolean
    Boolean to store logical backups in the same region as the database instance.
    backupScheduleFrequency Integer
    Backup schedule frequency in hours.
    backupScheduleRetention Integer
    Backup schedule retention in days.
    disableBackup Boolean
    Disable automated backup for the database instance.
    initSettings Map<String,String>

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    isHaCluster Boolean

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    loadBalancers List<DatabaseInstanceLoadBalancer>
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    name String
    The name of the Database Instance.
    password String
    Password for the first user of the database instance.
    privateNetwork DatabaseInstancePrivateNetwork
    List of private networks endpoints of the database instance.
    projectId String
    project_id) The ID of the project the Database Instance is associated with.
    region String
    region) The region in which the Database Instance should be created.
    settings Map<String,String>
    Map of engine settings to be set. Using this option will override default config.
    tags List<String>
    The tags associated with the Database Instance.
    userName String

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb Integer

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    volumeType String
    Type of volume where data are stored (bssd, lssd or sbs_5k).
    engine string

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    nodeType string

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    backupSameRegion boolean
    Boolean to store logical backups in the same region as the database instance.
    backupScheduleFrequency number
    Backup schedule frequency in hours.
    backupScheduleRetention number
    Backup schedule retention in days.
    disableBackup boolean
    Disable automated backup for the database instance.
    initSettings {[key: string]: string}

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    isHaCluster boolean

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    loadBalancers DatabaseInstanceLoadBalancer[]
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    name string
    The name of the Database Instance.
    password string
    Password for the first user of the database instance.
    privateNetwork DatabaseInstancePrivateNetwork
    List of private networks endpoints of the database instance.
    projectId string
    project_id) The ID of the project the Database Instance is associated with.
    region string
    region) The region in which the Database Instance should be created.
    settings {[key: string]: string}
    Map of engine settings to be set. Using this option will override default config.
    tags string[]
    The tags associated with the Database Instance.
    userName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb number

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    volumeType string
    Type of volume where data are stored (bssd, lssd or sbs_5k).
    engine str

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    node_type str

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    backup_same_region bool
    Boolean to store logical backups in the same region as the database instance.
    backup_schedule_frequency int
    Backup schedule frequency in hours.
    backup_schedule_retention int
    Backup schedule retention in days.
    disable_backup bool
    Disable automated backup for the database instance.
    init_settings Mapping[str, str]

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    is_ha_cluster bool

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    load_balancers Sequence[DatabaseInstanceLoadBalancerArgs]
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    name str
    The name of the Database Instance.
    password str
    Password for the first user of the database instance.
    private_network DatabaseInstancePrivateNetworkArgs
    List of private networks endpoints of the database instance.
    project_id str
    project_id) The ID of the project the Database Instance is associated with.
    region str
    region) The region in which the Database Instance should be created.
    settings Mapping[str, str]
    Map of engine settings to be set. Using this option will override default config.
    tags Sequence[str]
    The tags associated with the Database Instance.
    user_name str

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volume_size_in_gb int

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    volume_type str
    Type of volume where data are stored (bssd, lssd or sbs_5k).
    engine String

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    nodeType String

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    backupSameRegion Boolean
    Boolean to store logical backups in the same region as the database instance.
    backupScheduleFrequency Number
    Backup schedule frequency in hours.
    backupScheduleRetention Number
    Backup schedule retention in days.
    disableBackup Boolean
    Disable automated backup for the database instance.
    initSettings Map<String>

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    isHaCluster Boolean

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    loadBalancers List<Property Map>
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    name String
    The name of the Database Instance.
    password String
    Password for the first user of the database instance.
    privateNetwork Property Map
    List of private networks endpoints of the database instance.
    projectId String
    project_id) The ID of the project the Database Instance is associated with.
    region String
    region) The region in which the Database Instance should be created.
    settings Map<String>
    Map of engine settings to be set. Using this option will override default config.
    tags List<String>
    The tags associated with the Database Instance.
    userName String

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb Number

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    volumeType String
    Type of volume where data are stored (bssd, lssd or sbs_5k).

    Outputs

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

    Certificate string
    Certificate of the database instance.
    EndpointIp string
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    EndpointPort int
    (Deprecated) The port of the Database Instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    The organization ID the Database Instance is associated with.
    ReadReplicas List<Pulumiverse.Scaleway.Outputs.DatabaseInstanceReadReplica>
    List of read replicas of the database instance.
    Certificate string
    Certificate of the database instance.
    EndpointIp string
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    EndpointPort int
    (Deprecated) The port of the Database Instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    The organization ID the Database Instance is associated with.
    ReadReplicas []DatabaseInstanceReadReplica
    List of read replicas of the database instance.
    certificate String
    Certificate of the database instance.
    endpointIp String
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    endpointPort Integer
    (Deprecated) The port of the Database Instance.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    The organization ID the Database Instance is associated with.
    readReplicas List<DatabaseInstanceReadReplica>
    List of read replicas of the database instance.
    certificate string
    Certificate of the database instance.
    endpointIp string
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    endpointPort number
    (Deprecated) The port of the Database Instance.
    id string
    The provider-assigned unique ID for this managed resource.
    organizationId string
    The organization ID the Database Instance is associated with.
    readReplicas DatabaseInstanceReadReplica[]
    List of read replicas of the database instance.
    certificate str
    Certificate of the database instance.
    endpoint_ip str
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    endpoint_port int
    (Deprecated) The port of the Database Instance.
    id str
    The provider-assigned unique ID for this managed resource.
    organization_id str
    The organization ID the Database Instance is associated with.
    read_replicas Sequence[DatabaseInstanceReadReplica]
    List of read replicas of the database instance.
    certificate String
    Certificate of the database instance.
    endpointIp String
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    endpointPort Number
    (Deprecated) The port of the Database Instance.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    The organization ID the Database Instance is associated with.
    readReplicas List<Property Map>
    List of read replicas of the database instance.

    Look up Existing DatabaseInstance Resource

    Get an existing DatabaseInstance 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?: DatabaseInstanceState, opts?: CustomResourceOptions): DatabaseInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_same_region: Optional[bool] = None,
            backup_schedule_frequency: Optional[int] = None,
            backup_schedule_retention: Optional[int] = None,
            certificate: Optional[str] = None,
            disable_backup: Optional[bool] = None,
            endpoint_ip: Optional[str] = None,
            endpoint_port: Optional[int] = None,
            engine: Optional[str] = None,
            init_settings: Optional[Mapping[str, str]] = None,
            is_ha_cluster: Optional[bool] = None,
            load_balancers: Optional[Sequence[DatabaseInstanceLoadBalancerArgs]] = None,
            name: Optional[str] = None,
            node_type: Optional[str] = None,
            organization_id: Optional[str] = None,
            password: Optional[str] = None,
            private_network: Optional[DatabaseInstancePrivateNetworkArgs] = None,
            project_id: Optional[str] = None,
            read_replicas: Optional[Sequence[DatabaseInstanceReadReplicaArgs]] = None,
            region: Optional[str] = None,
            settings: Optional[Mapping[str, str]] = None,
            tags: Optional[Sequence[str]] = None,
            user_name: Optional[str] = None,
            volume_size_in_gb: Optional[int] = None,
            volume_type: Optional[str] = None) -> DatabaseInstance
    func GetDatabaseInstance(ctx *Context, name string, id IDInput, state *DatabaseInstanceState, opts ...ResourceOption) (*DatabaseInstance, error)
    public static DatabaseInstance Get(string name, Input<string> id, DatabaseInstanceState? state, CustomResourceOptions? opts = null)
    public static DatabaseInstance get(String name, Output<String> id, DatabaseInstanceState 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:
    BackupSameRegion bool
    Boolean to store logical backups in the same region as the database instance.
    BackupScheduleFrequency int
    Backup schedule frequency in hours.
    BackupScheduleRetention int
    Backup schedule retention in days.
    Certificate string
    Certificate of the database instance.
    DisableBackup bool
    Disable automated backup for the database instance.
    EndpointIp string
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    EndpointPort int
    (Deprecated) The port of the Database Instance.
    Engine string

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    InitSettings Dictionary<string, string>

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    IsHaCluster bool

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    LoadBalancers List<Pulumiverse.Scaleway.Inputs.DatabaseInstanceLoadBalancer>
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    Name string
    The name of the Database Instance.
    NodeType string

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    OrganizationId string
    The organization ID the Database Instance is associated with.
    Password string
    Password for the first user of the database instance.
    PrivateNetwork Pulumiverse.Scaleway.Inputs.DatabaseInstancePrivateNetwork
    List of private networks endpoints of the database instance.
    ProjectId string
    project_id) The ID of the project the Database Instance is associated with.
    ReadReplicas List<Pulumiverse.Scaleway.Inputs.DatabaseInstanceReadReplica>
    List of read replicas of the database instance.
    Region string
    region) The region in which the Database Instance should be created.
    Settings Dictionary<string, string>
    Map of engine settings to be set. Using this option will override default config.
    Tags List<string>
    The tags associated with the Database Instance.
    UserName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    VolumeSizeInGb int

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    VolumeType string
    Type of volume where data are stored (bssd, lssd or sbs_5k).
    BackupSameRegion bool
    Boolean to store logical backups in the same region as the database instance.
    BackupScheduleFrequency int
    Backup schedule frequency in hours.
    BackupScheduleRetention int
    Backup schedule retention in days.
    Certificate string
    Certificate of the database instance.
    DisableBackup bool
    Disable automated backup for the database instance.
    EndpointIp string
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    EndpointPort int
    (Deprecated) The port of the Database Instance.
    Engine string

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    InitSettings map[string]string

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    IsHaCluster bool

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    LoadBalancers []DatabaseInstanceLoadBalancerArgs
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    Name string
    The name of the Database Instance.
    NodeType string

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    OrganizationId string
    The organization ID the Database Instance is associated with.
    Password string
    Password for the first user of the database instance.
    PrivateNetwork DatabaseInstancePrivateNetworkArgs
    List of private networks endpoints of the database instance.
    ProjectId string
    project_id) The ID of the project the Database Instance is associated with.
    ReadReplicas []DatabaseInstanceReadReplicaArgs
    List of read replicas of the database instance.
    Region string
    region) The region in which the Database Instance should be created.
    Settings map[string]string
    Map of engine settings to be set. Using this option will override default config.
    Tags []string
    The tags associated with the Database Instance.
    UserName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    VolumeSizeInGb int

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    VolumeType string
    Type of volume where data are stored (bssd, lssd or sbs_5k).
    backupSameRegion Boolean
    Boolean to store logical backups in the same region as the database instance.
    backupScheduleFrequency Integer
    Backup schedule frequency in hours.
    backupScheduleRetention Integer
    Backup schedule retention in days.
    certificate String
    Certificate of the database instance.
    disableBackup Boolean
    Disable automated backup for the database instance.
    endpointIp String
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    endpointPort Integer
    (Deprecated) The port of the Database Instance.
    engine String

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    initSettings Map<String,String>

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    isHaCluster Boolean

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    loadBalancers List<DatabaseInstanceLoadBalancer>
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    name String
    The name of the Database Instance.
    nodeType String

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    organizationId String
    The organization ID the Database Instance is associated with.
    password String
    Password for the first user of the database instance.
    privateNetwork DatabaseInstancePrivateNetwork
    List of private networks endpoints of the database instance.
    projectId String
    project_id) The ID of the project the Database Instance is associated with.
    readReplicas List<DatabaseInstanceReadReplica>
    List of read replicas of the database instance.
    region String
    region) The region in which the Database Instance should be created.
    settings Map<String,String>
    Map of engine settings to be set. Using this option will override default config.
    tags List<String>
    The tags associated with the Database Instance.
    userName String

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb Integer

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    volumeType String
    Type of volume where data are stored (bssd, lssd or sbs_5k).
    backupSameRegion boolean
    Boolean to store logical backups in the same region as the database instance.
    backupScheduleFrequency number
    Backup schedule frequency in hours.
    backupScheduleRetention number
    Backup schedule retention in days.
    certificate string
    Certificate of the database instance.
    disableBackup boolean
    Disable automated backup for the database instance.
    endpointIp string
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    endpointPort number
    (Deprecated) The port of the Database Instance.
    engine string

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    initSettings {[key: string]: string}

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    isHaCluster boolean

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    loadBalancers DatabaseInstanceLoadBalancer[]
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    name string
    The name of the Database Instance.
    nodeType string

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    organizationId string
    The organization ID the Database Instance is associated with.
    password string
    Password for the first user of the database instance.
    privateNetwork DatabaseInstancePrivateNetwork
    List of private networks endpoints of the database instance.
    projectId string
    project_id) The ID of the project the Database Instance is associated with.
    readReplicas DatabaseInstanceReadReplica[]
    List of read replicas of the database instance.
    region string
    region) The region in which the Database Instance should be created.
    settings {[key: string]: string}
    Map of engine settings to be set. Using this option will override default config.
    tags string[]
    The tags associated with the Database Instance.
    userName string

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb number

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    volumeType string
    Type of volume where data are stored (bssd, lssd or sbs_5k).
    backup_same_region bool
    Boolean to store logical backups in the same region as the database instance.
    backup_schedule_frequency int
    Backup schedule frequency in hours.
    backup_schedule_retention int
    Backup schedule retention in days.
    certificate str
    Certificate of the database instance.
    disable_backup bool
    Disable automated backup for the database instance.
    endpoint_ip str
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    endpoint_port int
    (Deprecated) The port of the Database Instance.
    engine str

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    init_settings Mapping[str, str]

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    is_ha_cluster bool

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    load_balancers Sequence[DatabaseInstanceLoadBalancerArgs]
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    name str
    The name of the Database Instance.
    node_type str

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    organization_id str
    The organization ID the Database Instance is associated with.
    password str
    Password for the first user of the database instance.
    private_network DatabaseInstancePrivateNetworkArgs
    List of private networks endpoints of the database instance.
    project_id str
    project_id) The ID of the project the Database Instance is associated with.
    read_replicas Sequence[DatabaseInstanceReadReplicaArgs]
    List of read replicas of the database instance.
    region str
    region) The region in which the Database Instance should be created.
    settings Mapping[str, str]
    Map of engine settings to be set. Using this option will override default config.
    tags Sequence[str]
    The tags associated with the Database Instance.
    user_name str

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volume_size_in_gb int

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    volume_type str
    Type of volume where data are stored (bssd, lssd or sbs_5k).
    backupSameRegion Boolean
    Boolean to store logical backups in the same region as the database instance.
    backupScheduleFrequency Number
    Backup schedule frequency in hours.
    backupScheduleRetention Number
    Backup schedule retention in days.
    certificate String
    Certificate of the database instance.
    disableBackup Boolean
    Disable automated backup for the database instance.
    endpointIp String
    (Deprecated) The IP of the Database Instance.

    Deprecated:Please use the private_network or the load_balancer attribute

    endpointPort Number
    (Deprecated) The port of the Database Instance.
    engine String

    Database Instance's engine version (e.g. PostgreSQL-11).

    Important: Updates to engine will recreate the Database Instance.

    initSettings Map<String>

    Map of engine settings to be set at database initialisation.

    Important: Updates to init_settings will recreate the Database Instance.

    Please consult the GoDoc to list all available settings and init_settings for the node_type of your convenience.

    isHaCluster Boolean

    Enable or disable high availability for the database instance.

    Important: Updates to is_ha_cluster will recreate the Database Instance.

    loadBalancers List<Property Map>
    List of load balancer endpoints of the database instance. A load-balancer endpoint will be set by default if no private network is. This block must be defined if you want a public endpoint in addition to your private endpoint.
    name String
    The name of the Database Instance.
    nodeType String

    The type of database instance you want to create (e.g. db-dev-s).

    Important: Updates to node_type will upgrade the Database Instance to the desired node_type without any interruption. Keep in mind that you cannot downgrade a Database Instance.

    Important: Once your instance reaches disk_full status, if you are using lssd storage, you should upgrade the node_type, and if you are using bssd storage, you should increase the volume size before making any other change to your instance.

    organizationId String
    The organization ID the Database Instance is associated with.
    password String
    Password for the first user of the database instance.
    privateNetwork Property Map
    List of private networks endpoints of the database instance.
    projectId String
    project_id) The ID of the project the Database Instance is associated with.
    readReplicas List<Property Map>
    List of read replicas of the database instance.
    region String
    region) The region in which the Database Instance should be created.
    settings Map<String>
    Map of engine settings to be set. Using this option will override default config.
    tags List<String>
    The tags associated with the Database Instance.
    userName String

    Identifier for the first user of the database instance.

    Important: Updates to user_name will recreate the Database Instance.

    volumeSizeInGb Number

    Volume size (in GB). Cannot be used when volume_type is set to lssd.

    Important: Once your instance reaches disk_full status, you should increase the volume size before making any other change to your instance.

    volumeType String
    Type of volume where data are stored (bssd, lssd or sbs_5k).

    Supporting Types

    DatabaseInstanceLoadBalancer, DatabaseInstanceLoadBalancerArgs

    EndpointId string
    The ID of the endpoint.
    Hostname string
    Hostname of the endpoint.
    Ip string
    IPv4 address on the network.
    Name string
    The name of the Database Instance.
    Port int
    Port in the Private Network.
    EndpointId string
    The ID of the endpoint.
    Hostname string
    Hostname of the endpoint.
    Ip string
    IPv4 address on the network.
    Name string
    The name of the Database Instance.
    Port int
    Port in the Private Network.
    endpointId String
    The ID of the endpoint.
    hostname String
    Hostname of the endpoint.
    ip String
    IPv4 address on the network.
    name String
    The name of the Database Instance.
    port Integer
    Port in the Private Network.
    endpointId string
    The ID of the endpoint.
    hostname string
    Hostname of the endpoint.
    ip string
    IPv4 address on the network.
    name string
    The name of the Database Instance.
    port number
    Port in the Private Network.
    endpoint_id str
    The ID of the endpoint.
    hostname str
    Hostname of the endpoint.
    ip str
    IPv4 address on the network.
    name str
    The name of the Database Instance.
    port int
    Port in the Private Network.
    endpointId String
    The ID of the endpoint.
    hostname String
    Hostname of the endpoint.
    ip String
    IPv4 address on the network.
    name String
    The name of the Database Instance.
    port Number
    Port in the Private Network.

    DatabaseInstancePrivateNetwork, DatabaseInstancePrivateNetworkArgs

    PnId string
    The ID of the private network.
    EnableIpam bool

    If true, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.

    NOTE: Please calculate your host IP using cidrhost. Otherwise, let IPAM service handle the host IP on the network.

    Important: Updates to private_network will recreate the Instance's endpoint

    EndpointId string
    The ID of the endpoint.
    Hostname string
    Hostname of the endpoint.
    Ip string
    IPv4 address on the network.
    IpNet string
    The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. If not set, The IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
    Name string
    The name of the Database Instance.
    Port int
    Port in the Private Network.
    Zone string
    The zone you want to attach the resource to
    PnId string
    The ID of the private network.
    EnableIpam bool

    If true, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.

    NOTE: Please calculate your host IP using cidrhost. Otherwise, let IPAM service handle the host IP on the network.

    Important: Updates to private_network will recreate the Instance's endpoint

    EndpointId string
    The ID of the endpoint.
    Hostname string
    Hostname of the endpoint.
    Ip string
    IPv4 address on the network.
    IpNet string
    The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. If not set, The IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
    Name string
    The name of the Database Instance.
    Port int
    Port in the Private Network.
    Zone string
    The zone you want to attach the resource to
    pnId String
    The ID of the private network.
    enableIpam Boolean

    If true, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.

    NOTE: Please calculate your host IP using cidrhost. Otherwise, let IPAM service handle the host IP on the network.

    Important: Updates to private_network will recreate the Instance's endpoint

    endpointId String
    The ID of the endpoint.
    hostname String
    Hostname of the endpoint.
    ip String
    IPv4 address on the network.
    ipNet String
    The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. If not set, The IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
    name String
    The name of the Database Instance.
    port Integer
    Port in the Private Network.
    zone String
    The zone you want to attach the resource to
    pnId string
    The ID of the private network.
    enableIpam boolean

    If true, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.

    NOTE: Please calculate your host IP using cidrhost. Otherwise, let IPAM service handle the host IP on the network.

    Important: Updates to private_network will recreate the Instance's endpoint

    endpointId string
    The ID of the endpoint.
    hostname string
    Hostname of the endpoint.
    ip string
    IPv4 address on the network.
    ipNet string
    The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. If not set, The IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
    name string
    The name of the Database Instance.
    port number
    Port in the Private Network.
    zone string
    The zone you want to attach the resource to
    pn_id str
    The ID of the private network.
    enable_ipam bool

    If true, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.

    NOTE: Please calculate your host IP using cidrhost. Otherwise, let IPAM service handle the host IP on the network.

    Important: Updates to private_network will recreate the Instance's endpoint

    endpoint_id str
    The ID of the endpoint.
    hostname str
    Hostname of the endpoint.
    ip str
    IPv4 address on the network.
    ip_net str
    The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. If not set, The IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
    name str
    The name of the Database Instance.
    port int
    Port in the Private Network.
    zone str
    The zone you want to attach the resource to
    pnId String
    The ID of the private network.
    enableIpam Boolean

    If true, the IP network address within the private subnet is determined by the IP Address Management (IPAM) service.

    NOTE: Please calculate your host IP using cidrhost. Otherwise, let IPAM service handle the host IP on the network.

    Important: Updates to private_network will recreate the Instance's endpoint

    endpointId String
    The ID of the endpoint.
    hostname String
    Hostname of the endpoint.
    ip String
    IPv4 address on the network.
    ipNet String
    The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. If not set, The IP network address within the private subnet is determined by the IP Address Management (IPAM) service.
    name String
    The name of the Database Instance.
    port Number
    Port in the Private Network.
    zone String
    The zone you want to attach the resource to

    DatabaseInstanceReadReplica, DatabaseInstanceReadReplicaArgs

    Ip string
    IPv4 address on the network.
    Name string
    The name of the Database Instance.
    Port int
    Port in the Private Network.
    Ip string
    IPv4 address on the network.
    Name string
    The name of the Database Instance.
    Port int
    Port in the Private Network.
    ip String
    IPv4 address on the network.
    name String
    The name of the Database Instance.
    port Integer
    Port in the Private Network.
    ip string
    IPv4 address on the network.
    name string
    The name of the Database Instance.
    port number
    Port in the Private Network.
    ip str
    IPv4 address on the network.
    name str
    The name of the Database Instance.
    port int
    Port in the Private Network.
    ip String
    IPv4 address on the network.
    name String
    The name of the Database Instance.
    port Number
    Port in the Private Network.

    Import

    Database Instance can be imported using the {region}/{id}, e.g.

    bash

    $ pulumi import scaleway:index/databaseInstance:DatabaseInstance rdb01 fr-par/11111111-1111-1111-1111-111111111111
    

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.12.0 published on Monday, Mar 11, 2024 by pulumiverse