Cloudflare v6.3.0, Jun 10 25

Cloudflare v6.3.0 published on Tuesday, Jun 10, 2025 by Pulumi

cloudflare.HyperdriveConfig

Explore with Pulumi AI

Cloudflare v6.3.0 published on Tuesday, Jun 10, 2025 by Pulumi

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  exampleHyperdriveConfig:
    type: cloudflare:HyperdriveConfig
    name: example_hyperdrive_config
    properties:
      accountId: 023e105f4ecef8ad9ca31a8372d0c353
      name: example-hyperdrive
      origin:
        database: postgres
        host: database.example.com
        password: password
        port: 5432
        scheme: postgres
        user: postgres
      caching:
        disabled: true
      mtls:
        ca_certificate_id: 00000000-0000-0000-0000-0000000000
        mtls_certificate_id: 00000000-0000-0000-0000-0000000000
        sslmode: verify-full

Create HyperdriveConfig Resource

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

Constructor syntax

new HyperdriveConfig(name: string, args: HyperdriveConfigArgs, opts?: CustomResourceOptions);

@overload
def HyperdriveConfig(resource_name: str,
                     args: HyperdriveConfigArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def HyperdriveConfig(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     account_id: Optional[str] = None,
                     name: Optional[str] = None,
                     origin: Optional[HyperdriveConfigOriginArgs] = None,
                     caching: Optional[HyperdriveConfigCachingArgs] = None,
                     mtls: Optional[HyperdriveConfigMtlsArgs] = None)

func NewHyperdriveConfig(ctx *Context, name string, args HyperdriveConfigArgs, opts ...ResourceOption) (*HyperdriveConfig, error)

public HyperdriveConfig(string name, HyperdriveConfigArgs args, CustomResourceOptions? opts = null)

public HyperdriveConfig(String name, HyperdriveConfigArgs args)
public HyperdriveConfig(String name, HyperdriveConfigArgs args, CustomResourceOptions options)

type: cloudflare:HyperdriveConfig
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 HyperdriveConfigArgs: 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 HyperdriveConfigArgs: 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 HyperdriveConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HyperdriveConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args HyperdriveConfigArgs: 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 hyperdriveConfigResource = new Cloudflare.HyperdriveConfig("hyperdriveConfigResource", new()
{
    AccountId = "string",
    Name = "string",
    Origin = new Cloudflare.Inputs.HyperdriveConfigOriginArgs
    {
        Database = "string",
        Host = "string",
        Password = "string",
        Scheme = "string",
        User = "string",
        AccessClientId = "string",
        AccessClientSecret = "string",
        Port = 0,
    },
    Caching = new Cloudflare.Inputs.HyperdriveConfigCachingArgs
    {
        Disabled = false,
        MaxAge = 0,
        StaleWhileRevalidate = 0,
    },
    Mtls = new Cloudflare.Inputs.HyperdriveConfigMtlsArgs
    {
        CaCertificateId = "string",
        MtlsCertificateId = "string",
        Sslmode = "string",
    },
});

example, err := cloudflare.NewHyperdriveConfig(ctx, "hyperdriveConfigResource", &cloudflare.HyperdriveConfigArgs{
	AccountId: pulumi.String("string"),
	Name:      pulumi.String("string"),
	Origin: &cloudflare.HyperdriveConfigOriginArgs{
		Database:           pulumi.String("string"),
		Host:               pulumi.String("string"),
		Password:           pulumi.String("string"),
		Scheme:             pulumi.String("string"),
		User:               pulumi.String("string"),
		AccessClientId:     pulumi.String("string"),
		AccessClientSecret: pulumi.String("string"),
		Port:               pulumi.Int(0),
	},
	Caching: &cloudflare.HyperdriveConfigCachingArgs{
		Disabled:             pulumi.Bool(false),
		MaxAge:               pulumi.Int(0),
		StaleWhileRevalidate: pulumi.Int(0),
	},
	Mtls: &cloudflare.HyperdriveConfigMtlsArgs{
		CaCertificateId:   pulumi.String("string"),
		MtlsCertificateId: pulumi.String("string"),
		Sslmode:           pulumi.String("string"),
	},
})

var hyperdriveConfigResource = new HyperdriveConfig("hyperdriveConfigResource", HyperdriveConfigArgs.builder()
    .accountId("string")
    .name("string")
    .origin(HyperdriveConfigOriginArgs.builder()
        .database("string")
        .host("string")
        .password("string")
        .scheme("string")
        .user("string")
        .accessClientId("string")
        .accessClientSecret("string")
        .port(0)
        .build())
    .caching(HyperdriveConfigCachingArgs.builder()
        .disabled(false)
        .maxAge(0)
        .staleWhileRevalidate(0)
        .build())
    .mtls(HyperdriveConfigMtlsArgs.builder()
        .caCertificateId("string")
        .mtlsCertificateId("string")
        .sslmode("string")
        .build())
    .build());

hyperdrive_config_resource = cloudflare.HyperdriveConfig("hyperdriveConfigResource",
    account_id="string",
    name="string",
    origin={
        "database": "string",
        "host": "string",
        "password": "string",
        "scheme": "string",
        "user": "string",
        "access_client_id": "string",
        "access_client_secret": "string",
        "port": 0,
    },
    caching={
        "disabled": False,
        "max_age": 0,
        "stale_while_revalidate": 0,
    },
    mtls={
        "ca_certificate_id": "string",
        "mtls_certificate_id": "string",
        "sslmode": "string",
    })

const hyperdriveConfigResource = new cloudflare.HyperdriveConfig("hyperdriveConfigResource", {
    accountId: "string",
    name: "string",
    origin: {
        database: "string",
        host: "string",
        password: "string",
        scheme: "string",
        user: "string",
        accessClientId: "string",
        accessClientSecret: "string",
        port: 0,
    },
    caching: {
        disabled: false,
        maxAge: 0,
        staleWhileRevalidate: 0,
    },
    mtls: {
        caCertificateId: "string",
        mtlsCertificateId: "string",
        sslmode: "string",
    },
});

type: cloudflare:HyperdriveConfig
properties:
    accountId: string
    caching:
        disabled: false
        maxAge: 0
        staleWhileRevalidate: 0
    mtls:
        caCertificateId: string
        mtlsCertificateId: string
        sslmode: string
    name: string
    origin:
        accessClientId: string
        accessClientSecret: string
        database: string
        host: string
        password: string
        port: 0
        scheme: string
        user: string

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

AccountId string: Define configurations using a unique string identifier.
Name string
Origin HyperdriveConfigOrigin
Caching HyperdriveConfigCaching
Mtls HyperdriveConfigMtls

AccountId string: Define configurations using a unique string identifier.
Name string
Origin HyperdriveConfigOriginArgs
Caching HyperdriveConfigCachingArgs
Mtls HyperdriveConfigMtlsArgs

accountId String: Define configurations using a unique string identifier.
name String
origin HyperdriveConfigOrigin
caching HyperdriveConfigCaching
mtls HyperdriveConfigMtls

accountId string: Define configurations using a unique string identifier.
name string
origin HyperdriveConfigOrigin
caching HyperdriveConfigCaching
mtls HyperdriveConfigMtls

account_id str: Define configurations using a unique string identifier.
name str
origin HyperdriveConfigOriginArgs
caching HyperdriveConfigCachingArgs
mtls HyperdriveConfigMtlsArgs

accountId String: Define configurations using a unique string identifier.
name String
origin Property Map
caching Property Map
mtls Property Map

Outputs

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

CreatedOn string: Defines the creation time of the Hyperdrive configuration.
Id string: The provider-assigned unique ID for this managed resource.
ModifiedOn string: Defines the last modified time of the Hyperdrive configuration.

CreatedOn string: Defines the creation time of the Hyperdrive configuration.
Id string: The provider-assigned unique ID for this managed resource.
ModifiedOn string: Defines the last modified time of the Hyperdrive configuration.

createdOn String: Defines the creation time of the Hyperdrive configuration.
id String: The provider-assigned unique ID for this managed resource.
modifiedOn String: Defines the last modified time of the Hyperdrive configuration.

createdOn string: Defines the creation time of the Hyperdrive configuration.
id string: The provider-assigned unique ID for this managed resource.
modifiedOn string: Defines the last modified time of the Hyperdrive configuration.

created_on str: Defines the creation time of the Hyperdrive configuration.
id str: The provider-assigned unique ID for this managed resource.
modified_on str: Defines the last modified time of the Hyperdrive configuration.

createdOn String: Defines the creation time of the Hyperdrive configuration.
id String: The provider-assigned unique ID for this managed resource.
modifiedOn String: Defines the last modified time of the Hyperdrive configuration.

Look up Existing HyperdriveConfig Resource

Get an existing HyperdriveConfig 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?: HyperdriveConfigState, opts?: CustomResourceOptions): HyperdriveConfig

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        caching: Optional[HyperdriveConfigCachingArgs] = None,
        created_on: Optional[str] = None,
        modified_on: Optional[str] = None,
        mtls: Optional[HyperdriveConfigMtlsArgs] = None,
        name: Optional[str] = None,
        origin: Optional[HyperdriveConfigOriginArgs] = None) -> HyperdriveConfig

