Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vultr
  3. API Docs
  4. DatabaseReplica
Vultr v2.21.1 published on Monday, Jul 22, 2024 by dirien
dirien/pulumi-vultr

vultr.DatabaseReplica

Explore with Pulumi AI

vultr logo
Vultr v2.21.1 published on Monday, Jul 22, 2024 by dirien
dirien/pulumi-vultr

    Provides a Vultr database replica resource. This can be used to create, read, modify, and delete managed database read replicas on your Vultr account.

    Example Usage

    Create a new database replica:

    import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@ediri/vultr";

const myDatabaseReplica = new vultr.DatabaseReplica("myDatabaseReplica", {
    databaseId: vultr_database.my_database.id,
    region: "sea",
    label: "my_database_replica_label",
    tag: "test tag",
});

    import pulumi
import ediri_vultr as vultr

my_database_replica = vultr.DatabaseReplica("myDatabaseReplica",
    database_id=vultr_database["my_database"]["id"],
    region="sea",
    label="my_database_replica_label",
    tag="test tag")

    package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.NewDatabaseReplica(ctx, "myDatabaseReplica", &vultr.DatabaseReplicaArgs{
			DatabaseId: pulumi.Any(vultr_database.My_database.Id),
			Region:     pulumi.String("sea"),
			Label:      pulumi.String("my_database_replica_label"),
			Tag:        pulumi.String("test tag"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = ediri.Vultr;

return await Deployment.RunAsync(() => 
{
    var myDatabaseReplica = new Vultr.DatabaseReplica("myDatabaseReplica", new()
    {
        DatabaseId = vultr_database.My_database.Id,
        Region = "sea",
        Label = "my_database_replica_label",
        Tag = "test tag",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.DatabaseReplica;
import com.pulumi.vultr.DatabaseReplicaArgs;
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 myDatabaseReplica = new DatabaseReplica("myDatabaseReplica", DatabaseReplicaArgs.builder()
            .databaseId(vultr_database.my_database().id())
            .region("sea")
            .label("my_database_replica_label")
            .tag("test tag")
            .build());

    }
}

    resources:
  myDatabaseReplica:
    type: vultr:DatabaseReplica
    properties:
      databaseId: ${vultr_database.my_database.id}
      region: sea
      label: my_database_replica_label
      tag: test tag

    Create DatabaseReplica Resource

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

    Constructor syntax

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

@overload
def DatabaseReplica(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    database_id: Optional[str] = None,
                    region: Optional[str] = None,
                    label: Optional[str] = None,
                    mysql_sql_modes: Optional[Sequence[str]] = None,
                    mysql_require_primary_key: Optional[bool] = None,
                    mysql_slow_query_log: Optional[bool] = None,
                    mysql_long_query_time: Optional[int] = None,
                    plan_disk: Optional[int] = None,
                    public_host: Optional[str] = None,
                    redis_eviction_policy: Optional[str] = None,
                    ferretdb_credentials: Optional[Mapping[str, Any]] = None,
                    tag: Optional[str] = None,
                    trusted_ips: Optional[Sequence[str]] = None)
    func NewDatabaseReplica(ctx *Context, name string, args DatabaseReplicaArgs, opts ...ResourceOption) (*DatabaseReplica, error)
    public DatabaseReplica(string name, DatabaseReplicaArgs args, CustomResourceOptions? opts = null)
    public DatabaseReplica(String name, DatabaseReplicaArgs args)
public DatabaseReplica(String name, DatabaseReplicaArgs args, CustomResourceOptions options)

    type: vultr:DatabaseReplica
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 DatabaseReplicaArgs
    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 DatabaseReplicaArgs
    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 DatabaseReplicaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseReplicaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseReplicaArgs
    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 databaseReplicaResource = new Vultr.DatabaseReplica("databaseReplicaResource", new()
{
    DatabaseId = "string",
    Region = "string",
    Label = "string",
    MysqlSqlModes = new[]
    {
        "string",
    },
    MysqlRequirePrimaryKey = false,
    MysqlSlowQueryLog = false,
    MysqlLongQueryTime = 0,
    PlanDisk = 0,
    PublicHost = "string",
    RedisEvictionPolicy = "string",
    FerretdbCredentials = 
    {
        { "string", "any" },
    },
    Tag = "string",
    TrustedIps = new[]
    {
        "string",
    },
});

    example, err := vultr.NewDatabaseReplica(ctx, "databaseReplicaResource", &vultr.DatabaseReplicaArgs{
	DatabaseId: pulumi.String("string"),
	Region:     pulumi.String("string"),
	Label:      pulumi.String("string"),
	MysqlSqlModes: pulumi.StringArray{
		pulumi.String("string"),
	},
	MysqlRequirePrimaryKey: pulumi.Bool(false),
	MysqlSlowQueryLog:      pulumi.Bool(false),
	MysqlLongQueryTime:     pulumi.Int(0),
	PlanDisk:               pulumi.Int(0),
	PublicHost:             pulumi.String("string"),
	RedisEvictionPolicy:    pulumi.String("string"),
	FerretdbCredentials: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	Tag: pulumi.String("string"),
	TrustedIps: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var databaseReplicaResource = new DatabaseReplica("databaseReplicaResource", DatabaseReplicaArgs.builder()
    .databaseId("string")
    .region("string")
    .label("string")
    .mysqlSqlModes("string")
    .mysqlRequirePrimaryKey(false)
    .mysqlSlowQueryLog(false)
    .mysqlLongQueryTime(0)
    .planDisk(0)
    .publicHost("string")
    .redisEvictionPolicy("string")
    .ferretdbCredentials(Map.of("string", "any"))
    .tag("string")
    .trustedIps("string")
    .build());

    database_replica_resource = vultr.DatabaseReplica("databaseReplicaResource",
    database_id="string",
    region="string",
    label="string",
    mysql_sql_modes=["string"],
    mysql_require_primary_key=False,
    mysql_slow_query_log=False,
    mysql_long_query_time=0,
    plan_disk=0,
    public_host="string",
    redis_eviction_policy="string",
    ferretdb_credentials={
        "string": "any",
    },
    tag="string",
    trusted_ips=["string"])

    const databaseReplicaResource = new vultr.DatabaseReplica("databaseReplicaResource", {
    databaseId: "string",
    region: "string",
    label: "string",
    mysqlSqlModes: ["string"],
    mysqlRequirePrimaryKey: false,
    mysqlSlowQueryLog: false,
    mysqlLongQueryTime: 0,
    planDisk: 0,
    publicHost: "string",
    redisEvictionPolicy: "string",
    ferretdbCredentials: {
        string: "any",
    },
    tag: "string",
    trustedIps: ["string"],
});

    type: vultr:DatabaseReplica
properties:
    databaseId: string
    ferretdbCredentials:
        string: any
    label: string
    mysqlLongQueryTime: 0
    mysqlRequirePrimaryKey: false
    mysqlSlowQueryLog: false
    mysqlSqlModes:
        - string
    planDisk: 0
    publicHost: string
    redisEvictionPolicy: string
    region: string
    tag: string
    trustedIps:
        - string

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

    DatabaseId string
    The managed database ID you want to attach this replica to.
    Label string
    A label for the managed database read replica.
    Region string
    The ID of the region that the managed database read replica is to be created in. See List Regions
    FerretdbCredentials Dictionary<string, object>
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    MysqlLongQueryTime int
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    MysqlRequirePrimaryKey bool
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    MysqlSlowQueryLog bool
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    MysqlSqlModes List<string>
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    PlanDisk int
    The description of the disk(s) on the managed database read replica.
    PublicHost string
    The public hostname assigned to the managed database read replica (VPC-attached only).
    RedisEvictionPolicy string
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    Tag string
    The tag to assign to the managed database read replica.
    TrustedIps List<string>
    A list of allowed IP addresses for the managed database read replica.
    DatabaseId string
    The managed database ID you want to attach this replica to.
    Label string
    A label for the managed database read replica.
    Region string
    The ID of the region that the managed database read replica is to be created in. See List Regions
    FerretdbCredentials map[string]interface{}
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    MysqlLongQueryTime int
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    MysqlRequirePrimaryKey bool
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    MysqlSlowQueryLog bool
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    MysqlSqlModes []string
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    PlanDisk int
    The description of the disk(s) on the managed database read replica.
    PublicHost string
    The public hostname assigned to the managed database read replica (VPC-attached only).
    RedisEvictionPolicy string
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    Tag string
    The tag to assign to the managed database read replica.
    TrustedIps []string
    A list of allowed IP addresses for the managed database read replica.
    databaseId String
    The managed database ID you want to attach this replica to.
    label String
    A label for the managed database read replica.
    region String
    The ID of the region that the managed database read replica is to be created in. See List Regions
    ferretdbCredentials Map<String,Object>
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    mysqlLongQueryTime Integer
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    mysqlRequirePrimaryKey Boolean
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    mysqlSlowQueryLog Boolean
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    mysqlSqlModes List<String>
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    planDisk Integer
    The description of the disk(s) on the managed database read replica.
    publicHost String
    The public hostname assigned to the managed database read replica (VPC-attached only).
    redisEvictionPolicy String
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    tag String
    The tag to assign to the managed database read replica.
    trustedIps List<String>
    A list of allowed IP addresses for the managed database read replica.
    databaseId string
    The managed database ID you want to attach this replica to.
    label string
    A label for the managed database read replica.
    region string
    The ID of the region that the managed database read replica is to be created in. See List Regions
    ferretdbCredentials {[key: string]: any}
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    mysqlLongQueryTime number
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    mysqlRequirePrimaryKey boolean
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    mysqlSlowQueryLog boolean
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    mysqlSqlModes string[]
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    planDisk number
    The description of the disk(s) on the managed database read replica.
    publicHost string
    The public hostname assigned to the managed database read replica (VPC-attached only).
    redisEvictionPolicy string
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    tag string
    The tag to assign to the managed database read replica.
    trustedIps string[]
    A list of allowed IP addresses for the managed database read replica.
    database_id str
    The managed database ID you want to attach this replica to.
    label str
    A label for the managed database read replica.
    region str
    The ID of the region that the managed database read replica is to be created in. See List Regions
    ferretdb_credentials Mapping[str, Any]
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    mysql_long_query_time int
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    mysql_require_primary_key bool
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    mysql_slow_query_log bool
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    mysql_sql_modes Sequence[str]
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    plan_disk int
    The description of the disk(s) on the managed database read replica.
    public_host str
    The public hostname assigned to the managed database read replica (VPC-attached only).
    redis_eviction_policy str
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    tag str
    The tag to assign to the managed database read replica.
    trusted_ips Sequence[str]
    A list of allowed IP addresses for the managed database read replica.
    databaseId String
    The managed database ID you want to attach this replica to.
    label String
    A label for the managed database read replica.
    region String
    The ID of the region that the managed database read replica is to be created in. See List Regions
    ferretdbCredentials Map<Any>
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    mysqlLongQueryTime Number
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    mysqlRequirePrimaryKey Boolean
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    mysqlSlowQueryLog Boolean
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    mysqlSqlModes List<String>
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    planDisk Number
    The description of the disk(s) on the managed database read replica.
    publicHost String
    The public hostname assigned to the managed database read replica (VPC-attached only).
    redisEvictionPolicy String
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    tag String
    The tag to assign to the managed database read replica.
    trustedIps List<String>
    A list of allowed IP addresses for the managed database read replica.

    Outputs

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

    ClusterTimeZone string
    The configured time zone for the managed database read replica in TZ database format.
    DatabaseEngine string
    The database engine of the managed database read replica.
    DatabaseEngineVersion string
    The database engine version of the managed database read replica.
    DateCreated string
    The date the managed database read replica was added to your Vultr account.
    Dbname string
    The managed database read replica's default logical database.
    Host string
    The hostname assigned to the managed database read replica.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestBackup string
    The date of the latest backup available on the managed database read replica.
    MaintenanceDow string
    The preferred maintenance day of week for the managed database read replica.
    MaintenanceTime string
    The preferred maintenance time for the managed database read replica.
    Password string
    The password for the managed database read replica's primary admin user.
    Plan string
    The managed database read replica's plan ID.
    PlanRam int
    The amount of memory available on the managed database read replica in MB.
    PlanReplicas int
    The number of standby nodes available on the managed database read replica.
    PlanVcpus int
    The number of virtual CPUs available on the managed database read replica.
    Port string
    The connection port for the managed database read replica.
    Status string
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    User string
    The primary admin user for the managed database read replica.
    VpcId string
    The ID of the VPC Network attached to the managed database read replica.
    ClusterTimeZone string
    The configured time zone for the managed database read replica in TZ database format.
    DatabaseEngine string
    The database engine of the managed database read replica.
    DatabaseEngineVersion string
    The database engine version of the managed database read replica.
    DateCreated string
    The date the managed database read replica was added to your Vultr account.
    Dbname string
    The managed database read replica's default logical database.
    Host string
    The hostname assigned to the managed database read replica.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestBackup string
    The date of the latest backup available on the managed database read replica.
    MaintenanceDow string
    The preferred maintenance day of week for the managed database read replica.
    MaintenanceTime string
    The preferred maintenance time for the managed database read replica.
    Password string
    The password for the managed database read replica's primary admin user.
    Plan string
    The managed database read replica's plan ID.
    PlanRam int
    The amount of memory available on the managed database read replica in MB.
    PlanReplicas int
    The number of standby nodes available on the managed database read replica.
    PlanVcpus int
    The number of virtual CPUs available on the managed database read replica.
    Port string
    The connection port for the managed database read replica.
    Status string
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    User string
    The primary admin user for the managed database read replica.
    VpcId string
    The ID of the VPC Network attached to the managed database read replica.
    clusterTimeZone String
    The configured time zone for the managed database read replica in TZ database format.
    databaseEngine String
    The database engine of the managed database read replica.
    databaseEngineVersion String
    The database engine version of the managed database read replica.
    dateCreated String
    The date the managed database read replica was added to your Vultr account.
    dbname String
    The managed database read replica's default logical database.
    host String
    The hostname assigned to the managed database read replica.
    id String
    The provider-assigned unique ID for this managed resource.
    latestBackup String
    The date of the latest backup available on the managed database read replica.
    maintenanceDow String
    The preferred maintenance day of week for the managed database read replica.
    maintenanceTime String
    The preferred maintenance time for the managed database read replica.
    password String
    The password for the managed database read replica's primary admin user.
    plan String
    The managed database read replica's plan ID.
    planRam Integer
    The amount of memory available on the managed database read replica in MB.
    planReplicas Integer
    The number of standby nodes available on the managed database read replica.
    planVcpus Integer
    The number of virtual CPUs available on the managed database read replica.
    port String
    The connection port for the managed database read replica.
    status String
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    user String
    The primary admin user for the managed database read replica.
    vpcId String
    The ID of the VPC Network attached to the managed database read replica.
    clusterTimeZone string
    The configured time zone for the managed database read replica in TZ database format.
    databaseEngine string
    The database engine of the managed database read replica.
    databaseEngineVersion string
    The database engine version of the managed database read replica.
    dateCreated string
    The date the managed database read replica was added to your Vultr account.
    dbname string
    The managed database read replica's default logical database.
    host string
    The hostname assigned to the managed database read replica.
    id string
    The provider-assigned unique ID for this managed resource.
    latestBackup string
    The date of the latest backup available on the managed database read replica.
    maintenanceDow string
    The preferred maintenance day of week for the managed database read replica.
    maintenanceTime string
    The preferred maintenance time for the managed database read replica.
    password string
    The password for the managed database read replica's primary admin user.
    plan string
    The managed database read replica's plan ID.
    planRam number
    The amount of memory available on the managed database read replica in MB.
    planReplicas number
    The number of standby nodes available on the managed database read replica.
    planVcpus number
    The number of virtual CPUs available on the managed database read replica.
    port string
    The connection port for the managed database read replica.
    status string
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    user string
    The primary admin user for the managed database read replica.
    vpcId string
    The ID of the VPC Network attached to the managed database read replica.
    cluster_time_zone str
    The configured time zone for the managed database read replica in TZ database format.
    database_engine str
    The database engine of the managed database read replica.
    database_engine_version str
    The database engine version of the managed database read replica.
    date_created str
    The date the managed database read replica was added to your Vultr account.
    dbname str
    The managed database read replica's default logical database.
    host str
    The hostname assigned to the managed database read replica.
    id str
    The provider-assigned unique ID for this managed resource.
    latest_backup str
    The date of the latest backup available on the managed database read replica.
    maintenance_dow str
    The preferred maintenance day of week for the managed database read replica.
    maintenance_time str
    The preferred maintenance time for the managed database read replica.
    password str
    The password for the managed database read replica's primary admin user.
    plan str
    The managed database read replica's plan ID.
    plan_ram int
    The amount of memory available on the managed database read replica in MB.
    plan_replicas int
    The number of standby nodes available on the managed database read replica.
    plan_vcpus int
    The number of virtual CPUs available on the managed database read replica.
    port str
    The connection port for the managed database read replica.
    status str
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    user str
    The primary admin user for the managed database read replica.
    vpc_id str
    The ID of the VPC Network attached to the managed database read replica.
    clusterTimeZone String
    The configured time zone for the managed database read replica in TZ database format.
    databaseEngine String
    The database engine of the managed database read replica.
    databaseEngineVersion String
    The database engine version of the managed database read replica.
    dateCreated String
    The date the managed database read replica was added to your Vultr account.
    dbname String
    The managed database read replica's default logical database.
    host String
    The hostname assigned to the managed database read replica.
    id String
    The provider-assigned unique ID for this managed resource.
    latestBackup String
    The date of the latest backup available on the managed database read replica.
    maintenanceDow String
    The preferred maintenance day of week for the managed database read replica.
    maintenanceTime String
    The preferred maintenance time for the managed database read replica.
    password String
    The password for the managed database read replica's primary admin user.
    plan String
    The managed database read replica's plan ID.
    planRam Number
    The amount of memory available on the managed database read replica in MB.
    planReplicas Number
    The number of standby nodes available on the managed database read replica.
    planVcpus Number
    The number of virtual CPUs available on the managed database read replica.
    port String
    The connection port for the managed database read replica.
    status String
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    user String
    The primary admin user for the managed database read replica.
    vpcId String
    The ID of the VPC Network attached to the managed database read replica.

    Look up Existing DatabaseReplica Resource

    Get an existing DatabaseReplica 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?: DatabaseReplicaState, opts?: CustomResourceOptions): DatabaseReplica
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_time_zone: Optional[str] = None,
        database_engine: Optional[str] = None,
        database_engine_version: Optional[str] = None,
        database_id: Optional[str] = None,
        date_created: Optional[str] = None,
        dbname: Optional[str] = None,
        ferretdb_credentials: Optional[Mapping[str, Any]] = None,
        host: Optional[str] = None,
        label: Optional[str] = None,
        latest_backup: Optional[str] = None,
        maintenance_dow: Optional[str] = None,
        maintenance_time: Optional[str] = None,
        mysql_long_query_time: Optional[int] = None,
        mysql_require_primary_key: Optional[bool] = None,
        mysql_slow_query_log: Optional[bool] = None,
        mysql_sql_modes: Optional[Sequence[str]] = None,
        password: Optional[str] = None,
        plan: Optional[str] = None,
        plan_disk: Optional[int] = None,
        plan_ram: Optional[int] = None,
        plan_replicas: Optional[int] = None,
        plan_vcpus: Optional[int] = None,
        port: Optional[str] = None,
        public_host: Optional[str] = None,
        redis_eviction_policy: Optional[str] = None,
        region: Optional[str] = None,
        status: Optional[str] = None,
        tag: Optional[str] = None,
        trusted_ips: Optional[Sequence[str]] = None,
        user: Optional[str] = None,
        vpc_id: Optional[str] = None) -> DatabaseReplica
    func GetDatabaseReplica(ctx *Context, name string, id IDInput, state *DatabaseReplicaState, opts ...ResourceOption) (*DatabaseReplica, error)
    public static DatabaseReplica Get(string name, Input<string> id, DatabaseReplicaState? state, CustomResourceOptions? opts = null)
    public static DatabaseReplica get(String name, Output<String> id, DatabaseReplicaState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClusterTimeZone string
    The configured time zone for the managed database read replica in TZ database format.
    DatabaseEngine string
    The database engine of the managed database read replica.
    DatabaseEngineVersion string
    The database engine version of the managed database read replica.
    DatabaseId string
    The managed database ID you want to attach this replica to.
    DateCreated string
    The date the managed database read replica was added to your Vultr account.
    Dbname string
    The managed database read replica's default logical database.
    FerretdbCredentials Dictionary<string, object>
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    Host string
    The hostname assigned to the managed database read replica.
    Label string
    A label for the managed database read replica.
    LatestBackup string
    The date of the latest backup available on the managed database read replica.
    MaintenanceDow string
    The preferred maintenance day of week for the managed database read replica.
    MaintenanceTime string
    The preferred maintenance time for the managed database read replica.
    MysqlLongQueryTime int
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    MysqlRequirePrimaryKey bool
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    MysqlSlowQueryLog bool
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    MysqlSqlModes List<string>
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    Password string
    The password for the managed database read replica's primary admin user.
    Plan string
    The managed database read replica's plan ID.
    PlanDisk int
    The description of the disk(s) on the managed database read replica.
    PlanRam int
    The amount of memory available on the managed database read replica in MB.
    PlanReplicas int
    The number of standby nodes available on the managed database read replica.
    PlanVcpus int
    The number of virtual CPUs available on the managed database read replica.
    Port string
    The connection port for the managed database read replica.
    PublicHost string
    The public hostname assigned to the managed database read replica (VPC-attached only).
    RedisEvictionPolicy string
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    Region string
    The ID of the region that the managed database read replica is to be created in. See List Regions
    Status string
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    Tag string
    The tag to assign to the managed database read replica.
    TrustedIps List<string>
    A list of allowed IP addresses for the managed database read replica.
    User string
    The primary admin user for the managed database read replica.
    VpcId string
    The ID of the VPC Network attached to the managed database read replica.
    ClusterTimeZone string
    The configured time zone for the managed database read replica in TZ database format.
    DatabaseEngine string
    The database engine of the managed database read replica.
    DatabaseEngineVersion string
    The database engine version of the managed database read replica.
    DatabaseId string
    The managed database ID you want to attach this replica to.
    DateCreated string
    The date the managed database read replica was added to your Vultr account.
    Dbname string
    The managed database read replica's default logical database.
    FerretdbCredentials map[string]interface{}
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    Host string
    The hostname assigned to the managed database read replica.
    Label string
    A label for the managed database read replica.
    LatestBackup string
    The date of the latest backup available on the managed database read replica.
    MaintenanceDow string
    The preferred maintenance day of week for the managed database read replica.
    MaintenanceTime string
    The preferred maintenance time for the managed database read replica.
    MysqlLongQueryTime int
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    MysqlRequirePrimaryKey bool
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    MysqlSlowQueryLog bool
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    MysqlSqlModes []string
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    Password string
    The password for the managed database read replica's primary admin user.
    Plan string
    The managed database read replica's plan ID.
    PlanDisk int
    The description of the disk(s) on the managed database read replica.
    PlanRam int
    The amount of memory available on the managed database read replica in MB.
    PlanReplicas int
    The number of standby nodes available on the managed database read replica.
    PlanVcpus int
    The number of virtual CPUs available on the managed database read replica.
    Port string
    The connection port for the managed database read replica.
    PublicHost string
    The public hostname assigned to the managed database read replica (VPC-attached only).
    RedisEvictionPolicy string
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    Region string
    The ID of the region that the managed database read replica is to be created in. See List Regions
    Status string
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    Tag string
    The tag to assign to the managed database read replica.
    TrustedIps []string
    A list of allowed IP addresses for the managed database read replica.
    User string
    The primary admin user for the managed database read replica.
    VpcId string
    The ID of the VPC Network attached to the managed database read replica.
    clusterTimeZone String
    The configured time zone for the managed database read replica in TZ database format.
    databaseEngine String
    The database engine of the managed database read replica.
    databaseEngineVersion String
    The database engine version of the managed database read replica.
    databaseId String
    The managed database ID you want to attach this replica to.
    dateCreated String
    The date the managed database read replica was added to your Vultr account.
    dbname String
    The managed database read replica's default logical database.
    ferretdbCredentials Map<String,Object>
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    host String
    The hostname assigned to the managed database read replica.
    label String
    A label for the managed database read replica.
    latestBackup String
    The date of the latest backup available on the managed database read replica.
    maintenanceDow String
    The preferred maintenance day of week for the managed database read replica.
    maintenanceTime String
    The preferred maintenance time for the managed database read replica.
    mysqlLongQueryTime Integer
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    mysqlRequirePrimaryKey Boolean
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    mysqlSlowQueryLog Boolean
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    mysqlSqlModes List<String>
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    password String
    The password for the managed database read replica's primary admin user.
    plan String
    The managed database read replica's plan ID.
    planDisk Integer
    The description of the disk(s) on the managed database read replica.
    planRam Integer
    The amount of memory available on the managed database read replica in MB.
    planReplicas Integer
    The number of standby nodes available on the managed database read replica.
    planVcpus Integer
    The number of virtual CPUs available on the managed database read replica.
    port String
    The connection port for the managed database read replica.
    publicHost String
    The public hostname assigned to the managed database read replica (VPC-attached only).
    redisEvictionPolicy String
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    region String
    The ID of the region that the managed database read replica is to be created in. See List Regions
    status String
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    tag String
    The tag to assign to the managed database read replica.
    trustedIps List<String>
    A list of allowed IP addresses for the managed database read replica.
    user String
    The primary admin user for the managed database read replica.
    vpcId String
    The ID of the VPC Network attached to the managed database read replica.
    clusterTimeZone string
    The configured time zone for the managed database read replica in TZ database format.
    databaseEngine string
    The database engine of the managed database read replica.
    databaseEngineVersion string
    The database engine version of the managed database read replica.
    databaseId string
    The managed database ID you want to attach this replica to.
    dateCreated string
    The date the managed database read replica was added to your Vultr account.
    dbname string
    The managed database read replica's default logical database.
    ferretdbCredentials {[key: string]: any}
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    host string
    The hostname assigned to the managed database read replica.
    label string
    A label for the managed database read replica.
    latestBackup string
    The date of the latest backup available on the managed database read replica.
    maintenanceDow string
    The preferred maintenance day of week for the managed database read replica.
    maintenanceTime string
    The preferred maintenance time for the managed database read replica.
    mysqlLongQueryTime number
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    mysqlRequirePrimaryKey boolean
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    mysqlSlowQueryLog boolean
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    mysqlSqlModes string[]
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    password string
    The password for the managed database read replica's primary admin user.
    plan string
    The managed database read replica's plan ID.
    planDisk number
    The description of the disk(s) on the managed database read replica.
    planRam number
    The amount of memory available on the managed database read replica in MB.
    planReplicas number
    The number of standby nodes available on the managed database read replica.
    planVcpus number
    The number of virtual CPUs available on the managed database read replica.
    port string
    The connection port for the managed database read replica.
    publicHost string
    The public hostname assigned to the managed database read replica (VPC-attached only).
    redisEvictionPolicy string
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    region string
    The ID of the region that the managed database read replica is to be created in. See List Regions
    status string
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    tag string
    The tag to assign to the managed database read replica.
    trustedIps string[]
    A list of allowed IP addresses for the managed database read replica.
    user string
    The primary admin user for the managed database read replica.
    vpcId string
    The ID of the VPC Network attached to the managed database read replica.
    cluster_time_zone str
    The configured time zone for the managed database read replica in TZ database format.
    database_engine str
    The database engine of the managed database read replica.
    database_engine_version str
    The database engine version of the managed database read replica.
    database_id str
    The managed database ID you want to attach this replica to.
    date_created str
    The date the managed database read replica was added to your Vultr account.
    dbname str
    The managed database read replica's default logical database.
    ferretdb_credentials Mapping[str, Any]
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    host str
    The hostname assigned to the managed database read replica.
    label str
    A label for the managed database read replica.
    latest_backup str
    The date of the latest backup available on the managed database read replica.
    maintenance_dow str
    The preferred maintenance day of week for the managed database read replica.
    maintenance_time str
    The preferred maintenance time for the managed database read replica.
    mysql_long_query_time int
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    mysql_require_primary_key bool
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    mysql_slow_query_log bool
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    mysql_sql_modes Sequence[str]
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    password str
    The password for the managed database read replica's primary admin user.
    plan str
    The managed database read replica's plan ID.
    plan_disk int
    The description of the disk(s) on the managed database read replica.
    plan_ram int
    The amount of memory available on the managed database read replica in MB.
    plan_replicas int
    The number of standby nodes available on the managed database read replica.
    plan_vcpus int
    The number of virtual CPUs available on the managed database read replica.
    port str
    The connection port for the managed database read replica.
    public_host str
    The public hostname assigned to the managed database read replica (VPC-attached only).
    redis_eviction_policy str
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    region str
    The ID of the region that the managed database read replica is to be created in. See List Regions
    status str
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    tag str
    The tag to assign to the managed database read replica.
    trusted_ips Sequence[str]
    A list of allowed IP addresses for the managed database read replica.
    user str
    The primary admin user for the managed database read replica.
    vpc_id str
    The ID of the VPC Network attached to the managed database read replica.
    clusterTimeZone String
    The configured time zone for the managed database read replica in TZ database format.
    databaseEngine String
    The database engine of the managed database read replica.
    databaseEngineVersion String
    The database engine version of the managed database read replica.
    databaseId String
    The managed database ID you want to attach this replica to.
    dateCreated String
    The date the managed database read replica was added to your Vultr account.
    dbname String
    The managed database read replica's default logical database.
    ferretdbCredentials Map<Any>
    An associated list of FerretDB connection credentials (FerretDB + PostgreSQL engine types only).
    host String
    The hostname assigned to the managed database read replica.
    label String
    A label for the managed database read replica.
    latestBackup String
    The date of the latest backup available on the managed database read replica.
    maintenanceDow String
    The preferred maintenance day of week for the managed database read replica.
    maintenanceTime String
    The preferred maintenance time for the managed database read replica.
    mysqlLongQueryTime Number
    The configuration value for the long query time (in seconds) on the managed database read replica (MySQL engine types only).
    mysqlRequirePrimaryKey Boolean
    The configuration value for whether primary keys are required on the managed database read replica (MySQL engine types only).
    mysqlSlowQueryLog Boolean
    The configuration value for slow query logging on the managed database read replica (MySQL engine types only).
    mysqlSqlModes List<String>
    A list of SQL modes currently configured for the managed database read replica (MySQL engine types only).
    password String
    The password for the managed database read replica's primary admin user.
    plan String
    The managed database read replica's plan ID.
    planDisk Number
    The description of the disk(s) on the managed database read replica.
    planRam Number
    The amount of memory available on the managed database read replica in MB.
    planReplicas Number
    The number of standby nodes available on the managed database read replica.
    planVcpus Number
    The number of virtual CPUs available on the managed database read replica.
    port String
    The connection port for the managed database read replica.
    publicHost String
    The public hostname assigned to the managed database read replica (VPC-attached only).
    redisEvictionPolicy String
    The configuration value for the data eviction policy on the managed database read replica (Redis engine types only).
    region String
    The ID of the region that the managed database read replica is to be created in. See List Regions
    status String
    The current status of the managed database read replica (poweroff, rebuilding, rebalancing, configuring, running).
    tag String
    The tag to assign to the managed database read replica.
    trustedIps List<String>
    A list of allowed IP addresses for the managed database read replica.
    user String
    The primary admin user for the managed database read replica.
    vpcId String
    The ID of the VPC Network attached to the managed database read replica.

    Package Details

    Repository
    vultr dirien/pulumi-vultr
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vultr Terraform Provider.
    vultr logo
    Vultr v2.21.1 published on Monday, Jul 22, 2024 by dirien
    dirien/pulumi-vultr