Docs Packages
  1. Pulumi Registry
  2. Vultr
  3. API Docs
  4. Database
vultr logo
Vultr v2.15.1, May 19 23

vultr.Database

Explore with Pulumi AI

Create Database Resource

new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             cluster_time_zone: Optional[str] = None,
             database_engine: Optional[str] = None,
             database_engine_version: Optional[str] = None,
             label: 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,
             read_replicas: Optional[Sequence[DatabaseReadReplicaArgs]] = None,
             redis_eviction_policy: Optional[str] = None,
             region: Optional[str] = None,
             tag: Optional[str] = None,
             trusted_ips: Optional[Sequence[str]] = None)
@overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = None)
func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)

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

Database Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Database resource accepts the following input properties:

Outputs

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

DateCreated string
Dbname string
Host string
Id string

The provider-assigned unique ID for this managed resource.

LatestBackup string
PlanRam int
PlanReplicas int
PlanVcpus int
Port string
Status string
User string
DateCreated string
Dbname string
Host string
Id string

The provider-assigned unique ID for this managed resource.

LatestBackup string
PlanRam int
PlanReplicas int
PlanVcpus int
Port string
Status string
User string
dateCreated String
dbname String
host String
id String

The provider-assigned unique ID for this managed resource.

latestBackup String
planRam Integer
planReplicas Integer
planVcpus Integer
port String
status String
user String
dateCreated string
dbname string
host string
id string

The provider-assigned unique ID for this managed resource.

latestBackup string
planRam number
planReplicas number
planVcpus number
port string
status string
user string
date_created str
dbname str
host str
id str

The provider-assigned unique ID for this managed resource.

latest_backup str
plan_ram int
plan_replicas int
plan_vcpus int
port str
status str
user str
dateCreated String
dbname String
host String
id String

The provider-assigned unique ID for this managed resource.

latestBackup String
planRam Number
planReplicas Number
planVcpus Number
port String
status String
user String

Look up Existing Database Resource

Get an existing Database 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?: DatabaseState, opts?: CustomResourceOptions): Database
@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,
        date_created: Optional[str] = None,
        dbname: Optional[str] = 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,
        read_replicas: Optional[Sequence[DatabaseReadReplicaArgs]] = 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) -> Database
func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
public static Database get(String name, Output<String> id, DatabaseState 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:

Supporting Types

DatabaseReadReplica

label String
region String
clusterTimeZone String
databaseEngine String
databaseEngineVersion String
dateCreated String
dbname String
host String
id String
latestBackup String
maintenanceDow String
maintenanceTime String
mysqlLongQueryTime Integer
mysqlRequirePrimaryKey Boolean
mysqlSlowQueryLog Boolean
mysqlSqlModes List<String>
password String
plan String
planDisk Integer
planRam Integer
planReplicas Integer
planVcpus Integer
port String
redisEvictionPolicy String
status String
tag String
trustedIps List<String>
user String
label string
region string
clusterTimeZone string
databaseEngine string
databaseEngineVersion string
dateCreated string
dbname string
host string
id string
latestBackup string
maintenanceDow string
maintenanceTime string
mysqlLongQueryTime number
mysqlRequirePrimaryKey boolean
mysqlSlowQueryLog boolean
mysqlSqlModes string[]
password string
plan string
planDisk number
planRam number
planReplicas number
planVcpus number
port string
redisEvictionPolicy string
status string
tag string
trustedIps string[]
user string
label String
region String
clusterTimeZone String
databaseEngine String
databaseEngineVersion String
dateCreated String
dbname String
host String
id String
latestBackup String
maintenanceDow String
maintenanceTime String
mysqlLongQueryTime Number
mysqlRequirePrimaryKey Boolean
mysqlSlowQueryLog Boolean
mysqlSqlModes List<String>
password String
plan String
planDisk Number
planRam Number
planReplicas Number
planVcpus Number
port String
redisEvictionPolicy String
status String
tag String
trustedIps List<String>
user String

Package Details

Repository
vultr dirien/pulumi-vultr
License
Apache-2.0
Notes

This Pulumi package is based on the vultr Terraform Provider.