func GetHyperdriveConfig(ctx *Context, name string, id IDInput, state *HyperdriveConfigState, opts ...ResourceOption) (*HyperdriveConfig, error)

public static HyperdriveConfig Get(string name, Input<string> id, HyperdriveConfigState? state, CustomResourceOptions? opts = null)

public static HyperdriveConfig get(String name, Output<String> id, HyperdriveConfigState state, CustomResourceOptions options)

resources:  _:    type: cloudflare:HyperdriveConfig    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:

AccountId string: Define configurations using a unique string identifier.
Caching HyperdriveConfigCaching
CreatedOn string: Defines the creation time of the Hyperdrive configuration.
ModifiedOn string: Defines the last modified time of the Hyperdrive configuration.
Mtls HyperdriveConfigMtls
Name string
Origin HyperdriveConfigOrigin

AccountId string: Define configurations using a unique string identifier.
Caching HyperdriveConfigCachingArgs
CreatedOn string: Defines the creation time of the Hyperdrive configuration.
ModifiedOn string: Defines the last modified time of the Hyperdrive configuration.
Mtls HyperdriveConfigMtlsArgs
Name string
Origin HyperdriveConfigOriginArgs

accountId String: Define configurations using a unique string identifier.
caching HyperdriveConfigCaching
createdOn String: Defines the creation time of the Hyperdrive configuration.
modifiedOn String: Defines the last modified time of the Hyperdrive configuration.
mtls HyperdriveConfigMtls
name String
origin HyperdriveConfigOrigin

