1. Packages
  2. Scaleway
  3. API Docs
  4. DatabaseInstance
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse

scaleway.DatabaseInstance

Explore with Pulumi AI

scaleway logo
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse

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

    Example Usage

    Example Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.DatabaseInstance("main", {
        name: "test-rdb",
        nodeType: "DB-DEV-S",
        engine: "PostgreSQL-15",
        isHaCluster: true,
        disableBackup: true,
        userName: "my_initial_user",
        password: "thiZ_is_v&ry_s3cret",
        encryptionAtRest: true,
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.DatabaseInstance("main",
        name="test-rdb",
        node_type="DB-DEV-S",
        engine="PostgreSQL-15",
        is_ha_cluster=True,
        disable_backup=True,
        user_name="my_initial_user",
        password="thiZ_is_v&ry_s3cret",
        encryption_at_rest=True)
    
    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{
    			Name:             pulumi.String("test-rdb"),
    			NodeType:         pulumi.String("DB-DEV-S"),
    			Engine:           pulumi.String("PostgreSQL-15"),
    			IsHaCluster:      pulumi.Bool(true),
    			DisableBackup:    pulumi.Bool(true),
    			UserName:         pulumi.String("my_initial_user"),
    			Password:         pulumi.String("thiZ_is_v&ry_s3cret"),
    			EncryptionAtRest: pulumi.Bool(true),
    		})
    		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()
        {
            Name = "test-rdb",
            NodeType = "DB-DEV-S",
            Engine = "PostgreSQL-15",
            IsHaCluster = true,
            DisableBackup = true,
            UserName = "my_initial_user",
            Password = "thiZ_is_v&ry_s3cret",
            EncryptionAtRest = true,
        });
    
    });
    
    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()
                .name("test-rdb")
                .nodeType("DB-DEV-S")
                .engine("PostgreSQL-15")
                .isHaCluster(true)
                .disableBackup(true)
                .userName("my_initial_user")
                .password("thiZ_is_v&ry_s3cret")
                .encryptionAtRest(true)
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:DatabaseInstance
        properties:
          name: test-rdb
          nodeType: DB-DEV-S
          engine: PostgreSQL-15
          isHaCluster: true
          disableBackup: true
          userName: my_initial_user
          password: thiZ_is_v&ry_s3cret
          encryptionAtRest: true
    

    Example Block Storage Low Latency

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.DatabaseInstance("main", {
        name: "test-rdb-sbs",
        nodeType: "db-play2-pico",
        engine: "PostgreSQL-15",
        isHaCluster: true,
        disableBackup: true,
        userName: "my_initial_user",
        password: "thiZ_is_v&ry_s3cret",
        volumeType: "sbs_15k",
        volumeSizeInGb: 10,
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.DatabaseInstance("main",
        name="test-rdb-sbs",
        node_type="db-play2-pico",
        engine="PostgreSQL-15",
        is_ha_cluster=True,
        disable_backup=True,
        user_name="my_initial_user",
        password="thiZ_is_v&ry_s3cret",
        volume_type="sbs_15k",
        volume_size_in_gb=10)
    
    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{
    			Name:           pulumi.String("test-rdb-sbs"),
    			NodeType:       pulumi.String("db-play2-pico"),
    			Engine:         pulumi.String("PostgreSQL-15"),
    			IsHaCluster:    pulumi.Bool(true),
    			DisableBackup:  pulumi.Bool(true),
    			UserName:       pulumi.String("my_initial_user"),
    			Password:       pulumi.String("thiZ_is_v&ry_s3cret"),
    			VolumeType:     pulumi.String("sbs_15k"),
    			VolumeSizeInGb: pulumi.Int(10),
    		})
    		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()
        {
            Name = "test-rdb-sbs",
            NodeType = "db-play2-pico",
            Engine = "PostgreSQL-15",
            IsHaCluster = true,
            DisableBackup = true,
            UserName = "my_initial_user",
            Password = "thiZ_is_v&ry_s3cret",
            VolumeType = "sbs_15k",
            VolumeSizeInGb = 10,
        });
    
    });
    
    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()
                .name("test-rdb-sbs")
                .nodeType("db-play2-pico")
                .engine("PostgreSQL-15")
                .isHaCluster(true)
                .disableBackup(true)
                .userName("my_initial_user")
                .password("thiZ_is_v&ry_s3cret")
                .volumeType("sbs_15k")
                .volumeSizeInGb(10)
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:DatabaseInstance
        properties:
          name: test-rdb-sbs
          nodeType: db-play2-pico
          engine: PostgreSQL-15
          isHaCluster: true
          disableBackup: true
          userName: my_initial_user
          password: thiZ_is_v&ry_s3cret
          volumeType: sbs_15k
          volumeSizeInGb: 10
    

    Example with Settings

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.DatabaseInstance("main", {
        name: "test-rdb",
        nodeType: "db-dev-s",
        disableBackup: true,
        engine: "MySQL-8",
        userName: "my_initial_user",
        password: "thiZ_is_v&ry_s3cret",
        initSettings: {
            lower_case_table_names: "1",
        },
        settings: {
            max_connections: "350",
        },
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.DatabaseInstance("main",
        name="test-rdb",
        node_type="db-dev-s",
        disable_backup=True,
        engine="MySQL-8",
        user_name="my_initial_user",
        password="thiZ_is_v&ry_s3cret",
        init_settings={
            "lower_case_table_names": "1",
        },
        settings={
            "max_connections": "350",
        })
    
    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{
    			Name:          pulumi.String("test-rdb"),
    			NodeType:      pulumi.String("db-dev-s"),
    			DisableBackup: pulumi.Bool(true),
    			Engine:        pulumi.String("MySQL-8"),
    			UserName:      pulumi.String("my_initial_user"),
    			Password:      pulumi.String("thiZ_is_v&ry_s3cret"),
    			InitSettings: pulumi.StringMap{
    				"lower_case_table_names": pulumi.String("1"),
    			},
    			Settings: pulumi.StringMap{
    				"max_connections": pulumi.String("350"),
    			},
    		})
    		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()
        {
            Name = "test-rdb",
            NodeType = "db-dev-s",
            DisableBackup = true,
            Engine = "MySQL-8",
            UserName = "my_initial_user",
            Password = "thiZ_is_v&ry_s3cret",
            InitSettings = 
            {
                { "lower_case_table_names", "1" },
            },
            Settings = 
            {
                { "max_connections", "350" },
            },
        });
    
    });
    
    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()
                .name("test-rdb")
                .nodeType("db-dev-s")
                .disableBackup(true)
                .engine("MySQL-8")
                .userName("my_initial_user")
                .password("thiZ_is_v&ry_s3cret")
                .initSettings(Map.of("lower_case_table_names", 1))
                .settings(Map.of("max_connections", "350"))
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:DatabaseInstance
        properties:
          name: test-rdb
          nodeType: db-dev-s
          disableBackup: true
          engine: MySQL-8
          userName: my_initial_user
          password: thiZ_is_v&ry_s3cret
          initSettings:
            lower_case_table_names: 1
          settings:
            max_connections: '350'
    

    Example with backup schedule

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.DatabaseInstance("main", {
        name: "test-rdb",
        nodeType: "DB-DEV-S",
        engine: "PostgreSQL-15",
        isHaCluster: true,
        userName: "my_initial_user",
        password: "thiZ_is_v&ry_s3cret",
        disableBackup: false,
        backupScheduleFrequency: 24,
        backupScheduleRetention: 7,
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.DatabaseInstance("main",
        name="test-rdb",
        node_type="DB-DEV-S",
        engine="PostgreSQL-15",
        is_ha_cluster=True,
        user_name="my_initial_user",
        password="thiZ_is_v&ry_s3cret",
        disable_backup=False,
        backup_schedule_frequency=24,
        backup_schedule_retention=7)
    
    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{
    			Name:                    pulumi.String("test-rdb"),
    			NodeType:                pulumi.String("DB-DEV-S"),
    			Engine:                  pulumi.String("PostgreSQL-15"),
    			IsHaCluster:             pulumi.Bool(true),
    			UserName:                pulumi.String("my_initial_user"),
    			Password:                pulumi.String("thiZ_is_v&ry_s3cret"),
    			DisableBackup:           pulumi.Bool(false),
    			BackupScheduleFrequency: pulumi.Int(24),
    			BackupScheduleRetention: pulumi.Int(7),
    		})
    		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()
        {
            Name = "test-rdb",
            NodeType = "DB-DEV-S",
            Engine = "PostgreSQL-15",
            IsHaCluster = true,
            UserName = "my_initial_user",
            Password = "thiZ_is_v&ry_s3cret",
            DisableBackup = false,
            BackupScheduleFrequency = 24,
            BackupScheduleRetention = 7,
        });
    
    });
    
    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()
                .name("test-rdb")
                .nodeType("DB-DEV-S")
                .engine("PostgreSQL-15")
                .isHaCluster(true)
                .userName("my_initial_user")
                .password("thiZ_is_v&ry_s3cret")
                .disableBackup(false)
                .backupScheduleFrequency(24)
                .backupScheduleRetention(7)
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:DatabaseInstance
        properties:
          name: test-rdb
          nodeType: DB-DEV-S
          engine: PostgreSQL-15
          isHaCluster: true
          userName: my_initial_user
          password: thiZ_is_v&ry_s3cret
          disableBackup: false
          backupScheduleFrequency: 24 # every day
          backupScheduleRetention: 7 # keep it one week
    

    Examples of endpoint configuration

    Database Instances can have a maximum of 1 public endpoint and 1 private endpoint. They 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-15",
        privateNetwork: {
            pnId: pn.id,
            ipNet: "172.16.20.4/22",
        },
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    pn = scaleway.VpcPrivateNetwork("pn", ipv4_subnet={
        "subnet": "172.16.20.0/22",
    })
    main = scaleway.DatabaseInstance("main",
        node_type="db-dev-s",
        engine="PostgreSQL-15",
        private_network={
            "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-15"),
    			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-15",
            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-15")
                .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-15
          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", {
        loadBalancers: [{}],
        nodeType: "DB-DEV-S",
        engine: "PostgreSQL-15",
        privateNetwork: {
            pnId: pn.id,
            enableIpam: true,
        },
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    pn = scaleway.VpcPrivateNetwork("pn")
    main = scaleway.DatabaseInstance("main",
        load_balancers=[{}],
        node_type="DB-DEV-S",
        engine="PostgreSQL-15",
        private_network={
            "pn_id": pn.id,
            "enable_ipam": True,
        })
    
    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{
    			LoadBalancers: scaleway.DatabaseInstanceLoadBalancerArray{
    				&scaleway.DatabaseInstanceLoadBalancerArgs{},
    			},
    			NodeType: pulumi.String("DB-DEV-S"),
    			Engine:   pulumi.String("PostgreSQL-15"),
    			PrivateNetwork: &scaleway.DatabaseInstancePrivateNetworkArgs{
    				PnId:       pn.ID(),
    				EnableIpam: pulumi.Bool(true),
    			},
    		})
    		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()
        {
            LoadBalancers = new[]
            {
                null,
            },
            NodeType = "DB-DEV-S",
            Engine = "PostgreSQL-15",
            PrivateNetwork = new Scaleway.Inputs.DatabaseInstancePrivateNetworkArgs
            {
                PnId = pn.Id,
                EnableIpam = true,
            },
        });
    
    });
    
    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.DatabaseInstanceLoadBalancerArgs;
    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");
    
            var main = new DatabaseInstance("main", DatabaseInstanceArgs.builder()
                .loadBalancers()
                .nodeType("DB-DEV-S")
                .engine("PostgreSQL-15")
                .privateNetwork(DatabaseInstancePrivateNetworkArgs.builder()
                    .pnId(pn.id())
                    .enableIpam(true)
                    .build())
                .build());
    
        }
    }
    
    resources:
      pn:
        type: scaleway:VpcPrivateNetwork
      main:
        type: scaleway:DatabaseInstance
        properties:
          loadBalancers:
            - {}
          nodeType: DB-DEV-S
          engine: PostgreSQL-15
          privateNetwork:
            pnId: ${pn.id}
            enableIpam: true
    

    Default: 1 public endpoint

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const main = new scaleway.DatabaseInstance("main", {
        nodeType: "db-dev-s",
        engine: "PostgreSQL-15",
    });
    
    import pulumi
    import pulumiverse_scaleway as scaleway
    
    main = scaleway.DatabaseInstance("main",
        node_type="db-dev-s",
        engine="PostgreSQL-15")
    
    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{
    			NodeType: pulumi.String("db-dev-s"),
    			Engine:   pulumi.String("PostgreSQL-15"),
    		})
    		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()
        {
            NodeType = "db-dev-s",
            Engine = "PostgreSQL-15",
        });
    
    });
    
    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()
                .nodeType("db-dev-s")
                .engine("PostgreSQL-15")
                .build());
    
        }
    }
    
    resources:
      main:
        type: scaleway:DatabaseInstance
        properties:
          nodeType: db-dev-s
          engine: PostgreSQL-15
    

    Note If nothing is defined, your Database 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

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

    Constructor syntax

    new DatabaseInstance(name: string, args: DatabaseInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def DatabaseInstance(resource_name: str,
                         args: DatabaseInstanceArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def DatabaseInstance(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         engine: Optional[str] = None,
                         node_type: Optional[str] = None,
                         name: Optional[str] = None,
                         backup_schedule_frequency: Optional[int] = None,
                         encryption_at_rest: Optional[bool] = None,
                         backup_schedule_retention: Optional[int] = None,
                         init_settings: Optional[Mapping[str, str]] = None,
                         is_ha_cluster: Optional[bool] = None,
                         load_balancers: Optional[Sequence[DatabaseInstanceLoadBalancerArgs]] = None,
                         logs_policy: Optional[DatabaseInstanceLogsPolicyArgs] = None,
                         backup_same_region: Optional[bool] = None,
                         disable_backup: Optional[bool] = 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)
    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.
    
    

    Parameters

    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.

    Constructor example

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

    var databaseInstanceResource = new Scaleway.DatabaseInstance("databaseInstanceResource", new()
    {
        Engine = "string",
        NodeType = "string",
        Name = "string",
        BackupScheduleFrequency = 0,
        EncryptionAtRest = false,
        BackupScheduleRetention = 0,
        InitSettings = 
        {
            { "string", "string" },
        },
        IsHaCluster = false,
        LoadBalancers = new[]
        {
            new Scaleway.Inputs.DatabaseInstanceLoadBalancerArgs
            {
                EndpointId = "string",
                Hostname = "string",
                Ip = "string",
                Name = "string",
                Port = 0,
            },
        },
        LogsPolicy = new Scaleway.Inputs.DatabaseInstanceLogsPolicyArgs
        {
            MaxAgeRetention = 0,
            TotalDiskRetention = 0,
        },
        BackupSameRegion = false,
        DisableBackup = false,
        Password = "string",
        PrivateNetwork = new Scaleway.Inputs.DatabaseInstancePrivateNetworkArgs
        {
            PnId = "string",
            EnableIpam = false,
            EndpointId = "string",
            Hostname = "string",
            Ip = "string",
            IpNet = "string",
            Name = "string",
            Port = 0,
            Zone = "string",
        },
        ProjectId = "string",
        Region = "string",
        Settings = 
        {
            { "string", "string" },
        },
        Tags = new[]
        {
            "string",
        },
        UserName = "string",
        VolumeSizeInGb = 0,
        VolumeType = "string",
    });
    
    example, err := scaleway.NewDatabaseInstance(ctx, "databaseInstanceResource", &scaleway.DatabaseInstanceArgs{
    	Engine:                  pulumi.String("string"),
    	NodeType:                pulumi.String("string"),
    	Name:                    pulumi.String("string"),
    	BackupScheduleFrequency: pulumi.Int(0),
    	EncryptionAtRest:        pulumi.Bool(false),
    	BackupScheduleRetention: pulumi.Int(0),
    	InitSettings: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	IsHaCluster: pulumi.Bool(false),
    	LoadBalancers: scaleway.DatabaseInstanceLoadBalancerArray{
    		&scaleway.DatabaseInstanceLoadBalancerArgs{
    			EndpointId: pulumi.String("string"),
    			Hostname:   pulumi.String("string"),
    			Ip:         pulumi.String("string"),
    			Name:       pulumi.String("string"),
    			Port:       pulumi.Int(0),
    		},
    	},
    	LogsPolicy: &scaleway.DatabaseInstanceLogsPolicyArgs{
    		MaxAgeRetention:    pulumi.Int(0),
    		TotalDiskRetention: pulumi.Int(0),
    	},
    	BackupSameRegion: pulumi.Bool(false),
    	DisableBackup:    pulumi.Bool(false),
    	Password:         pulumi.String("string"),
    	PrivateNetwork: &scaleway.DatabaseInstancePrivateNetworkArgs{
    		PnId:       pulumi.String("string"),
    		EnableIpam: pulumi.Bool(false),
    		EndpointId: pulumi.String("string"),
    		Hostname:   pulumi.String("string"),
    		Ip:         pulumi.String("string"),
    		IpNet:      pulumi.String("string"),
    		Name:       pulumi.String("string"),
    		Port:       pulumi.Int(0),
    		Zone:       pulumi.String("string"),
    	},
    	ProjectId: pulumi.String("string"),
    	Region:    pulumi.String("string"),
    	Settings: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UserName:       pulumi.String("string"),
    	VolumeSizeInGb: pulumi.Int(0),
    	VolumeType:     pulumi.String("string"),
    })
    
    var databaseInstanceResource = new DatabaseInstance("databaseInstanceResource", DatabaseInstanceArgs.builder()
        .engine("string")
        .nodeType("string")
        .name("string")
        .backupScheduleFrequency(0)
        .encryptionAtRest(false)
        .backupScheduleRetention(0)
        .initSettings(Map.of("string", "string"))
        .isHaCluster(false)
        .loadBalancers(DatabaseInstanceLoadBalancerArgs.builder()
            .endpointId("string")
            .hostname("string")
            .ip("string")
            .name("string")
            .port(0)
            .build())
        .logsPolicy(DatabaseInstanceLogsPolicyArgs.builder()
            .maxAgeRetention(0)
            .totalDiskRetention(0)
            .build())
        .backupSameRegion(false)
        .disableBackup(false)
        .password("string")
        .privateNetwork(DatabaseInstancePrivateNetworkArgs.builder()
            .pnId("string")
            .enableIpam(false)
            .endpointId("string")
            .hostname("string")
            .ip("string")
            .ipNet("string")
            .name("string")
            .port(0)
            .zone("string")
            .build())
        .projectId("string")
        .region("string")
        .settings(Map.of("string", "string"))
        .tags("string")
        .userName("string")
        .volumeSizeInGb(0)
        .volumeType("string")
        .build());
    
    database_instance_resource = scaleway.DatabaseInstance("databaseInstanceResource",
        engine="string",
        node_type="string",
        name="string",
        backup_schedule_frequency=0,
        encryption_at_rest=False,
        backup_schedule_retention=0,
        init_settings={
            "string": "string",
        },
        is_ha_cluster=False,
        load_balancers=[{
            "endpoint_id": "string",
            "hostname": "string",
            "ip": "string",
            "name": "string",
            "port": 0,
        }],
        logs_policy={
            "max_age_retention": 0,
            "total_disk_retention": 0,
        },
        backup_same_region=False,
        disable_backup=False,
        password="string",
        private_network={
            "pn_id": "string",
            "enable_ipam": False,
            "endpoint_id": "string",
            "hostname": "string",
            "ip": "string",
            "ip_net": "string",
            "name": "string",
            "port": 0,
            "zone": "string",
        },
        project_id="string",
        region="string",
        settings={
            "string": "string",
        },
        tags=["string"],
        user_name="string",
        volume_size_in_gb=0,
        volume_type="string")
    
    const databaseInstanceResource = new scaleway.DatabaseInstance("databaseInstanceResource", {
        engine: "string",
        nodeType: "string",
        name: "string",
        backupScheduleFrequency: 0,
        encryptionAtRest: false,
        backupScheduleRetention: 0,
        initSettings: {
            string: "string",
        },
        isHaCluster: false,
        loadBalancers: [{
            endpointId: "string",
            hostname: "string",
            ip: "string",
            name: "string",
            port: 0,
        }],
        logsPolicy: {
            maxAgeRetention: 0,
            totalDiskRetention: 0,
        },
        backupSameRegion: false,
        disableBackup: false,
        password: "string",
        privateNetwork: {
            pnId: "string",
            enableIpam: false,
            endpointId: "string",
            hostname: "string",
            ip: "string",
            ipNet: "string",
            name: "string",
            port: 0,
            zone: "string",
        },
        projectId: "string",
        region: "string",
        settings: {
            string: "string",
        },
        tags: ["string"],
        userName: "string",
        volumeSizeInGb: 0,
        volumeType: "string",
    });
    
    type: scaleway:DatabaseInstance
    properties:
        backupSameRegion: false
        backupScheduleFrequency: 0
        backupScheduleRetention: 0
        disableBackup: false
        encryptionAtRest: false
        engine: string
        initSettings:
            string: string
        isHaCluster: false
        loadBalancers:
            - endpointId: string
              hostname: string
              ip: string
              name: string
              port: 0
        logsPolicy:
            maxAgeRetention: 0
            totalDiskRetention: 0
        name: string
        nodeType: string
        password: string
        privateNetwork:
            enableIpam: false
            endpointId: string
            hostname: string
            ip: string
            ipNet: string
            name: string
            pnId: string
            port: 0
            zone: string
        projectId: string
        region: string
        settings:
            string: string
        tags:
            - string
        userName: string
        volumeSizeInGb: 0
        volumeType: string
    

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.

    Important Once your Database 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 changes to your Database 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
    EncryptionAtRest bool
    Enable or disable encryption at rest for the Database Instance.
    InitSettings Dictionary<string, string>
    Map of engine settings to be set at database initialisation.
    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.
    LogsPolicy Pulumiverse.Scaleway.Inputs.DatabaseInstanceLogsPolicy
    Logs policy configuration
    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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

    VolumeType string
    Type of volume where data are stored (bssd, lssd, sbs_5k or sbs_15k).
    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.

    Important Once your Database 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 changes to your Database 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
    EncryptionAtRest bool
    Enable or disable encryption at rest for the Database Instance.
    InitSettings map[string]string
    Map of engine settings to be set at database initialisation.
    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.
    LogsPolicy DatabaseInstanceLogsPolicyArgs
    Logs policy configuration
    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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

    VolumeType string
    Type of volume where data are stored (bssd, lssd, sbs_5k or sbs_15k).
    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.

    Important Once your Database 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 changes to your Database 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
    encryptionAtRest Boolean
    Enable or disable encryption at rest for the Database Instance.
    initSettings Map<String,String>
    Map of engine settings to be set at database initialisation.
    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.
    logsPolicy DatabaseInstanceLogsPolicy
    Logs policy configuration
    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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

    volumeType String
    Type of volume where data are stored (bssd, lssd, sbs_5k or sbs_15k).
    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.

    Important Once your Database 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 changes to your Database 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
    encryptionAtRest boolean
    Enable or disable encryption at rest for the Database Instance.
    initSettings {[key: string]: string}
    Map of engine settings to be set at database initialisation.
    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.
    logsPolicy DatabaseInstanceLogsPolicy
    Logs policy configuration
    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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

    volumeType string
    Type of volume where data are stored (bssd, lssd, sbs_5k or sbs_15k).
    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.

    Important Once your Database 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 changes to your Database 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
    encryption_at_rest bool
    Enable or disable encryption at rest for the Database Instance.
    init_settings Mapping[str, str]
    Map of engine settings to be set at database initialisation.
    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.
    logs_policy DatabaseInstanceLogsPolicyArgs
    Logs policy configuration
    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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

    volume_type str
    Type of volume where data are stored (bssd, lssd, sbs_5k or sbs_15k).
    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.

    Important Once your Database 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 changes to your Database 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
    encryptionAtRest Boolean
    Enable or disable encryption at rest for the Database Instance.
    initSettings Map<String>
    Map of engine settings to be set at database initialisation.
    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.
    logsPolicy Property Map
    Logs policy configuration
    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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

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

    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. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    EndpointPort int
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    EndpointPort int
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    endpointPort Integer
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    endpointPort number
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    endpoint_port int
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    endpointPort Number
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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,
            encryption_at_rest: 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,
            logs_policy: Optional[DatabaseInstanceLogsPolicyArgs] = 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
    EncryptionAtRest bool
    Enable or disable encryption at rest for the Database Instance.
    EndpointIp string
    (Deprecated) The IP of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    EndpointPort int
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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.
    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.
    LogsPolicy Pulumiverse.Scaleway.Inputs.DatabaseInstanceLogsPolicy
    Logs policy configuration
    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.

    Important Once your Database 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 changes to your Database 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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

    VolumeType string
    Type of volume where data are stored (bssd, lssd, sbs_5k or sbs_15k).
    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
    EncryptionAtRest bool
    Enable or disable encryption at rest for the Database Instance.
    EndpointIp string
    (Deprecated) The IP of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    EndpointPort int
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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.
    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.
    LogsPolicy DatabaseInstanceLogsPolicyArgs
    Logs policy configuration
    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.

    Important Once your Database 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 changes to your Database 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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

    VolumeType string
    Type of volume where data are stored (bssd, lssd, sbs_5k or sbs_15k).
    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
    encryptionAtRest Boolean
    Enable or disable encryption at rest for the Database Instance.
    endpointIp String
    (Deprecated) The IP of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    endpointPort Integer
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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.
    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.
    logsPolicy DatabaseInstanceLogsPolicy
    Logs policy configuration
    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.

    Important Once your Database 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 changes to your Database 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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

    volumeType String
    Type of volume where data are stored (bssd, lssd, sbs_5k or sbs_15k).
    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
    encryptionAtRest boolean
    Enable or disable encryption at rest for the Database Instance.
    endpointIp string
    (Deprecated) The IP of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    endpointPort number
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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.
    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.
    logsPolicy DatabaseInstanceLogsPolicy
    Logs policy configuration
    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.

    Important Once your Database 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 changes to your Database 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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

    volumeType string
    Type of volume where data are stored (bssd, lssd, sbs_5k or sbs_15k).
    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
    encryption_at_rest bool
    Enable or disable encryption at rest for the Database Instance.
    endpoint_ip str
    (Deprecated) The IP of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    endpoint_port int
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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.
    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.
    logs_policy DatabaseInstanceLogsPolicyArgs
    Logs policy configuration
    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.

    Important Once your Database 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 changes to your Database 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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

    volume_type str
    Type of volume where data are stored (bssd, lssd, sbs_5k or sbs_15k).
    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
    encryptionAtRest Boolean
    Enable or disable encryption at rest for the Database Instance.
    endpointIp String
    (Deprecated) The IP of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    endpointPort Number
    (Deprecated) The port of the Database Instance. Please use the private_network or the load_balancer attribute.

    Deprecated: Please use the private_network or the load_balancer attribute

    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.
    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.
    logsPolicy Property Map
    Logs policy configuration
    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.

    Important Once your Database 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 changes to your Database 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 on a running instance.
    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 Database Instance reaches disk_full status, you should increase the volume size before making any other change to your Database Instance.

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

    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.

    DatabaseInstanceLogsPolicy, DatabaseInstanceLogsPolicyArgs

    MaxAgeRetention int
    The max age (in days) of remote logs to keep on the Database Instance
    TotalDiskRetention int
    The max disk size of remote logs to keep on the Database Instance.
    MaxAgeRetention int
    The max age (in days) of remote logs to keep on the Database Instance
    TotalDiskRetention int
    The max disk size of remote logs to keep on the Database Instance.
    maxAgeRetention Integer
    The max age (in days) of remote logs to keep on the Database Instance
    totalDiskRetention Integer
    The max disk size of remote logs to keep on the Database Instance.
    maxAgeRetention number
    The max age (in days) of remote logs to keep on the Database Instance
    totalDiskRetention number
    The max disk size of remote logs to keep on the Database Instance.
    max_age_retention int
    The max age (in days) of remote logs to keep on the Database Instance
    total_disk_retention int
    The max disk size of remote logs to keep on the Database Instance.
    maxAgeRetention Number
    The max age (in days) of remote logs to keep on the Database Instance
    totalDiskRetention Number
    The max disk size of remote logs to keep on the Database Instance.

    DatabaseInstancePrivateNetwork, DatabaseInstancePrivateNetworkArgs

    PnId string
    The private network ID
    EnableIpam bool
    Whether or not the private network endpoint should be configured with IPAM
    EndpointId string
    The ID of the endpoint.
    Hostname string
    Hostname of the endpoint.
    Ip string
    IPv4 address on the network.
    IpNet string
    The IP with the given mask within the private subnet
    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 private network ID
    EnableIpam bool
    Whether or not the private network endpoint should be configured with IPAM
    EndpointId string
    The ID of the endpoint.
    Hostname string
    Hostname of the endpoint.
    Ip string
    IPv4 address on the network.
    IpNet string
    The IP with the given mask within the private subnet
    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 private network ID
    enableIpam Boolean
    Whether or not the private network endpoint should be configured with IPAM
    endpointId String
    The ID of the endpoint.
    hostname String
    Hostname of the endpoint.
    ip String
    IPv4 address on the network.
    ipNet String
    The IP with the given mask within the private subnet
    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 private network ID
    enableIpam boolean
    Whether or not the private network endpoint should be configured with IPAM
    endpointId string
    The ID of the endpoint.
    hostname string
    Hostname of the endpoint.
    ip string
    IPv4 address on the network.
    ipNet string
    The IP with the given mask within the private subnet
    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 private network ID
    enable_ipam bool
    Whether or not the private network endpoint should be configured with IPAM
    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 with the given mask within the private subnet
    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 private network ID
    enableIpam Boolean
    Whether or not the private network endpoint should be configured with IPAM
    endpointId String
    The ID of the endpoint.
    hostname String
    Hostname of the endpoint.
    ip String
    IPv4 address on the network.
    ipNet String
    The IP with the given mask within the private subnet
    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
    

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

    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.20.0 published on Monday, Nov 4, 2024 by pulumiverse