Vultr DocsLatest Content


vultr_database

Updated on 15 September, 2025

A data source that retrieves information about a Vultr managed database instance by filtering on attributes like label


Get information about a Vultr database.

Example Usage

Get the information for a database by label:

hcl
data "vultr_database" "my_database" {
  filter {
    name   = "label"
    values = ["my-database-label"]
  }
}

Argument Reference

The following arguments are supported:

  • filter - (Required) Query parameters for finding databases.

The filter block supports the following:

  • name - Attribute name to filter with.
  • values - One or more values filter with.

Attributes Reference

The following attributes are exported:

  • date_created - The date the managed database was added to your Vultr account.
  • plan - The managed database's plan ID.
  • plan_disk - The description of the disk(s) on the managed database.
  • plan_ram - The amount of memory available on the managed database in MB.
  • plan_vcpus - The number of virtual CPUs available on the managed database.
  • plan_replicas - The number of standby nodes available on the managed database.
  • region - The region ID of the managed database.
  • status - The current status of the managed database (poweroff, rebuilding, rebalancing, configuring, running).
  • label - The managed database's label.
  • tag - The managed database's tag.
  • database_engine - The database engine of the managed database.
  • database_engine_version - The database engine version of the managed database.
  • vpc_id - The ID of the VPC Network attached to the Managed Database.
  • dbname - The managed database's default logical database.
  • host - The hostname assigned to the managed database.
  • public_host - The public hostname assigned to the managed database (VPC-attached only).
  • port - The connection port for the managed database.
  • sasl_port - The SASL connection port for the managed database (Kafka engine types only).
  • user - The primary admin user for the managed database.
  • password - The password for the managed database's primary admin user.
  • access_key - The private key to authenticate the default user (Kafka engine types only).
  • access_cert - The certificate to authenticate the default user (Kafka engine types only).
  • enable_kafka_rest - The configuration value for Kafka REST support (Kafka engine types only).
  • kafka_rest_uri - The URI to access the RESTful interface of your Kafka cluster if Kafka REST is enabled (Kafka engine types only).
  • enable_schema_registry - The configuration value for Schema Registry support (Kafka engine types only).
  • schema_registry_uri - The URI to access the Schema Registry service of your Kafka cluster if Schema Registry is enabled (Kafka engine types only).
  • enable_kafka_connect - The configuration value for Kafka Connect support (Kafka engine types only).
  • maintenance_dow - The preferred maintenance day of week for the managed database.
  • maintenance_time - The preferred maintenance time for the managed database.
  • backup_hour - The preferred hour of the day (UTC) for daily backups to take place (unavailable for Kafka engine types).
  • backup_minute - The preferred minute of the backup hour for daily backups to take place (unavailable for Kafka engine types).
  • latest_backup - The date of the latest backup available on the managed database.
  • trusted_ips - A list of allowed IP addresses for the managed database.
  • mysql_sql_modes - A list of SQL modes currently configured for the managed database (MySQL engine types only).
  • mysql_require_primary_key - The configuration value for whether primary keys are required on the managed database (MySQL engine types only).
  • mysql_slow_query_log - The configuration value for slow query logging on the managed database (MySQL engine types only).
  • mysql_long_query_time - The configuration value for the long query time (in seconds) on the managed database (MySQL engine types only).
  • eviction_policy - The configuration value for the data eviction policy on the managed database (Valkey engine types only).
  • cluster_time_zone - The configured time zone for the Managed Database in TZ database format.
  • read_replicas - A list of read replicas attached to the managed database.

Comments

No comments yet.