1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getHyperdriveConfig
Cloudflare v6.3.0 published on Tuesday, Jun 10, 2025 by Pulumi

cloudflare.getHyperdriveConfig

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleHyperdriveConfig = cloudflare.getHyperdriveConfig({
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
        hyperdriveId: "023e105f4ecef8ad9ca31a8372d0c353",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_hyperdrive_config = cloudflare.get_hyperdrive_config(account_id="023e105f4ecef8ad9ca31a8372d0c353",
        hyperdrive_id="023e105f4ecef8ad9ca31a8372d0c353")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.LookupHyperdriveConfig(ctx, &cloudflare.LookupHyperdriveConfigArgs{
    			AccountId:    "023e105f4ecef8ad9ca31a8372d0c353",
    			HyperdriveId: pulumi.StringRef("023e105f4ecef8ad9ca31a8372d0c353"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleHyperdriveConfig = Cloudflare.GetHyperdriveConfig.Invoke(new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
            HyperdriveId = "023e105f4ecef8ad9ca31a8372d0c353",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CloudflareFunctions;
    import com.pulumi.cloudflare.inputs.GetHyperdriveConfigArgs;
    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) {
            final var exampleHyperdriveConfig = CloudflareFunctions.getHyperdriveConfig(GetHyperdriveConfigArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .hyperdriveId("023e105f4ecef8ad9ca31a8372d0c353")
                .build());
    
        }
    }
    
    variables:
      exampleHyperdriveConfig:
        fn::invoke:
          function: cloudflare:getHyperdriveConfig
          arguments:
            accountId: 023e105f4ecef8ad9ca31a8372d0c353
            hyperdriveId: 023e105f4ecef8ad9ca31a8372d0c353
    

    Using getHyperdriveConfig

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getHyperdriveConfig(args: GetHyperdriveConfigArgs, opts?: InvokeOptions): Promise<GetHyperdriveConfigResult>
    function getHyperdriveConfigOutput(args: GetHyperdriveConfigOutputArgs, opts?: InvokeOptions): Output<GetHyperdriveConfigResult>
    def get_hyperdrive_config(account_id: Optional[str] = None,
                              hyperdrive_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetHyperdriveConfigResult
    def get_hyperdrive_config_output(account_id: Optional[pulumi.Input[str]] = None,
                              hyperdrive_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetHyperdriveConfigResult]
    func LookupHyperdriveConfig(ctx *Context, args *LookupHyperdriveConfigArgs, opts ...InvokeOption) (*LookupHyperdriveConfigResult, error)
    func LookupHyperdriveConfigOutput(ctx *Context, args *LookupHyperdriveConfigOutputArgs, opts ...InvokeOption) LookupHyperdriveConfigResultOutput

    > Note: This function is named LookupHyperdriveConfig in the Go SDK.

    public static class GetHyperdriveConfig 
    {
        public static Task<GetHyperdriveConfigResult> InvokeAsync(GetHyperdriveConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetHyperdriveConfigResult> Invoke(GetHyperdriveConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHyperdriveConfigResult> getHyperdriveConfig(GetHyperdriveConfigArgs args, InvokeOptions options)
    public static Output<GetHyperdriveConfigResult> getHyperdriveConfig(GetHyperdriveConfigArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getHyperdriveConfig:getHyperdriveConfig
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    Define configurations using a unique string identifier.
    HyperdriveId string
    Define configurations using a unique string identifier.
    AccountId string
    Define configurations using a unique string identifier.
    HyperdriveId string
    Define configurations using a unique string identifier.
    accountId String
    Define configurations using a unique string identifier.
    hyperdriveId String
    Define configurations using a unique string identifier.
    accountId string
    Define configurations using a unique string identifier.
    hyperdriveId string
    Define configurations using a unique string identifier.
    account_id str
    Define configurations using a unique string identifier.
    hyperdrive_id str
    Define configurations using a unique string identifier.
    accountId String
    Define configurations using a unique string identifier.
    hyperdriveId String
    Define configurations using a unique string identifier.

    getHyperdriveConfig Result

    The following output properties are available:

    AccountId string
    Define configurations using a unique string identifier.
    Caching GetHyperdriveConfigCaching
    CreatedOn string
    Defines the creation time of the Hyperdrive configuration.
    Id string
    Define configurations using a unique string identifier.
    ModifiedOn string
    Defines the last modified time of the Hyperdrive configuration.
    Mtls GetHyperdriveConfigMtls
    Name string
    Origin GetHyperdriveConfigOrigin
    HyperdriveId string
    Define configurations using a unique string identifier.
    AccountId string
    Define configurations using a unique string identifier.
    Caching GetHyperdriveConfigCaching
    CreatedOn string
    Defines the creation time of the Hyperdrive configuration.
    Id string
    Define configurations using a unique string identifier.
    ModifiedOn string
    Defines the last modified time of the Hyperdrive configuration.
    Mtls GetHyperdriveConfigMtls
    Name string
    Origin GetHyperdriveConfigOrigin
    HyperdriveId string
    Define configurations using a unique string identifier.
    accountId String
    Define configurations using a unique string identifier.
    caching GetHyperdriveConfigCaching
    createdOn String
    Defines the creation time of the Hyperdrive configuration.
    id String
    Define configurations using a unique string identifier.
    modifiedOn String
    Defines the last modified time of the Hyperdrive configuration.
    mtls GetHyperdriveConfigMtls
    name String
    origin GetHyperdriveConfigOrigin
    hyperdriveId String
    Define configurations using a unique string identifier.
    accountId string
    Define configurations using a unique string identifier.
    caching GetHyperdriveConfigCaching
    createdOn string
    Defines the creation time of the Hyperdrive configuration.
    id string
    Define configurations using a unique string identifier.
    modifiedOn string
    Defines the last modified time of the Hyperdrive configuration.
    mtls GetHyperdriveConfigMtls
    name string
    origin GetHyperdriveConfigOrigin
    hyperdriveId string
    Define configurations using a unique string identifier.
    account_id str
    Define configurations using a unique string identifier.
    caching GetHyperdriveConfigCaching
    created_on str
    Defines the creation time of the Hyperdrive configuration.
    id str
    Define configurations using a unique string identifier.
    modified_on str
    Defines the last modified time of the Hyperdrive configuration.
    mtls GetHyperdriveConfigMtls
    name str
    origin GetHyperdriveConfigOrigin
    hyperdrive_id str
    Define configurations using a unique string identifier.
    accountId String
    Define configurations using a unique string identifier.
    caching Property Map
    createdOn String
    Defines the creation time of the Hyperdrive configuration.
    id String
    Define configurations using a unique string identifier.
    modifiedOn String
    Defines the last modified time of the Hyperdrive configuration.
    mtls Property Map
    name String
    origin Property Map
    hyperdriveId String
    Define configurations using a unique string identifier.

    Supporting Types

    GetHyperdriveConfigCaching

    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).

    GetHyperdriveConfigMtls

    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.

    GetHyperdriveConfigOrigin

    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.
    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.
    Port int
    Defines the port (default: 5432 for Postgres) of your origin database.
    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.
    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.
    Port int
    Defines the port (default: 5432 for Postgres) of your origin database.
    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.
    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.
    port Integer
    Defines the port (default: 5432 for Postgres) of your origin database.
    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.
    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.
    port number
    Defines the port (default: 5432 for Postgres) of your origin database.
    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.
    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.
    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.
    port int
    Defines the port (default: 5432 for Postgres) of your origin database.
    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.
    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.
    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.
    port Number
    Defines the port (default: 5432 for Postgres) of your origin database.
    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.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.3.0 published on Tuesday, Jun 10, 2025 by Pulumi