Docs Packages
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. getCockroachCluster
CockroachDB v0.0.3 published on Wednesday, Jul 12, 2023 by lbrlabs
lbrlabs/pulumi-cockroach

cockroach.getCockroachCluster

Explore with Pulumi AI

cockroach logo
CockroachDB v0.0.3 published on Wednesday, Jul 12, 2023 by lbrlabs
lbrlabs/pulumi-cockroach

    Cluster Data Source

    Using getCockroachCluster

    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 getCockroachCluster(args: GetCockroachClusterArgs, opts?: InvokeOptions): Promise<GetCockroachClusterResult>
function getCockroachClusterOutput(args: GetCockroachClusterOutputArgs, opts?: InvokeOptions): Output<GetCockroachClusterResult>
    def get_cockroach_cluster(id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCockroachClusterResult
def get_cockroach_cluster_output(id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCockroachClusterResult]
    func GetCockroachCluster(ctx *Context, args *GetCockroachClusterArgs, opts ...InvokeOption) (*GetCockroachClusterResult, error)
func GetCockroachClusterOutput(ctx *Context, args *GetCockroachClusterOutputArgs, opts ...InvokeOption) GetCockroachClusterResultOutput

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

    public static class GetCockroachCluster 
{
    public static Task<GetCockroachClusterResult> InvokeAsync(GetCockroachClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetCockroachClusterResult> Invoke(GetCockroachClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCockroachClusterResult> getCockroachCluster(GetCockroachClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: cockroach:index/getCockroachCluster:getCockroachCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string

    The ID of this resource.

    Id string

    The ID of this resource.

    id String

    The ID of this resource.

    id string

    The ID of this resource.

    id str

    The ID of this resource.

    id String

    The ID of this resource.

    getCockroachCluster Result

    The following output properties are available:

    accountId String
    cloudProvider String
    cockroachVersion String
    creatorId String
    dedicated Property Map
    id String

    The ID of this resource.

    name String

    Name of cluster

    operationStatus String
    plan String
    regions List<Property Map>
    serverless Property Map
    state String
    upgradeStatus String

    Supporting Types

    GetCockroachClusterDedicated

    GetCockroachClusterRegion

    Name string

    Name of cluster

    NodeCount int
    Primary bool
    SqlDns string
    UiDns string
    Name string

    Name of cluster

    NodeCount int
    Primary bool
    SqlDns string
    UiDns string
    name String

    Name of cluster

    nodeCount Integer
    primary Boolean
    sqlDns String
    uiDns String
    name string

    Name of cluster

    nodeCount number
    primary boolean
    sqlDns string
    uiDns string
    name str

    Name of cluster

    node_count int
    primary bool
    sql_dns str
    ui_dns str
    name String

    Name of cluster

    nodeCount Number
    primary Boolean
    sqlDns String
    uiDns String

    GetCockroachClusterServerless

    GetCockroachClusterServerlessUsageLimits

    Package Details

    Repository
    cockroach lbrlabs/pulumi-cockroach
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the cockroach Terraform Provider.

    cockroach logo
    CockroachDB v0.0.3 published on Wednesday, Jul 12, 2023 by lbrlabs
    lbrlabs/pulumi-cockroach