Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. databases
  5. ReadReplica
Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.databases.ReadReplica

Explore with Pulumi AI

scaleway logo
Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

    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: {},
});

    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={})

    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
	})
}

    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,
    });

});

    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());

    }
}

    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: {}

    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",
    },
});

    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",
    })

    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
	})
}

    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",
        },
    });

});

    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());

    }
}

    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

    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,
    },
});

    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,
    })

    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
	})
}

    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,
        },
    });

});

    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());

    }
}

    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

    Create ReadReplica Resource

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

    Constructor syntax

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

@overload
def ReadReplica(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                instance_id: Optional[str] = None,
                direct_access: Optional[ReadReplicaDirectAccessArgs] = None,
                private_network: Optional[ReadReplicaPrivateNetworkArgs] = None,
                region: Optional[str] = None,
                same_zone: Optional[bool] = None)
    func NewReadReplica(ctx *Context, name string, args ReadReplicaArgs, opts ...ResourceOption) (*ReadReplica, error)
    public ReadReplica(string name, ReadReplicaArgs args, CustomResourceOptions? opts = null)
    public ReadReplica(String name, ReadReplicaArgs args)
public ReadReplica(String name, ReadReplicaArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args ReadReplicaArgs
    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 ReadReplicaArgs
    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 ReadReplicaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReadReplicaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReadReplicaArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var readReplicaResource = new Scaleway.Databases.ReadReplica("readReplicaResource", new()
{
    InstanceId = "string",
    DirectAccess = new Scaleway.Databases.Inputs.ReadReplicaDirectAccessArgs
    {
        EndpointId = "string",
        Hostname = "string",
        Ip = "string",
        Name = "string",
        Port = 0,
    },
    PrivateNetwork = new Scaleway.Databases.Inputs.ReadReplicaPrivateNetworkArgs
    {
        PrivateNetworkId = "string",
        EnableIpam = false,
        EndpointId = "string",
        Hostname = "string",
        Ip = "string",
        Name = "string",
        Port = 0,
        ServiceIp = "string",
        Zone = "string",
    },
    Region = "string",
    SameZone = false,
});

    example, err := databases.NewReadReplica(ctx, "readReplicaResource", &databases.ReadReplicaArgs{
	InstanceId: pulumi.String("string"),
	DirectAccess: &databases.ReadReplicaDirectAccessArgs{
		EndpointId: pulumi.String("string"),
		Hostname:   pulumi.String("string"),
		Ip:         pulumi.String("string"),
		Name:       pulumi.String("string"),
		Port:       pulumi.Int(0),
	},
	PrivateNetwork: &databases.ReadReplicaPrivateNetworkArgs{
		PrivateNetworkId: pulumi.String("string"),
		EnableIpam:       pulumi.Bool(false),
		EndpointId:       pulumi.String("string"),
		Hostname:         pulumi.String("string"),
		Ip:               pulumi.String("string"),
		Name:             pulumi.String("string"),
		Port:             pulumi.Int(0),
		ServiceIp:        pulumi.String("string"),
		Zone:             pulumi.String("string"),
	},
	Region:   pulumi.String("string"),
	SameZone: pulumi.Bool(false),
})

    var readReplicaResource = new ReadReplica("readReplicaResource", ReadReplicaArgs.builder()
    .instanceId("string")
    .directAccess(ReadReplicaDirectAccessArgs.builder()
        .endpointId("string")
        .hostname("string")
        .ip("string")
        .name("string")
        .port(0)
        .build())
    .privateNetwork(ReadReplicaPrivateNetworkArgs.builder()
        .privateNetworkId("string")
        .enableIpam(false)
        .endpointId("string")
        .hostname("string")
        .ip("string")
        .name("string")
        .port(0)
        .serviceIp("string")
        .zone("string")
        .build())
    .region("string")
    .sameZone(false)
    .build());

    read_replica_resource = scaleway.databases.ReadReplica("readReplicaResource",
    instance_id="string",
    direct_access={
        "endpoint_id": "string",
        "hostname": "string",
        "ip": "string",
        "name": "string",
        "port": 0,
    },
    private_network={
        "private_network_id": "string",
        "enable_ipam": False,
        "endpoint_id": "string",
        "hostname": "string",
        "ip": "string",
        "name": "string",
        "port": 0,
        "service_ip": "string",
        "zone": "string",
    },
    region="string",
    same_zone=False)

    const readReplicaResource = new scaleway.databases.ReadReplica("readReplicaResource", {
    instanceId: "string",
    directAccess: {
        endpointId: "string",
        hostname: "string",
        ip: "string",
        name: "string",
        port: 0,
    },
    privateNetwork: {
        privateNetworkId: "string",
        enableIpam: false,
        endpointId: "string",
        hostname: "string",
        ip: "string",
        name: "string",
        port: 0,
        serviceIp: "string",
        zone: "string",
    },
    region: "string",
    sameZone: false,
});

    type: scaleway:databases:ReadReplica
properties:
    directAccess:
        endpointId: string
        hostname: string
        ip: string
        name: string
        port: 0
    instanceId: string
    privateNetwork:
        enableIpam: false
        endpointId: string
        hostname: string
        ip: string
        name: string
        port: 0
        privateNetworkId: string
        serviceIp: string
        zone: string
    region: string
    sameZone: false

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

    InstanceId 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.Databases.Inputs.ReadReplicaDirectAccess
    Creates a direct access endpoint to rdb replica.
    PrivateNetwork Pulumiverse.Scaleway.Databases.Inputs.ReadReplicaPrivateNetwork
    Create an endpoint in a Private Netork.
    Region string
    region) The region in which the Read Replica should be created.
    SameZone bool
    Defines whether to create the replica in the same availability zone as the main instance nodes or not.
    InstanceId string

    UUID of the rdb instance.

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

    DirectAccess ReadReplicaDirectAccessArgs
    Creates a direct access endpoint to rdb replica.
    PrivateNetwork ReadReplicaPrivateNetworkArgs
    Create an endpoint in a Private Netork.
    Region string
    region) The region in which the Read Replica should be created.
    SameZone bool
    Defines whether to create the replica in the same availability zone as the main instance nodes or not.
    instanceId String

    UUID of the rdb instance.

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

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

    UUID of the rdb instance.

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

    directAccess ReadReplicaDirectAccess
    Creates a direct access endpoint to rdb replica.
    privateNetwork ReadReplicaPrivateNetwork
    Create an endpoint in a Private Netork.
    region string
    region) The region in which the Read Replica should be created.
    sameZone boolean
    Defines whether to create the replica in the same availability zone as the main instance nodes or not.
    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.

    direct_access ReadReplicaDirectAccessArgs
    Creates a direct access endpoint to rdb replica.
    private_network ReadReplicaPrivateNetworkArgs
    Create an endpoint in a Private Netork.
    region str
    region) The region in which the Read Replica should be created.
    same_zone bool
    Defines whether to create the replica in the same availability zone as the main instance nodes or not.
    instanceId 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 String
    region) The region in which the Read Replica should be created.
    sameZone 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 ReadReplica 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 ReadReplica Resource

    Get an existing ReadReplica 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?: ReadReplicaState, opts?: CustomResourceOptions): ReadReplica
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        direct_access: Optional[ReadReplicaDirectAccessArgs] = None,
        instance_id: Optional[str] = None,
        private_network: Optional[ReadReplicaPrivateNetworkArgs] = None,
        region: Optional[str] = None,
        same_zone: Optional[bool] = None) -> ReadReplica
    func GetReadReplica(ctx *Context, name string, id IDInput, state *ReadReplicaState, opts ...ResourceOption) (*ReadReplica, error)
    public static ReadReplica Get(string name, Input<string> id, ReadReplicaState? state, CustomResourceOptions? opts = null)
    public static ReadReplica get(String name, Output<String> id, ReadReplicaState state, CustomResourceOptions options)
    resources:  _:    type: scaleway:databases:ReadReplica    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DirectAccess Pulumiverse.Scaleway.Databases.Inputs.ReadReplicaDirectAccess
    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.Databases.Inputs.ReadReplicaPrivateNetwork
    Create an endpoint in a Private Netork.
    Region string
    region) The region in which the Read Replica should be created.
    SameZone bool
    Defines whether to create the replica in the same availability zone as the main instance nodes or not.
    DirectAccess ReadReplicaDirectAccessArgs
    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 ReadReplicaPrivateNetworkArgs
    Create an endpoint in a Private Netork.
    Region string
    region) The region in which the Read Replica should be created.
    SameZone bool
    Defines whether to create the replica in the same availability zone as the main instance nodes or not.
    directAccess ReadReplicaDirectAccess
    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 ReadReplicaPrivateNetwork
    Create an endpoint in a Private Netork.
    region String
    region) The region in which the Read Replica should be created.
    sameZone Boolean
    Defines whether to create the replica in the same availability zone as the main instance nodes or not.
    directAccess ReadReplicaDirectAccess
    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 ReadReplicaPrivateNetwork
    Create an endpoint in a Private Netork.
    region string
    region) The region in which the Read Replica should be created.
    sameZone boolean
    Defines whether to create the replica in the same availability zone as the main instance nodes or not.
    direct_access ReadReplicaDirectAccessArgs
    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 ReadReplicaPrivateNetworkArgs
    Create an endpoint in a Private Netork.
    region str
    region) The region in which the Read Replica should be created.
    same_zone 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 String
    region) The region in which the Read Replica should be created.
    sameZone Boolean
    Defines whether to create the replica in the same availability zone as the main instance nodes or not.

    Supporting Types

    ReadReplicaDirectAccess, ReadReplicaDirectAccessArgs

    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.

    ReadReplicaPrivateNetwork, ReadReplicaPrivateNetworkArgs

    PrivateNetworkId 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 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 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 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 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 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:databases/readReplica:ReadReplica rr fr-par/11111111-1111-1111-1111-111111111111

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

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse
    pulumiverse/pulumi-scaleway