Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. DatabaseReadReplica
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.DatabaseReadReplica

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway
Deprecated: scaleway.index/databasereadreplica.DatabaseReadReplica has been deprecated in favor of scaleway.databases/readreplica.ReadReplica

Creates and manages Read Replicas. For more information refer to the API documentation.

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const instance = new scaleway.databases.Instance("instance", {
    name: "test-rdb-rr-update",
    nodeType: "db-dev-s",
    engine: "PostgreSQL-14",
    isHaCluster: false,
    disableBackup: true,
    userName: "my_initial_user",
    password: "thiZ_is_v&ry_s3cret",
    tags: [
        "terraform-test",
        "scaleway_rdb_read_replica",
        "minimal",
    ],
});
const replica = new scaleway.databases.ReadReplica("replica", {
    instanceId: instance.id,
    directAccess: {},
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

instance = scaleway.databases.Instance("instance",
    name="test-rdb-rr-update",
    node_type="db-dev-s",
    engine="PostgreSQL-14",
    is_ha_cluster=False,
    disable_backup=True,
    user_name="my_initial_user",
    password="thiZ_is_v&ry_s3cret",
    tags=[
        "terraform-test",
        "scaleway_rdb_read_replica",
        "minimal",
    ])
replica = scaleway.databases.ReadReplica("replica",
    instance_id=instance.id,
    direct_access={})
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/databases"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := databases.NewInstance(ctx, "instance", &databases.InstanceArgs{
			Name:          pulumi.String("test-rdb-rr-update"),
			NodeType:      pulumi.String("db-dev-s"),
			Engine:        pulumi.String("PostgreSQL-14"),
			IsHaCluster:   pulumi.Bool(false),
			DisableBackup: pulumi.Bool(true),
			UserName:      pulumi.String("my_initial_user"),
			Password:      pulumi.String("thiZ_is_v&ry_s3cret"),
			Tags: pulumi.StringArray{
				pulumi.String("terraform-test"),
				pulumi.String("scaleway_rdb_read_replica"),
				pulumi.String("minimal"),
			},
		})
		if err != nil {
			return err
		}
		_, err = databases.NewReadReplica(ctx, "replica", &databases.ReadReplicaArgs{
			InstanceId:   instance.ID(),
			DirectAccess: &databases.ReadReplicaDirectAccessArgs{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var instance = new Scaleway.Databases.Instance("instance", new()
    {
        Name = "test-rdb-rr-update",
        NodeType = "db-dev-s",
        Engine = "PostgreSQL-14",
        IsHaCluster = false,
        DisableBackup = true,
        UserName = "my_initial_user",
        Password = "thiZ_is_v&ry_s3cret",
        Tags = new[]
        {
            "terraform-test",
            "scaleway_rdb_read_replica",
            "minimal",
        },
    });

    var replica = new Scaleway.Databases.ReadReplica("replica", new()
    {
        InstanceId = instance.Id,
        DirectAccess = null,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.databases.Instance;
import com.pulumi.scaleway.databases.InstanceArgs;
import com.pulumi.scaleway.databases.ReadReplica;
import com.pulumi.scaleway.databases.ReadReplicaArgs;
import com.pulumi.scaleway.databases.inputs.ReadReplicaDirectAccessArgs;
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 instance = new Instance("instance", InstanceArgs.builder()
            .name("test-rdb-rr-update")
            .nodeType("db-dev-s")
            .engine("PostgreSQL-14")
            .isHaCluster(false)
            .disableBackup(true)
            .userName("my_initial_user")
            .password("thiZ_is_v&ry_s3cret")
            .tags(            
                "terraform-test",
                "scaleway_rdb_read_replica",
                "minimal")
            .build());

        var replica = new ReadReplica("replica", ReadReplicaArgs.builder()
            .instanceId(instance.id())
            .directAccess()
            .build());

    }
}
Copy
resources:
  instance:
    type: scaleway:databases:Instance
    properties:
      name: test-rdb-rr-update
      nodeType: db-dev-s
      engine: PostgreSQL-14
      isHaCluster: false
      disableBackup: true
      userName: my_initial_user
      password: thiZ_is_v&ry_s3cret
      tags:
        - terraform-test
        - scaleway_rdb_read_replica
        - minimal
  replica:
    type: scaleway:databases:ReadReplica
    properties:
      instanceId: ${instance.id}
      directAccess: {}
Copy

Private network with static endpoint

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const instance = new scaleway.databases.Instance("instance", {
    name: "rdb_instance",
    nodeType: "db-dev-s",
    engine: "PostgreSQL-14",
    isHaCluster: false,
    disableBackup: true,
    userName: "my_initial_user",
    password: "thiZ_is_v&ry_s3cret",
});
const pn = new scaleway.network.PrivateNetwork("pn", {});
const replica = new scaleway.databases.ReadReplica("replica", {
    instanceId: instance.id,
    privateNetwork: {
        privateNetworkId: pn.id,
        serviceIp: "192.168.1.254/24",
    },
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

instance = scaleway.databases.Instance("instance",
    name="rdb_instance",
    node_type="db-dev-s",
    engine="PostgreSQL-14",
    is_ha_cluster=False,
    disable_backup=True,
    user_name="my_initial_user",
    password="thiZ_is_v&ry_s3cret")
pn = scaleway.network.PrivateNetwork("pn")
replica = scaleway.databases.ReadReplica("replica",
    instance_id=instance.id,
    private_network={
        "private_network_id": pn.id,
        "service_ip": "192.168.1.254/24",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/databases"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/network"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := databases.NewInstance(ctx, "instance", &databases.InstanceArgs{
			Name:          pulumi.String("rdb_instance"),
			NodeType:      pulumi.String("db-dev-s"),
			Engine:        pulumi.String("PostgreSQL-14"),
			IsHaCluster:   pulumi.Bool(false),
			DisableBackup: pulumi.Bool(true),
			UserName:      pulumi.String("my_initial_user"),
			Password:      pulumi.String("thiZ_is_v&ry_s3cret"),
		})
		if err != nil {
			return err
		}
		pn, err := network.NewPrivateNetwork(ctx, "pn", nil)
		if err != nil {
			return err
		}
		_, err = databases.NewReadReplica(ctx, "replica", &databases.ReadReplicaArgs{
			InstanceId: instance.ID(),
			PrivateNetwork: &databases.ReadReplicaPrivateNetworkArgs{
				PrivateNetworkId: pn.ID(),
				ServiceIp:        pulumi.String("192.168.1.254/24"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var instance = new Scaleway.Databases.Instance("instance", new()
    {
        Name = "rdb_instance",
        NodeType = "db-dev-s",
        Engine = "PostgreSQL-14",
        IsHaCluster = false,
        DisableBackup = true,
        UserName = "my_initial_user",
        Password = "thiZ_is_v&ry_s3cret",
    });

    var pn = new Scaleway.Network.PrivateNetwork("pn");

    var replica = new Scaleway.Databases.ReadReplica("replica", new()
    {
        InstanceId = instance.Id,
        PrivateNetwork = new Scaleway.Databases.Inputs.ReadReplicaPrivateNetworkArgs
        {
            PrivateNetworkId = pn.Id,
            ServiceIp = "192.168.1.254/24",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.databases.Instance;
import com.pulumi.scaleway.databases.InstanceArgs;
import com.pulumi.scaleway.network.PrivateNetwork;
import com.pulumi.scaleway.databases.ReadReplica;
import com.pulumi.scaleway.databases.ReadReplicaArgs;
import com.pulumi.scaleway.databases.inputs.ReadReplicaPrivateNetworkArgs;
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 instance = new Instance("instance", InstanceArgs.builder()
            .name("rdb_instance")
            .nodeType("db-dev-s")
            .engine("PostgreSQL-14")
            .isHaCluster(false)
            .disableBackup(true)
            .userName("my_initial_user")
            .password("thiZ_is_v&ry_s3cret")
            .build());

        var pn = new PrivateNetwork("pn");

        var replica = new ReadReplica("replica", ReadReplicaArgs.builder()
            .instanceId(instance.id())
            .privateNetwork(ReadReplicaPrivateNetworkArgs.builder()
                .privateNetworkId(pn.id())
                .serviceIp("192.168.1.254/24")
                .build())
            .build());

    }
}
Copy
resources:
  instance:
    type: scaleway:databases:Instance
    properties:
      name: rdb_instance
      nodeType: db-dev-s
      engine: PostgreSQL-14
      isHaCluster: false
      disableBackup: true
      userName: my_initial_user
      password: thiZ_is_v&ry_s3cret
  pn:
    type: scaleway:network:PrivateNetwork
  replica:
    type: scaleway:databases:ReadReplica
    properties:
      instanceId: ${instance.id}
      privateNetwork:
        privateNetworkId: ${pn.id}
        serviceIp: 192.168.1.254/24
Copy

Private network with IPAM

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const instance = new scaleway.databases.Instance("instance", {
    name: "rdb_instance",
    nodeType: "db-dev-s",
    engine: "PostgreSQL-14",
    isHaCluster: false,
    disableBackup: true,
    userName: "my_initial_user",
    password: "thiZ_is_v&ry_s3cret",
});
const pn = new scaleway.network.PrivateNetwork("pn", {});
const replica = new scaleway.databases.ReadReplica("replica", {
    instanceId: instance.id,
    privateNetwork: {
        privateNetworkId: pn.id,
        enableIpam: true,
    },
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

instance = scaleway.databases.Instance("instance",
    name="rdb_instance",
    node_type="db-dev-s",
    engine="PostgreSQL-14",
    is_ha_cluster=False,
    disable_backup=True,
    user_name="my_initial_user",
    password="thiZ_is_v&ry_s3cret")
pn = scaleway.network.PrivateNetwork("pn")
replica = scaleway.databases.ReadReplica("replica",
    instance_id=instance.id,
    private_network={
        "private_network_id": pn.id,
        "enable_ipam": True,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/databases"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/network"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := databases.NewInstance(ctx, "instance", &databases.InstanceArgs{
			Name:          pulumi.String("rdb_instance"),
			NodeType:      pulumi.String("db-dev-s"),
			Engine:        pulumi.String("PostgreSQL-14"),
			IsHaCluster:   pulumi.Bool(false),
			DisableBackup: pulumi.Bool(true),
			UserName:      pulumi.String("my_initial_user"),
			Password:      pulumi.String("thiZ_is_v&ry_s3cret"),
		})
		if err != nil {
			return err
		}
		pn, err := network.NewPrivateNetwork(ctx, "pn", nil)
		if err != nil {
			return err
		}
		_, err = databases.NewReadReplica(ctx, "replica", &databases.ReadReplicaArgs{
			InstanceId: instance.ID(),
			PrivateNetwork: &databases.ReadReplicaPrivateNetworkArgs{
				PrivateNetworkId: pn.ID(),
				EnableIpam:       pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var instance = new Scaleway.Databases.Instance("instance", new()
    {
        Name = "rdb_instance",
        NodeType = "db-dev-s",
        Engine = "PostgreSQL-14",
        IsHaCluster = false,
        DisableBackup = true,
        UserName = "my_initial_user",
        Password = "thiZ_is_v&ry_s3cret",
    });

    var pn = new Scaleway.Network.PrivateNetwork("pn");

    var replica = new Scaleway.Databases.ReadReplica("replica", new()
    {
        InstanceId = instance.Id,
        PrivateNetwork = new Scaleway.Databases.Inputs.ReadReplicaPrivateNetworkArgs
        {
            PrivateNetworkId = pn.Id,
            EnableIpam = true,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.databases.Instance;
import com.pulumi.scaleway.databases.InstanceArgs;
import com.pulumi.scaleway.network.PrivateNetwork;
import com.pulumi.scaleway.databases.ReadReplica;
import com.pulumi.scaleway.databases.ReadReplicaArgs;
import com.pulumi.scaleway.databases.inputs.ReadReplicaPrivateNetworkArgs;
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 instance = new Instance("instance", InstanceArgs.builder()
            .name("rdb_instance")
            .nodeType("db-dev-s")
            .engine("PostgreSQL-14")
            .isHaCluster(false)
            .disableBackup(true)
            .userName("my_initial_user")
            .password("thiZ_is_v&ry_s3cret")
            .build());

        var pn = new PrivateNetwork("pn");

        var replica = new ReadReplica("replica", ReadReplicaArgs.builder()
            .instanceId(instance.id())
            .privateNetwork(ReadReplicaPrivateNetworkArgs.builder()
                .privateNetworkId(pn.id())
                .enableIpam(true)
                .build())
            .build());

    }
}
Copy
resources:
  instance:
    type: scaleway:databases:Instance
    properties:
      name: rdb_instance
      nodeType: db-dev-s
      engine: PostgreSQL-14
      isHaCluster: false
      disableBackup: true
      userName: my_initial_user
      password: thiZ_is_v&ry_s3cret
  pn:
    type: scaleway:network:PrivateNetwork
  replica:
    type: scaleway:databases:ReadReplica
    properties:
      instanceId: ${instance.id}
      privateNetwork:
        privateNetworkId: ${pn.id}
        enableIpam: true
Copy

Create DatabaseReadReplica Resource

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

Constructor syntax

new DatabaseReadReplica(name: string, args: DatabaseReadReplicaArgs, opts?: CustomResourceOptions);
@overload
def DatabaseReadReplica(resource_name: str,
                        args: DatabaseReadReplicaArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def DatabaseReadReplica(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        direct_access: Optional[DatabaseReadReplicaDirectAccessArgs] = None,
                        instance_id: Optional[str] = None,
                        private_network: Optional[DatabaseReadReplicaPrivateNetworkArgs] = None,
                        region: Optional[str] = None,
                        same_zone: Optional[bool] = None)
func NewDatabaseReadReplica(ctx *Context, name string, args DatabaseReadReplicaArgs, opts ...ResourceOption) (*DatabaseReadReplica, error)
public DatabaseReadReplica(string name, DatabaseReadReplicaArgs args, CustomResourceOptions? opts = null)
public DatabaseReadReplica(String name, DatabaseReadReplicaArgs args)
public DatabaseReadReplica(String name, DatabaseReadReplicaArgs args, CustomResourceOptions options)

type: scaleway:DatabaseReadReplica
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DatabaseReadReplicaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DatabaseReadReplicaArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseReadReplicaArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseReadReplicaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DatabaseReadReplicaArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

InstanceId This property is required. string

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

DirectAccess Pulumiverse.Scaleway.Inputs.DatabaseReadReplicaDirectAccess
Creates a direct access endpoint to rdb replica.
PrivateNetwork Pulumiverse.Scaleway.Inputs.DatabaseReadReplicaPrivateNetwork
Create an endpoint in a Private Netork.
Region Changes to this property will trigger replacement. string
region) The region in which the Read Replica should be created.
SameZone Changes to this property will trigger replacement. bool
Defines whether to create the replica in the same availability zone as the main instance nodes or not.
InstanceId This property is required. string

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

DirectAccess DatabaseReadReplicaDirectAccessArgs
Creates a direct access endpoint to rdb replica.
PrivateNetwork DatabaseReadReplicaPrivateNetworkArgs
Create an endpoint in a Private Netork.
Region Changes to this property will trigger replacement. string
region) The region in which the Read Replica should be created.
SameZone Changes to this property will trigger replacement. bool
Defines whether to create the replica in the same availability zone as the main instance nodes or not.
instanceId This property is required. String

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

directAccess DatabaseReadReplicaDirectAccess
Creates a direct access endpoint to rdb replica.
privateNetwork DatabaseReadReplicaPrivateNetwork
Create an endpoint in a Private Netork.
region Changes to this property will trigger replacement. String
region) The region in which the Read Replica should be created.
sameZone Changes to this property will trigger replacement. Boolean
Defines whether to create the replica in the same availability zone as the main instance nodes or not.
instanceId This property is required. string

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

directAccess DatabaseReadReplicaDirectAccess
Creates a direct access endpoint to rdb replica.
privateNetwork DatabaseReadReplicaPrivateNetwork
Create an endpoint in a Private Netork.
region Changes to this property will trigger replacement. string
region) The region in which the Read Replica should be created.
sameZone Changes to this property will trigger replacement. boolean
Defines whether to create the replica in the same availability zone as the main instance nodes or not.
instance_id This property is required. str

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

direct_access DatabaseReadReplicaDirectAccessArgs
Creates a direct access endpoint to rdb replica.
private_network DatabaseReadReplicaPrivateNetworkArgs
Create an endpoint in a Private Netork.
region Changes to this property will trigger replacement. str
region) The region in which the Read Replica should be created.
same_zone Changes to this property will trigger replacement. bool
Defines whether to create the replica in the same availability zone as the main instance nodes or not.
instanceId This property is required. String

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

directAccess Property Map
Creates a direct access endpoint to rdb replica.
privateNetwork Property Map
Create an endpoint in a Private Netork.
region Changes to this property will trigger replacement. String
region) The region in which the Read Replica should be created.
sameZone Changes to this property will trigger replacement. Boolean
Defines whether to create the replica in the same availability zone as the main instance nodes or not.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing DatabaseReadReplica Resource

Get an existing DatabaseReadReplica 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?: DatabaseReadReplicaState, opts?: CustomResourceOptions): DatabaseReadReplica
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        direct_access: Optional[DatabaseReadReplicaDirectAccessArgs] = None,
        instance_id: Optional[str] = None,
        private_network: Optional[DatabaseReadReplicaPrivateNetworkArgs] = None,
        region: Optional[str] = None,
        same_zone: Optional[bool] = None) -> DatabaseReadReplica
func GetDatabaseReadReplica(ctx *Context, name string, id IDInput, state *DatabaseReadReplicaState, opts ...ResourceOption) (*DatabaseReadReplica, error)
public static DatabaseReadReplica Get(string name, Input<string> id, DatabaseReadReplicaState? state, CustomResourceOptions? opts = null)
public static DatabaseReadReplica get(String name, Output<String> id, DatabaseReadReplicaState state, CustomResourceOptions options)
resources:  _:    type: scaleway:DatabaseReadReplica    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DirectAccess Pulumiverse.Scaleway.Inputs.DatabaseReadReplicaDirectAccess
Creates a direct access endpoint to rdb replica.
InstanceId string

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

PrivateNetwork Pulumiverse.Scaleway.Inputs.DatabaseReadReplicaPrivateNetwork
Create an endpoint in a Private Netork.
Region Changes to this property will trigger replacement. string
region) The region in which the Read Replica should be created.
SameZone Changes to this property will trigger replacement. bool
Defines whether to create the replica in the same availability zone as the main instance nodes or not.
DirectAccess DatabaseReadReplicaDirectAccessArgs
Creates a direct access endpoint to rdb replica.
InstanceId string

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

PrivateNetwork DatabaseReadReplicaPrivateNetworkArgs
Create an endpoint in a Private Netork.
Region Changes to this property will trigger replacement. string
region) The region in which the Read Replica should be created.
SameZone Changes to this property will trigger replacement. bool
Defines whether to create the replica in the same availability zone as the main instance nodes or not.
directAccess DatabaseReadReplicaDirectAccess
Creates a direct access endpoint to rdb replica.
instanceId String

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

privateNetwork DatabaseReadReplicaPrivateNetwork
Create an endpoint in a Private Netork.
region Changes to this property will trigger replacement. String
region) The region in which the Read Replica should be created.
sameZone Changes to this property will trigger replacement. Boolean
Defines whether to create the replica in the same availability zone as the main instance nodes or not.
directAccess DatabaseReadReplicaDirectAccess
Creates a direct access endpoint to rdb replica.
instanceId string

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

privateNetwork DatabaseReadReplicaPrivateNetwork
Create an endpoint in a Private Netork.
region Changes to this property will trigger replacement. string
region) The region in which the Read Replica should be created.
sameZone Changes to this property will trigger replacement. boolean
Defines whether to create the replica in the same availability zone as the main instance nodes or not.
direct_access DatabaseReadReplicaDirectAccessArgs
Creates a direct access endpoint to rdb replica.
instance_id str

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

private_network DatabaseReadReplicaPrivateNetworkArgs
Create an endpoint in a Private Netork.
region Changes to this property will trigger replacement. str
region) The region in which the Read Replica should be created.
same_zone Changes to this property will trigger replacement. bool
Defines whether to create the replica in the same availability zone as the main instance nodes or not.
directAccess Property Map
Creates a direct access endpoint to rdb replica.
instanceId String

UUID of the rdb instance.

Important: The replica musts contains at least one direct_access or private_network. It can contain both.

privateNetwork Property Map
Create an endpoint in a Private Netork.
region Changes to this property will trigger replacement. String
region) The region in which the Read Replica should be created.
sameZone Changes to this property will trigger replacement. Boolean
Defines whether to create the replica in the same availability zone as the main instance nodes or not.

Supporting Types

DatabaseReadReplicaDirectAccess
, DatabaseReadReplicaDirectAccessArgs

EndpointId string
The ID of the endpoint of the Read Replica.
Hostname string
Hostname of the endpoint. Only one of IP and hostname may be set.
Ip string
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
Name string
Name of the endpoint.
Port int
TCP port of the endpoint.
EndpointId string
The ID of the endpoint of the Read Replica.
Hostname string
Hostname of the endpoint. Only one of IP and hostname may be set.
Ip string
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
Name string
Name of the endpoint.
Port int
TCP port of the endpoint.
endpointId String
The ID of the endpoint of the Read Replica.
hostname String
Hostname of the endpoint. Only one of IP and hostname may be set.
ip String
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
name String
Name of the endpoint.
port Integer
TCP port of the endpoint.
endpointId string
The ID of the endpoint of the Read Replica.
hostname string
Hostname of the endpoint. Only one of IP and hostname may be set.
ip string
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
name string
Name of the endpoint.
port number
TCP port of the endpoint.
endpoint_id str
The ID of the endpoint of the Read Replica.
hostname str
Hostname of the endpoint. Only one of IP and hostname may be set.
ip str
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
name str
Name of the endpoint.
port int
TCP port of the endpoint.
endpointId String
The ID of the endpoint of the Read Replica.
hostname String
Hostname of the endpoint. Only one of IP and hostname may be set.
ip String
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
name String
Name of the endpoint.
port Number
TCP port of the endpoint.

DatabaseReadReplicaPrivateNetwork
, DatabaseReadReplicaPrivateNetworkArgs

PrivateNetworkId This property is required. string
UUID of the Private Netork to be connected to the Read Replica.
EnableIpam bool

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

Important: One of service_ip or enable_ipam=true must be set.

EndpointId string
The ID of the endpoint of the Read Replica.
Hostname string
Hostname of the endpoint. Only one of IP and hostname may be set.
Ip string
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
Name string
Name of the endpoint.
Port int
TCP port of the endpoint.
ServiceIp 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.
Zone string
Private network zone
PrivateNetworkId This property is required. string
UUID of the Private Netork to be connected to the Read Replica.
EnableIpam bool

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

Important: One of service_ip or enable_ipam=true must be set.

EndpointId string
The ID of the endpoint of the Read Replica.
Hostname string
Hostname of the endpoint. Only one of IP and hostname may be set.
Ip string
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
Name string
Name of the endpoint.
Port int
TCP port of the endpoint.
ServiceIp 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.
Zone string
Private network zone
privateNetworkId This property is required. String
UUID of the Private Netork to be connected to the Read Replica.
enableIpam Boolean

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

Important: One of service_ip or enable_ipam=true must be set.

endpointId String
The ID of the endpoint of the Read Replica.
hostname String
Hostname of the endpoint. Only one of IP and hostname may be set.
ip String
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
name String
Name of the endpoint.
port Integer
TCP port of the endpoint.
serviceIp 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.
zone String
Private network zone
privateNetworkId This property is required. string
UUID of the Private Netork to be connected to the Read Replica.
enableIpam boolean

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

Important: One of service_ip or enable_ipam=true must be set.

endpointId string
The ID of the endpoint of the Read Replica.
hostname string
Hostname of the endpoint. Only one of IP and hostname may be set.
ip string
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
name string
Name of the endpoint.
port number
TCP port of the endpoint.
serviceIp 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.
zone string
Private network zone
private_network_id This property is required. str
UUID of the Private Netork to be connected to the Read Replica.
enable_ipam bool

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

Important: One of service_ip or enable_ipam=true must be set.

endpoint_id str
The ID of the endpoint of the Read Replica.
hostname str
Hostname of the endpoint. Only one of IP and hostname may be set.
ip str
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
name str
Name of the endpoint.
port int
TCP port of the endpoint.
service_ip 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.
zone str
Private network zone
privateNetworkId This property is required. String
UUID of the Private Netork to be connected to the Read Replica.
enableIpam Boolean

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

Important: One of service_ip or enable_ipam=true must be set.

endpointId String
The ID of the endpoint of the Read Replica.
hostname String
Hostname of the endpoint. Only one of IP and hostname may be set.
ip String
IPv4 address of the endpoint (IP address). Only one of IP and hostname may be set.
name String
Name of the endpoint.
port Number
TCP port of the endpoint.
serviceIp 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.
zone String
Private network zone

Import

Read Replicas can be imported using the {region}/{id}, e.g.

bash

$ pulumi import scaleway:index/databaseReadReplica:DatabaseReadReplica rr fr-par/11111111-1111-1111-1111-111111111111
Copy

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 v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway