1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getHyperdriveConfig
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getHyperdriveConfig

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 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
    Identifier
    HyperdriveId string
    Identifier
    AccountId string
    Identifier
    HyperdriveId string
    Identifier
    accountId String
    Identifier
    hyperdriveId String
    Identifier
    accountId string
    Identifier
    hyperdriveId string
    Identifier
    account_id str
    Identifier
    hyperdrive_id str
    Identifier
    accountId String
    Identifier
    hyperdriveId String
    Identifier

    getHyperdriveConfig Result

    The following output properties are available:

    AccountId string
    Identifier
    Caching GetHyperdriveConfigCaching
    CreatedOn string
    When the Hyperdrive configuration was created.
    Id string
    Identifier
    ModifiedOn string
    When the Hyperdrive configuration was last modified.
    Name string
    Origin GetHyperdriveConfigOrigin
    HyperdriveId string
    Identifier
    AccountId string
    Identifier
    Caching GetHyperdriveConfigCaching
    CreatedOn string
    When the Hyperdrive configuration was created.
    Id string
    Identifier
    ModifiedOn string
    When the Hyperdrive configuration was last modified.
    Name string
    Origin GetHyperdriveConfigOrigin
    HyperdriveId string
    Identifier
    accountId String
    Identifier
    caching GetHyperdriveConfigCaching
    createdOn String
    When the Hyperdrive configuration was created.
    id String
    Identifier
    modifiedOn String
    When the Hyperdrive configuration was last modified.
    name String
    origin GetHyperdriveConfigOrigin
    hyperdriveId String
    Identifier
    accountId string
    Identifier
    caching GetHyperdriveConfigCaching
    createdOn string
    When the Hyperdrive configuration was created.
    id string
    Identifier
    modifiedOn string
    When the Hyperdrive configuration was last modified.
    name string
    origin GetHyperdriveConfigOrigin
    hyperdriveId string
    Identifier
    account_id str
    Identifier
    caching GetHyperdriveConfigCaching
    created_on str
    When the Hyperdrive configuration was created.
    id str
    Identifier
    modified_on str
    When the Hyperdrive configuration was last modified.
    name str
    origin GetHyperdriveConfigOrigin
    hyperdrive_id str
    Identifier
    accountId String
    Identifier
    caching Property Map
    createdOn String
    When the Hyperdrive configuration was created.
    id String
    Identifier
    modifiedOn String
    When the Hyperdrive configuration was last modified.
    name String
    origin Property Map
    hyperdriveId String
    Identifier

    Supporting Types

    GetHyperdriveConfigCaching

    Disabled bool
    When set to true, disables the caching of SQL responses. (Default: false)
    MaxAge int
    When present, specifies max duration for which items should persist in the cache. Not returned if set to default. (Default: 60)
    StaleWhileRevalidate int
    When present, indicates the number of seconds cache may serve the response after it becomes stale. Not returned if set to default. (Default: 15)
    Disabled bool
    When set to true, disables the caching of SQL responses. (Default: false)
    MaxAge int
    When present, specifies max duration for which items should persist in the cache. Not returned if set to default. (Default: 60)
    StaleWhileRevalidate int
    When present, indicates the number of seconds cache may serve the response after it becomes stale. Not returned if set to default. (Default: 15)
    disabled Boolean
    When set to true, disables the caching of SQL responses. (Default: false)
    maxAge Integer
    When present, specifies max duration for which items should persist in the cache. Not returned if set to default. (Default: 60)
    staleWhileRevalidate Integer
    When present, indicates the number of seconds cache may serve the response after it becomes stale. Not returned if set to default. (Default: 15)
    disabled boolean
    When set to true, disables the caching of SQL responses. (Default: false)
    maxAge number
    When present, specifies max duration for which items should persist in the cache. Not returned if set to default. (Default: 60)
    staleWhileRevalidate number
    When present, indicates the number of seconds cache may serve the response after it becomes stale. Not returned if set to default. (Default: 15)
    disabled bool
    When set to true, disables the caching of SQL responses. (Default: false)
    max_age int
    When present, specifies max duration for which items should persist in the cache. Not returned if set to default. (Default: 60)
    stale_while_revalidate int
    When present, indicates the number of seconds cache may serve the response after it becomes stale. Not returned if set to default. (Default: 15)
    disabled Boolean
    When set to true, disables the caching of SQL responses. (Default: false)
    maxAge Number
    When present, specifies max duration for which items should persist in the cache. Not returned if set to default. (Default: 60)
    staleWhileRevalidate Number
    When present, indicates the number of seconds cache may serve the response after it becomes stale. Not returned if set to default. (Default: 15)

    GetHyperdriveConfigOrigin

    AccessClientId string
    The Client ID of the Access token to use when connecting to the origin database.
    AccessClientSecret string
    The Client Secret of the Access token to use when connecting to the origin database. This value is write-only and never returned by the API.
    Database string
    The name of your origin database.
    Host string
    The host (hostname or IP) of your origin database.
    Password string
    The password required to access your origin database. This value is write-only and never returned by the API.
    Port int
    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".
    User string
    The user of your origin database.
    AccessClientId string
    The Client ID of the Access token to use when connecting to the origin database.
    AccessClientSecret string
    The Client Secret of the Access token to use when connecting to the origin database. This value is write-only and never returned by the API.
    Database string
    The name of your origin database.
    Host string
    The host (hostname or IP) of your origin database.
    Password string
    The password required to access your origin database. This value is write-only and never returned by the API.
    Port int
    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".
    User string
    The user of your origin database.
    accessClientId String
    The Client ID of the Access token to use when connecting to the origin database.
    accessClientSecret String
    The Client Secret of the Access token to use when connecting to the origin database. This value is write-only and never returned by the API.
    database String
    The name of your origin database.
    host String
    The host (hostname or IP) of your origin database.
    password String
    The password required to access your origin database. This value is write-only and never returned by the API.
    port Integer
    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".
    user String
    The user of your origin database.
    accessClientId string
    The Client ID of the Access token to use when connecting to the origin database.
    accessClientSecret string
    The Client Secret of the Access token to use when connecting to the origin database. This value is write-only and never returned by the API.
    database string
    The name of your origin database.
    host string
    The host (hostname or IP) of your origin database.
    password string
    The password required to access your origin database. This value is write-only and never returned by the API.
    port number
    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".
    user string
    The user of your origin database.
    access_client_id str
    The Client ID of the Access token to use when connecting to the origin database.
    access_client_secret str
    The Client Secret of the Access token to use when connecting to the origin database. This value is write-only and never returned by the API.
    database str
    The name of your origin database.
    host str
    The host (hostname or IP) of your origin database.
    password str
    The password required to access your origin database. This value is write-only and never returned by the API.
    port int
    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".
    user str
    The user of your origin database.
    accessClientId String
    The Client ID of the Access token to use when connecting to the origin database.
    accessClientSecret String
    The Client Secret of the Access token to use when connecting to the origin database. This value is write-only and never returned by the API.
    database String
    The name of your origin database.
    host String
    The host (hostname or IP) of your origin database.
    password String
    The password required to access your origin database. This value is write-only and never returned by the API.
    port Number
    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".
    user String
    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.1.2 published on Monday, Apr 28, 2025 by Pulumi