scaleway.DatabaseInstance
Explore with Pulumi AI
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.- Node
Type 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- Backup
Same boolRegion - Boolean to store logical backups in the same region as the database instance.
- Backup
Schedule intFrequency - Backup schedule frequency in hours.
- Backup
Schedule intRetention - Backup schedule retention in days.
- Disable
Backup bool - Disable automated backup for the database instance.
- Init
Settings 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
andinit_settings
for thenode_type
of your convenience.- Is
Ha boolCluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- Load
Balancers List<Pulumiverse.Scaleway. Inputs. Database Instance Load Balancer> - 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.
- Private
Network Pulumiverse.Scaleway. Inputs. Database Instance Private Network - List of private networks endpoints of the database instance.
- Project
Id 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.
- List<string>
- The tags associated with the Database Instance.
- User
Name string Identifier for the first user of the database instance.
Important: Updates to
user_name
will recreate the Database Instance.- Volume
Size intIn Gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.Important: Once your instance reaches
disk_full
status, you should increase the volume size before making any other change to your instance.- Volume
Type string - Type of volume where data are stored (
bssd
,lssd
orsbs_5k
).
- Engine string
Database Instance's engine version (e.g.
PostgreSQL-11
).Important: Updates to
engine
will recreate the Database Instance.- Node
Type 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- Backup
Same boolRegion - Boolean to store logical backups in the same region as the database instance.
- Backup
Schedule intFrequency - Backup schedule frequency in hours.
- Backup
Schedule intRetention - Backup schedule retention in days.
- Disable
Backup bool - Disable automated backup for the database instance.
- Init
Settings 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
andinit_settings
for thenode_type
of your convenience.- Is
Ha boolCluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- Load
Balancers []DatabaseInstance Load Balancer Args - 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.
- Private
Network DatabaseInstance Private Network Args - List of private networks endpoints of the database instance.
- Project
Id 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.
- []string
- The tags associated with the Database Instance.
- User
Name string Identifier for the first user of the database instance.
Important: Updates to
user_name
will recreate the Database Instance.- Volume
Size intIn Gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.Important: Once your instance reaches
disk_full
status, you should increase the volume size before making any other change to your instance.- Volume
Type string - Type of volume where data are stored (
bssd
,lssd
orsbs_5k
).
- engine String
Database Instance's engine version (e.g.
PostgreSQL-11
).Important: Updates to
engine
will recreate the Database Instance.- node
Type 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- backup
Same BooleanRegion - Boolean to store logical backups in the same region as the database instance.
- backup
Schedule IntegerFrequency - Backup schedule frequency in hours.
- backup
Schedule IntegerRetention - Backup schedule retention in days.
- disable
Backup Boolean - Disable automated backup for the database instance.
- init
Settings 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
andinit_settings
for thenode_type
of your convenience.- is
Ha BooleanCluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- load
Balancers List<DatabaseInstance Load Balancer> - 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.
- private
Network DatabaseInstance Private Network - List of private networks endpoints of the database instance.
- project
Id 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.
- List<String>
- The tags associated with the Database Instance.
- user
Name String Identifier for the first user of the database instance.
Important: Updates to
user_name
will recreate the Database Instance.- volume
Size IntegerIn Gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.Important: Once your instance reaches
disk_full
status, you should increase the volume size before making any other change to your instance.- volume
Type String - Type of volume where data are stored (
bssd
,lssd
orsbs_5k
).
- engine string
Database Instance's engine version (e.g.
PostgreSQL-11
).Important: Updates to
engine
will recreate the Database Instance.- node
Type 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- backup
Same booleanRegion - Boolean to store logical backups in the same region as the database instance.
- backup
Schedule numberFrequency - Backup schedule frequency in hours.
- backup
Schedule numberRetention - Backup schedule retention in days.
- disable
Backup boolean - Disable automated backup for the database instance.
- init
Settings {[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
andinit_settings
for thenode_type
of your convenience.- is
Ha booleanCluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- load
Balancers DatabaseInstance Load Balancer[] - 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.
- private
Network DatabaseInstance Private Network - List of private networks endpoints of the database instance.
- project
Id 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.
- string[]
- The tags associated with the Database Instance.
- user
Name string Identifier for the first user of the database instance.
Important: Updates to
user_name
will recreate the Database Instance.- volume
Size numberIn Gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.Important: Once your instance reaches
disk_full
status, you should increase the volume size before making any other change to your instance.- volume
Type string - Type of volume where data are stored (
bssd
,lssd
orsbs_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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- backup_
same_ boolregion - Boolean to store logical backups in the same region as the database instance.
- backup_
schedule_ intfrequency - Backup schedule frequency in hours.
- backup_
schedule_ intretention - 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
andinit_settings
for thenode_type
of your convenience.- is_
ha_ boolcluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- load_
balancers Sequence[DatabaseInstance Load Balancer Args] - 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 DatabaseInstance Private Network Args - 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.
- 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_ intin_ gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.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
orsbs_5k
).
- engine String
Database Instance's engine version (e.g.
PostgreSQL-11
).Important: Updates to
engine
will recreate the Database Instance.- node
Type 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- backup
Same BooleanRegion - Boolean to store logical backups in the same region as the database instance.
- backup
Schedule NumberFrequency - Backup schedule frequency in hours.
- backup
Schedule NumberRetention - Backup schedule retention in days.
- disable
Backup Boolean - Disable automated backup for the database instance.
- init
Settings 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
andinit_settings
for thenode_type
of your convenience.- is
Ha BooleanCluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- load
Balancers 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.
- private
Network Property Map - List of private networks endpoints of the database instance.
- project
Id 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.
- List<String>
- The tags associated with the Database Instance.
- user
Name String Identifier for the first user of the database instance.
Important: Updates to
user_name
will recreate the Database Instance.- volume
Size NumberIn Gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.Important: Once your instance reaches
disk_full
status, you should increase the volume size before making any other change to your instance.- volume
Type String - Type of volume where data are stored (
bssd
,lssd
orsbs_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.
- Endpoint
Ip string - (Deprecated) The IP of the Database Instance.
- Endpoint
Port int - (Deprecated) The port of the Database Instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Organization
Id string - The organization ID the Database Instance is associated with.
- Read
Replicas List<Pulumiverse.Scaleway. Outputs. Database Instance Read Replica> - List of read replicas of the database instance.
- Certificate string
- Certificate of the database instance.
- Endpoint
Ip string - (Deprecated) The IP of the Database Instance.
- Endpoint
Port int - (Deprecated) The port of the Database Instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Organization
Id string - The organization ID the Database Instance is associated with.
- Read
Replicas []DatabaseInstance Read Replica - List of read replicas of the database instance.
- certificate String
- Certificate of the database instance.
- endpoint
Ip String - (Deprecated) The IP of the Database Instance.
- endpoint
Port Integer - (Deprecated) The port of the Database Instance.
- id String
- The provider-assigned unique ID for this managed resource.
- organization
Id String - The organization ID the Database Instance is associated with.
- read
Replicas List<DatabaseInstance Read Replica> - List of read replicas of the database instance.
- certificate string
- Certificate of the database instance.
- endpoint
Ip string - (Deprecated) The IP of the Database Instance.
- endpoint
Port number - (Deprecated) The port of the Database Instance.
- id string
- The provider-assigned unique ID for this managed resource.
- organization
Id string - The organization ID the Database Instance is associated with.
- read
Replicas DatabaseInstance Read Replica[] - 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.
- 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[DatabaseInstance Read Replica] - List of read replicas of the database instance.
- certificate String
- Certificate of the database instance.
- endpoint
Ip String - (Deprecated) The IP of the Database Instance.
- endpoint
Port Number - (Deprecated) The port of the Database Instance.
- id String
- The provider-assigned unique ID for this managed resource.
- organization
Id String - The organization ID the Database Instance is associated with.
- read
Replicas 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.
- Backup
Same boolRegion - Boolean to store logical backups in the same region as the database instance.
- Backup
Schedule intFrequency - Backup schedule frequency in hours.
- Backup
Schedule intRetention - Backup schedule retention in days.
- Certificate string
- Certificate of the database instance.
- Disable
Backup bool - Disable automated backup for the database instance.
- Endpoint
Ip string - (Deprecated) The IP of the Database Instance.
- Endpoint
Port 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.- Init
Settings 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
andinit_settings
for thenode_type
of your convenience.- Is
Ha boolCluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- Load
Balancers List<Pulumiverse.Scaleway. Inputs. Database Instance Load Balancer> - 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.
- Node
Type 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- Organization
Id string - The organization ID the Database Instance is associated with.
- Password string
- Password for the first user of the database instance.
- Private
Network Pulumiverse.Scaleway. Inputs. Database Instance Private Network - List of private networks endpoints of the database instance.
- Project
Id string project_id
) The ID of the project the Database Instance is associated with.- Read
Replicas List<Pulumiverse.Scaleway. Inputs. Database Instance Read Replica> - 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.
- List<string>
- The tags associated with the Database Instance.
- User
Name string Identifier for the first user of the database instance.
Important: Updates to
user_name
will recreate the Database Instance.- Volume
Size intIn Gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.Important: Once your instance reaches
disk_full
status, you should increase the volume size before making any other change to your instance.- Volume
Type string - Type of volume where data are stored (
bssd
,lssd
orsbs_5k
).
- Backup
Same boolRegion - Boolean to store logical backups in the same region as the database instance.
- Backup
Schedule intFrequency - Backup schedule frequency in hours.
- Backup
Schedule intRetention - Backup schedule retention in days.
- Certificate string
- Certificate of the database instance.
- Disable
Backup bool - Disable automated backup for the database instance.
- Endpoint
Ip string - (Deprecated) The IP of the Database Instance.
- Endpoint
Port 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.- Init
Settings 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
andinit_settings
for thenode_type
of your convenience.- Is
Ha boolCluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- Load
Balancers []DatabaseInstance Load Balancer Args - 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.
- Node
Type 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- Organization
Id string - The organization ID the Database Instance is associated with.
- Password string
- Password for the first user of the database instance.
- Private
Network DatabaseInstance Private Network Args - List of private networks endpoints of the database instance.
- Project
Id string project_id
) The ID of the project the Database Instance is associated with.- Read
Replicas []DatabaseInstance Read Replica Args - 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.
- []string
- The tags associated with the Database Instance.
- User
Name string Identifier for the first user of the database instance.
Important: Updates to
user_name
will recreate the Database Instance.- Volume
Size intIn Gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.Important: Once your instance reaches
disk_full
status, you should increase the volume size before making any other change to your instance.- Volume
Type string - Type of volume where data are stored (
bssd
,lssd
orsbs_5k
).
- backup
Same BooleanRegion - Boolean to store logical backups in the same region as the database instance.
- backup
Schedule IntegerFrequency - Backup schedule frequency in hours.
- backup
Schedule IntegerRetention - Backup schedule retention in days.
- certificate String
- Certificate of the database instance.
- disable
Backup Boolean - Disable automated backup for the database instance.
- endpoint
Ip String - (Deprecated) The IP of the Database Instance.
- endpoint
Port 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.- init
Settings 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
andinit_settings
for thenode_type
of your convenience.- is
Ha BooleanCluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- load
Balancers List<DatabaseInstance Load Balancer> - 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.
- node
Type 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- organization
Id String - The organization ID the Database Instance is associated with.
- password String
- Password for the first user of the database instance.
- private
Network DatabaseInstance Private Network - List of private networks endpoints of the database instance.
- project
Id String project_id
) The ID of the project the Database Instance is associated with.- read
Replicas List<DatabaseInstance Read Replica> - 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.
- List<String>
- The tags associated with the Database Instance.
- user
Name String Identifier for the first user of the database instance.
Important: Updates to
user_name
will recreate the Database Instance.- volume
Size IntegerIn Gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.Important: Once your instance reaches
disk_full
status, you should increase the volume size before making any other change to your instance.- volume
Type String - Type of volume where data are stored (
bssd
,lssd
orsbs_5k
).
- backup
Same booleanRegion - Boolean to store logical backups in the same region as the database instance.
- backup
Schedule numberFrequency - Backup schedule frequency in hours.
- backup
Schedule numberRetention - Backup schedule retention in days.
- certificate string
- Certificate of the database instance.
- disable
Backup boolean - Disable automated backup for the database instance.
- endpoint
Ip string - (Deprecated) The IP of the Database Instance.
- endpoint
Port 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.- init
Settings {[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
andinit_settings
for thenode_type
of your convenience.- is
Ha booleanCluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- load
Balancers DatabaseInstance Load Balancer[] - 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.
- node
Type 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- organization
Id string - The organization ID the Database Instance is associated with.
- password string
- Password for the first user of the database instance.
- private
Network DatabaseInstance Private Network - List of private networks endpoints of the database instance.
- project
Id string project_id
) The ID of the project the Database Instance is associated with.- read
Replicas DatabaseInstance Read Replica[] - 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.
- string[]
- The tags associated with the Database Instance.
- user
Name string Identifier for the first user of the database instance.
Important: Updates to
user_name
will recreate the Database Instance.- volume
Size numberIn Gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.Important: Once your instance reaches
disk_full
status, you should increase the volume size before making any other change to your instance.- volume
Type string - Type of volume where data are stored (
bssd
,lssd
orsbs_5k
).
- backup_
same_ boolregion - Boolean to store logical backups in the same region as the database instance.
- backup_
schedule_ intfrequency - Backup schedule frequency in hours.
- backup_
schedule_ intretention - 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.
- 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
andinit_settings
for thenode_type
of your convenience.- is_
ha_ boolcluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- load_
balancers Sequence[DatabaseInstance Load Balancer Args] - 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
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 DatabaseInstance Private Network Args - 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[DatabaseInstance Read Replica Args] - 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.
- 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_ intin_ gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.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
orsbs_5k
).
- backup
Same BooleanRegion - Boolean to store logical backups in the same region as the database instance.
- backup
Schedule NumberFrequency - Backup schedule frequency in hours.
- backup
Schedule NumberRetention - Backup schedule retention in days.
- certificate String
- Certificate of the database instance.
- disable
Backup Boolean - Disable automated backup for the database instance.
- endpoint
Ip String - (Deprecated) The IP of the Database Instance.
- endpoint
Port 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.- init
Settings 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
andinit_settings
for thenode_type
of your convenience.- is
Ha BooleanCluster Enable or disable high availability for the database instance.
Important: Updates to
is_ha_cluster
will recreate the Database Instance.- load
Balancers 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.
- node
Type 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 desirednode_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 usinglssd
storage, you should upgrade the node_type, and if you are usingbssd
storage, you should increase the volume size before making any other change to your instance.- organization
Id String - The organization ID the Database Instance is associated with.
- password String
- Password for the first user of the database instance.
- private
Network Property Map - List of private networks endpoints of the database instance.
- project
Id String project_id
) The ID of the project the Database Instance is associated with.- read
Replicas 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.
- List<String>
- The tags associated with the Database Instance.
- user
Name String Identifier for the first user of the database instance.
Important: Updates to
user_name
will recreate the Database Instance.- volume
Size NumberIn Gb Volume size (in GB). Cannot be used when
volume_type
is set tolssd
.Important: Once your instance reaches
disk_full
status, you should increase the volume size before making any other change to your instance.- volume
Type String - Type of volume where data are stored (
bssd
,lssd
orsbs_5k
).
Supporting Types
DatabaseInstanceLoadBalancer, DatabaseInstanceLoadBalancerArgs
- Endpoint
Id 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.
- Endpoint
Id 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.
- endpoint
Id 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.
- endpoint
Id 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.
- endpoint
Id 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
- Pn
Id string - 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 string - The ID of the endpoint.
- Hostname string
- Hostname of the endpoint.
- Ip string
- IPv4 address on the network.
- Ip
Net 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
- Pn
Id string - 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 string - The ID of the endpoint.
- Hostname string
- Hostname of the endpoint.
- Ip string
- IPv4 address on the network.
- Ip
Net 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
- pn
Id String - The ID of the private network.
- enable
Ipam 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- endpoint
Id String - The ID of the endpoint.
- hostname String
- Hostname of the endpoint.
- ip String
- IPv4 address on the network.
- ip
Net 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
- pn
Id string - The ID of the private network.
- enable
Ipam 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- endpoint
Id string - The ID of the endpoint.
- hostname string
- Hostname of the endpoint.
- ip string
- IPv4 address on the network.
- ip
Net 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
- pn
Id String - The ID of the private network.
- enable
Ipam 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- endpoint
Id String - The ID of the endpoint.
- hostname String
- Hostname of the endpoint.
- ip String
- IPv4 address on the network.
- ip
Net 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
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.