cockroach.getCockroachCluster
Explore with Pulumi AI
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:
- Account
Id string - Cloud
Provider string - Cockroach
Version string - Creator
Id string - Dedicated
Lbrlabs.
Pulumi Package. Cockroach. Outputs. Get Cockroach Cluster Dedicated - Id string
The ID of this resource.
- Name string
Name of cluster
- Operation
Status string - Plan string
- Regions
List<Lbrlabs.
Pulumi Package. Cockroach. Outputs. Get Cockroach Cluster Region> - Serverless
Lbrlabs.
Pulumi Package. Cockroach. Outputs. Get Cockroach Cluster Serverless - State string
- Upgrade
Status string
- Account
Id string - Cloud
Provider string - Cockroach
Version string - Creator
Id string - Dedicated
Get
Cockroach Cluster Dedicated - Id string
The ID of this resource.
- Name string
Name of cluster
- Operation
Status string - Plan string
- Regions
[]Get
Cockroach Cluster Region - Serverless
Get
Cockroach Cluster Serverless - State string
- Upgrade
Status string
- account
Id String - cloud
Provider String - cockroach
Version String - creator
Id String - dedicated
Get
Cockroach Cluster Dedicated - id String
The ID of this resource.
- name String
Name of cluster
- operation
Status String - plan String
- regions
List<Get
Cockroach Cluster Region> - serverless
Get
Cockroach Cluster Serverless - state String
- upgrade
Status String
- account
Id string - cloud
Provider string - cockroach
Version string - creator
Id string - dedicated
Get
Cockroach Cluster Dedicated - id string
The ID of this resource.
- name string
Name of cluster
- operation
Status string - plan string
- regions
Get
Cockroach Cluster Region[] - serverless
Get
Cockroach Cluster Serverless - state string
- upgrade
Status string
- account_
id str - cloud_
provider str - cockroach_
version str - creator_
id str - dedicated
Get
Cockroach Cluster Dedicated - id str
The ID of this resource.
- name str
Name of cluster
- operation_
status str - plan str
- regions
Sequence[Get
Cockroach Cluster Region] - serverless
Get
Cockroach Cluster Serverless - state str
- upgrade_
status str
- account
Id String - cloud
Provider String - cockroach
Version String - creator
Id String - dedicated Property Map
- id String
The ID of this resource.
- name String
Name of cluster
- operation
Status String - plan String
- regions List<Property Map>
- serverless Property Map
- state String
- upgrade
Status String
Supporting Types
GetCockroachClusterDedicated
- Disk
Iops int - Machine
Type string - Memory
Gib double - Num
Virtual intCpus - Private
Network boolVisibility - Storage
Gib int
- Disk
Iops int - Machine
Type string - Memory
Gib float64 - Num
Virtual intCpus - Private
Network boolVisibility - Storage
Gib int
- disk
Iops Integer - machine
Type String - memory
Gib Double - num
Virtual IntegerCpus - private
Network BooleanVisibility - storage
Gib Integer
- disk
Iops number - machine
Type string - memory
Gib number - num
Virtual numberCpus - private
Network booleanVisibility - storage
Gib number
- disk_
iops int - machine_
type str - memory_
gib float - num_
virtual_ intcpus - private_
network_ boolvisibility - storage_
gib int
- disk
Iops Number - machine
Type String - memory
Gib Number - num
Virtual NumberCpus - private
Network BooleanVisibility - storage
Gib Number
GetCockroachClusterRegion
- name str
Name of cluster
- node_
count int - primary bool
- sql_
dns str - ui_
dns str
GetCockroachClusterServerless
- routing
Id String - spend
Limit Number - usage
Limits Property Map
GetCockroachClusterServerlessUsageLimits
- Request
Unit intLimit - Storage
Mib intLimit
- Request
Unit intLimit - Storage
Mib intLimit
- request
Unit IntegerLimit - storage
Mib IntegerLimit
- request
Unit numberLimit - storage
Mib numberLimit
- request
Unit NumberLimit - storage
Mib NumberLimit
Package Details
- Repository
- cockroach lbrlabs/pulumi-cockroach
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
cockroach
Terraform Provider.