1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. getConnectionString
CockroachDB v0.2.2 published on Monday, Mar 11, 2024 by pulumiverse

cockroach.getConnectionString

Explore with Pulumi AI

cockroach logo
CockroachDB v0.2.2 published on Monday, Mar 11, 2024 by pulumiverse

    Generic connection string for a cluster.

    Using getConnectionString

    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 getConnectionString(args: GetConnectionStringArgs, opts?: InvokeOptions): Promise<GetConnectionStringResult>
    function getConnectionStringOutput(args: GetConnectionStringOutputArgs, opts?: InvokeOptions): Output<GetConnectionStringResult>
    def get_connection_string(database: Optional[str] = None,
                              id: Optional[str] = None,
                              os: Optional[str] = None,
                              password: Optional[str] = None,
                              sql_user: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetConnectionStringResult
    def get_connection_string_output(database: Optional[pulumi.Input[str]] = None,
                              id: Optional[pulumi.Input[str]] = None,
                              os: Optional[pulumi.Input[str]] = None,
                              password: Optional[pulumi.Input[str]] = None,
                              sql_user: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetConnectionStringResult]
    func GetConnectionString(ctx *Context, args *GetConnectionStringArgs, opts ...InvokeOption) (*GetConnectionStringResult, error)
    func GetConnectionStringOutput(ctx *Context, args *GetConnectionStringOutputArgs, opts ...InvokeOption) GetConnectionStringResultOutput

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

    public static class GetConnectionString 
    {
        public static Task<GetConnectionStringResult> InvokeAsync(GetConnectionStringArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectionStringResult> Invoke(GetConnectionStringInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectionStringResult> getConnectionString(GetConnectionStringArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: cockroach:index/getConnectionString:getConnectionString
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Database string
    Os string
    Password string
    SqlUser string
    Id string
    Database string
    Os string
    Password string
    SqlUser string
    id String
    database String
    os String
    password String
    sqlUser String
    id string
    database string
    os string
    password string
    sqlUser string
    id str
    database str
    os str
    password str
    sql_user str
    id String
    database String
    os String
    password String
    sqlUser String

    getConnectionString Result

    The following output properties are available:

    Supporting Types

    GetConnectionStringConnectionParams

    Database string
    Database value to use in a connection URL.
    Host string
    Host value to use in a connection URL.
    Password string
    Password value to use in a connection URL.
    Port string
    Port value to use in a connection URL.
    Username string
    Username value to use in a connection URL.
    Database string
    Database value to use in a connection URL.
    Host string
    Host value to use in a connection URL.
    Password string
    Password value to use in a connection URL.
    Port string
    Port value to use in a connection URL.
    Username string
    Username value to use in a connection URL.
    database String
    Database value to use in a connection URL.
    host String
    Host value to use in a connection URL.
    password String
    Password value to use in a connection URL.
    port String
    Port value to use in a connection URL.
    username String
    Username value to use in a connection URL.
    database string
    Database value to use in a connection URL.
    host string
    Host value to use in a connection URL.
    password string
    Password value to use in a connection URL.
    port string
    Port value to use in a connection URL.
    username string
    Username value to use in a connection URL.
    database str
    Database value to use in a connection URL.
    host str
    Host value to use in a connection URL.
    password str
    Password value to use in a connection URL.
    port str
    Port value to use in a connection URL.
    username str
    Username value to use in a connection URL.
    database String
    Database value to use in a connection URL.
    host String
    Host value to use in a connection URL.
    password String
    Password value to use in a connection URL.
    port String
    Port value to use in a connection URL.
    username String
    Username value to use in a connection URL.

    Package Details

    Repository
    cockroach pulumiverse/pulumi-cockroach
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cockroach Terraform Provider.
    cockroach logo
    CockroachDB v0.2.2 published on Monday, Mar 11, 2024 by pulumiverse