accountId string: Define configurations using a unique string identifier.
caching HyperdriveConfigCaching
createdOn string: Defines the creation time of the Hyperdrive configuration.
modifiedOn string: Defines the last modified time of the Hyperdrive configuration.
mtls HyperdriveConfigMtls
name string
origin HyperdriveConfigOrigin

account_id str: Define configurations using a unique string identifier.
caching HyperdriveConfigCachingArgs
created_on str: Defines the creation time of the Hyperdrive configuration.
modified_on str: Defines the last modified time of the Hyperdrive configuration.
mtls HyperdriveConfigMtlsArgs
name str
origin HyperdriveConfigOriginArgs

accountId String: Define configurations using a unique string identifier.
caching Property Map
createdOn String: Defines the creation time of the Hyperdrive configuration.
modifiedOn String: Defines the last modified time of the Hyperdrive configuration.
mtls Property Map
name String
origin Property Map

Supporting Types

HyperdriveConfigCaching, HyperdriveConfigCachingArgs

Disabled bool: Set to true to disable caching of SQL responses. Default is false.
MaxAge int: Specify the maximum duration items should persist in the cache. Not returned if set to the default (60).
StaleWhileRevalidate int: Specify the number of seconds the cache may serve a stale response. Omitted if set to the default (15).

Disabled bool: Set to true to disable caching of SQL responses. Default is false.
MaxAge int: Specify the maximum duration items should persist in the cache. Not returned if set to the default (60).
StaleWhileRevalidate int: Specify the number of seconds the cache may serve a stale response. Omitted if set to the default (15).

disabled Boolean: Set to true to disable caching of SQL responses. Default is false.
maxAge Integer: Specify the maximum duration items should persist in the cache. Not returned if set to the default (60).
staleWhileRevalidate Integer: Specify the number of seconds the cache may serve a stale response. Omitted if set to the default (15).

disabled boolean: Set to true to disable caching of SQL responses. Default is false.
maxAge number: Specify the maximum duration items should persist in the cache. Not returned if set to the default (60).
staleWhileRevalidate number: Specify the number of seconds the cache may serve a stale response. Omitted if set to the default (15).

disabled bool: Set to true to disable caching of SQL responses. Default is false.
max_age int: Specify the maximum duration items should persist in the cache. Not returned if set to the default (60).
stale_while_revalidate int: Specify the number of seconds the cache may serve a stale response. Omitted if set to the default (15).

disabled Boolean: Set to true to disable caching of SQL responses. Default is false.
maxAge Number: Specify the maximum duration items should persist in the cache. Not returned if set to the default (60).
staleWhileRevalidate Number: Specify the number of seconds the cache may serve a stale response. Omitted if set to the default (15).

HyperdriveConfigMtls, HyperdriveConfigMtlsArgs

CaCertificateId string: Define CA certificate ID obtained after uploading CA cert.
MtlsCertificateId string: Define mTLS certificate ID obtained after uploading client cert.
Sslmode string: Set SSL mode to 'require', 'verify-ca', or 'verify-full' to verify the CA.

CaCertificateId string: Define CA certificate ID obtained after uploading CA cert.
MtlsCertificateId string: Define mTLS certificate ID obtained after uploading client cert.
Sslmode string: Set SSL mode to 'require', 'verify-ca', or 'verify-full' to verify the CA.

caCertificateId String: Define CA certificate ID obtained after uploading CA cert.
mtlsCertificateId String: Define mTLS certificate ID obtained after uploading client cert.
sslmode String: Set SSL mode to 'require', 'verify-ca', or 'verify-full' to verify the CA.

