--- title: Hyperdrive --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/terraform) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Hyperdrive #### HyperdriveConfigs #### resource cloudflare\_hyperdrive\_config ##### required Expand Collapse account\_id: String Define configurations using a unique string identifier. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20account_id>) name: String The name of the Hyperdrive configuration. Used to identify the configuration in the Cloudflare dashboard and API. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20name>) ##### optional Expand Collapse integration?: JSON [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20integration>) origin\_connection\_limit?: Int64 The (soft) maximum number of connections the Hyperdrive is allowed to make to the origin database. Maximum allowed: 20 for free tier accounts, 100 for paid tier accounts. If not specified, defaults to 20 for free tier and 60 for paid tier. Certain Cloudflare-managed origins may be permitted a higher limit. Contact Cloudflare if you need a higher limit. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20origin_connection_limit>)

caching?: Attributes

disabled?: Bool Link to this property max\_age?: Int64 Link to this property stale\_while\_revalidate?: Int64 Link to this property

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20caching>)

mtls?: Attributes mTLS configuration for the origin connection. Cannot be used with VPC Service origins; TLS must be managed on the VPC Service.

ca\_certificate\_id?: String Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id?: String Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode?: String PostgreSQL accepts require, verify-ca, and verify-full. MySQL accepts REQUIRED, VERIFY_CA, and VERIFY_IDENTITY. The verify modes require a CA certificate; the require modes cannot be used with a CA certificate. Link to this property

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20mtls>)

origin?: Attributes Combines database connection fields with exactly one supported network location.

database: String Set the name of your origin database. Link to this property host?: String Defines the publicly reachable hostname or IP of your origin database. Private, loopback, and link-local IP addresses are not allowed. Link to this property password: String Set the password needed to access your origin database. The API never returns this write-only value. Link to this property port?: Int64 Defines the port of your origin database. Defaults to 5432 for PostgreSQL or 3306 for MySQL if not specified. Link to this property scheme: String Specifies the URL scheme used to connect to your origin database. Link to this property user: String Set the user of your origin database. Link to this property access\_client\_id?: String Defines the Client ID of the Access token to use when connecting to the origin database. Link to this property access\_client\_secret?: String Defines the Client Secret of the Access Token to use when connecting to the origin database. The API never returns this write-only value. Link to this property service\_id?: String The identifier of the Workers VPC Service to connect through. Hyperdrive will egress through the specified VPC Service to reach the origin database. Link to this property

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20origin>) ##### computed Expand Collapse id: String Define configurations using a unique string identifier. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20id>) created\_on: Time Defines the creation time of the Hyperdrive configuration. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20created_on>) modified\_on: Time Defines the last modified time of the Hyperdrive configuration. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20modified_on>) restarted\_on: Time Defines the last time the Hyperdrive connection pool was explicitly restarted via the restart endpoint. Omitted if the pool has never been explicitly restarted. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20restarted_on>) ### cloudflare\_hyperdrive\_config Terraform HTTPTypeScriptPythonGoTerraform ``` resource "cloudflare_hyperdrive_config" "example_hyperdrive_config" { account_id = "023e105f4ecef8ad9ca31a8372d0c353" name = "example-hyperdrive" origin = { database = "postgres" host = "database.example.com" password = "password" port = 5432 scheme = "postgres" user = "postgres" } caching = { disabled = true max_age = 0 stale_while_revalidate = 0 } integration = { } mtls = { ca_certificate_id = "00000000-0000-0000-0000-0000000000" mtls_certificate_id = "00000000-0000-0000-0000-0000000000" sslmode = "verify-full" } origin_connection_limit = 60 } ``` #### data cloudflare\_hyperdrive\_config ##### required Expand Collapse hyperdrive\_id: String Define configurations using a unique string identifier. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20hyperdrive_id>) account\_id: String Define configurations using a unique string identifier. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20account_id>) ##### computed Expand Collapse id: String Define configurations using a unique string identifier. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20id>) created\_on: Time Defines the creation time of the Hyperdrive configuration. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20created_on>) modified\_on: Time Defines the last modified time of the Hyperdrive configuration. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20modified_on>) name: String The name of the Hyperdrive configuration. Used to identify the configuration in the Cloudflare dashboard and API. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20name>) origin\_connection\_limit: Int64 The (soft) maximum number of connections the Hyperdrive is allowed to make to the origin database. Maximum allowed: 20 for free tier accounts, 100 for paid tier accounts. If not specified, defaults to 20 for free tier and 60 for paid tier. Certain Cloudflare-managed origins may be permitted a higher limit. Contact Cloudflare if you need a higher limit. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20origin_connection_limit>) restarted\_on: Time Defines the last time the Hyperdrive connection pool was explicitly restarted via the restart endpoint. Omitted if the pool has never been explicitly restarted. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20restarted_on>)

caching: Attributes

disabled: Bool Defines whether caching is disabled. Link to this property max\_age: Int64 Defines the maximum duration (in seconds) items persist in the cache. Link to this property stale\_while\_revalidate: Int64 Defines the number of seconds the cache may serve a stale response. Link to this property

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20caching>)

integration: Attributes Connects to a PlanetScale database using credentials managed by Cloudflare. The Cloudflare account must already be linked to PlanetScale in the Hyperdrive dashboard.

database\_branch\_name: String The name of the PlanetScale database branch. Link to this property database\_name: String The name of the PlanetScale database. Link to this property organization\_name: String The name of the PlanetScale organization. Link to this property hyperdrive\_config\_provider: String The database integration provider used by this operation. Link to this property scheme: String Specifies the URL scheme used to connect to your origin database. Link to this property custom\_database\_name: String The database name to use when connecting. Defaults to postgres for PostgreSQL and mysql for MySQL. Link to this property

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20integration>)

mtls: Attributes mTLS configuration for the origin connection. Cannot be used with VPC Service origins; TLS must be managed on the VPC Service.

ca\_certificate\_id: String Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id: String Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode: String PostgreSQL accepts require, verify-ca, and verify-full. MySQL accepts REQUIRED, VERIFY_CA, and VERIFY_IDENTITY. The verify modes require a CA certificate; the require modes cannot be used with a CA certificate. Link to this property

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20mtls>)

origin: Attributes Combines database connection fields with exactly one supported network location.

database: String Set the name of your origin database. Link to this property host: String Defines the publicly reachable hostname or IP of your origin database. Private, loopback, and link-local IP addresses are not allowed. Link to this property password: String Set the password needed to access your origin database. The API never returns this write-only value. Link to this property port: Int64 Defines the port of your origin database. Defaults to 5432 for PostgreSQL or 3306 for MySQL if not specified. Link to this property scheme: String Specifies the URL scheme used to connect to your origin database. Link to this property user: String Set the user of your origin database. Link to this property access\_client\_id: String Defines the Client ID of the Access token to use when connecting to the origin database. Link to this property access\_client\_secret: String Defines the Client Secret of the Access Token to use when connecting to the origin database. The API never returns this write-only value. Link to this property service\_id: String The identifier of the Workers VPC Service to connect through. Hyperdrive will egress through the specified VPC Service to reach the origin database. Link to this property

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20origin>) ### cloudflare\_hyperdrive\_config Terraform HTTPTypeScriptPythonGoTerraform ``` data "cloudflare_hyperdrive_config" "example_hyperdrive_config" { account_id = "023e105f4ecef8ad9ca31a8372d0c353" hyperdrive_id = "023e105f4ecef8ad9ca31a8372d0c353" } ``` #### data cloudflare\_hyperdrive\_configs ##### required Expand Collapse account\_id: String Define configurations using a unique string identifier. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20account_id>) ##### optional Expand Collapse max\_items?: Int64 Max items to fetch, default: 1000 [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20max_items>) ##### computed Expand Collapse

result: List\[Attributes] The items returned by the data source

id: String Define configurations using a unique string identifier. Link to this property

caching: Attributes

Link to this property name: String The name of the Hyperdrive configuration. Used to identify the configuration in the Cloudflare dashboard and API. Link to this property

origin: Attributes Combines database connection fields with exactly one supported network location.

Link to this property created\_on: Time Defines the creation time of the Hyperdrive configuration. Link to this property

integration: Attributes Connects to a PlanetScale database using credentials managed by Cloudflare. The Cloudflare account must already be linked to PlanetScale in the Hyperdrive dashboard.

Link to this property modified\_on: Time Defines the last modified time of the Hyperdrive configuration. Link to this property

mtls: Attributes mTLS configuration for the origin connection. Cannot be used with VPC Service origins; TLS must be managed on the VPC Service.

Link to this property origin\_connection\_limit: Int64 The (soft) maximum number of connections the Hyperdrive is allowed to make to the origin database. Maximum allowed: 20 for free tier accounts, 100 for paid tier accounts. If not specified, defaults to 20 for free tier and 60 for paid tier. Certain Cloudflare-managed origins may be permitted a higher limit. Contact Cloudflare if you need a higher limit. Link to this property restarted\_on: Time Defines the last time the Hyperdrive connection pool was explicitly restarted via the restart endpoint. Omitted if the pool has never been explicitly restarted. Link to this property

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20result>) ### cloudflare\_hyperdrive\_configs Terraform HTTPTypeScriptPythonGoTerraform ``` data "cloudflare_hyperdrive_configs" "example_hyperdrive_configs" { account_id = "023e105f4ecef8ad9ca31a8372d0c353" } ```