caCertificateId string: Define CA certificate ID obtained after uploading CA cert.
mtlsCertificateId string: Define mTLS certificate ID obtained after uploading client cert.
sslmode string: Set SSL mode to 'require', 'verify-ca', or 'verify-full' to verify the CA.

ca_certificate_id str: Define CA certificate ID obtained after uploading CA cert.
mtls_certificate_id str: Define mTLS certificate ID obtained after uploading client cert.
sslmode str: Set SSL mode to 'require', 'verify-ca', or 'verify-full' to verify the CA.

caCertificateId String: Define CA certificate ID obtained after uploading CA cert.
mtlsCertificateId String: Define mTLS certificate ID obtained after uploading client cert.
sslmode String: Set SSL mode to 'require', 'verify-ca', or 'verify-full' to verify the CA.

HyperdriveConfigOrigin, HyperdriveConfigOriginArgs

Database string: Set the name of your origin database.
Host string: Defines the host (hostname or IP) of your origin database.
Password string: Set the password needed to access your origin database. The API never returns this write-only value.
Scheme string: Specifies the URL scheme used to connect to your origin database. Available values: "postgres", "postgresql", "mysql".
User string: Set the user of your origin database.
AccessClientId string: Defines the Client ID of the Access token to use when connecting to the origin database.
AccessClientSecret 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.
Port int: Defines the port (default: 5432 for Postgres) of your origin database.

Database string: Set the name of your origin database.
Host string: Defines the host (hostname or IP) of your origin database.
Password string: Set the password needed to access your origin database. The API never returns this write-only value.
Scheme string: Specifies the URL scheme used to connect to your origin database. Available values: "postgres", "postgresql", "mysql".
User string: Set the user of your origin database.
AccessClientId string: Defines the Client ID of the Access token to use when connecting to the origin database.
AccessClientSecret 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.
Port int: Defines the port (default: 5432 for Postgres) of your origin database.

database String: Set the name of your origin database.
host String: Defines the host (hostname or IP) of your origin database.
password String: Set the password needed to access your origin database. The API never returns this write-only value.
scheme String: Specifies the URL scheme used to connect to your origin database. Available values: "postgres", "postgresql", "mysql".
user String: Set the user of your origin database.
accessClientId String: Defines the Client ID of the Access token to use when connecting to the origin database.
accessClientSecret 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.
port Integer: Defines the port (default: 5432 for Postgres) of your origin database.

database string: Set the name of your origin database.
host string: Defines the host (hostname or IP) of your origin database.
password string: Set the password needed to access your origin database. The API never returns this write-only value.
scheme string: Specifies the URL scheme used to connect to your origin database. Available values: "postgres", "postgresql", "mysql".
user string: Set the user of your origin database.
accessClientId string: Defines the Client ID of the Access token to use when connecting to the origin database.
accessClientSecret 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.
port number: Defines the port (default: 5432 for Postgres) of your origin database.

database str: Set the name of your origin database.
host str: Defines the host (hostname or IP) of your origin database.
password str: Set the password needed to access your origin database. The API never returns this write-only value.
scheme str: Specifies the URL scheme used to connect to your origin database. Available values: "postgres", "postgresql", "mysql".
user str: Set the user of your origin database.
access_client_id str: Defines the Client ID of the Access token to use when connecting to the origin database.
access_client_secret str: Defines the Client Secret of the Access Token to use when connecting to the origin database. The API never returns this write-only value.
port int: Defines the port (default: 5432 for Postgres) of your origin database.

database String: Set the name of your origin database.
host String: Defines the host (hostname or IP) of your origin database.
password String: Set the password needed to access your origin database. The API never returns this write-only value.
scheme String: Specifies the URL scheme used to connect to your origin database. Available values: "postgres", "postgresql", "mysql".
user String: Set the user of your origin database.
accessClientId String: Defines the Client ID of the Access token to use when connecting to the origin database.
accessClientSecret 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.
port Number: Defines the port (default: 5432 for Postgres) of your origin database.

Import

$ pulumi import cloudflare:index/hyperdriveConfig:HyperdriveConfig example '<account_id>/<hyperdrive_id>'

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

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.3.0 published on Tuesday, Jun 10, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.HyperdriveConfig

On this page

On this page

Example Usage

Create HyperdriveConfig Resource

Constructor syntax

Parameters

Constructor example

HyperdriveConfig Resource Properties

Inputs

Outputs

Look up Existing HyperdriveConfig Resource

Supporting Types

HyperdriveConfigCaching, HyperdriveConfigCachingArgs

HyperdriveConfigMtls, HyperdriveConfigMtlsArgs

HyperdriveConfigOrigin, HyperdriveConfigOriginArgs

Import

Package Details

On this page

On this page