1. Packages
  2. CrateDB
  3. API Docs
  4. getCluster
Viewing docs for CrateDB v0.3.0
published on Tuesday, Mar 11, 2025 by DEPRECATED
Schema (JSON)
thulasirajkomminar/pulumi-cratedb

cratedb.getCluster

cratedb logo
Viewing docs for CrateDB v0.3.0
published on Tuesday, Mar 11, 2025 by DEPRECATED
Schema (JSON)
thulasirajkomminar/pulumi-cratedb

    To retrieve a cluster.

    Using getCluster

    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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

    public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: cratedb:index/getCluster:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The id of the cluster.
    Id string
    The id of the cluster.
    id String
    The id of the cluster.
    id string
    The id of the cluster.
    id str
    The id of the cluster.
    id String
    The id of the cluster.

    getCluster Result

    The following output properties are available:

    AllowCustomStorage bool
    The allow custom storage flag.
    AllowSuspend bool
    The allow suspend flag.
    BackupSchedule string
    The backup schedule.
    Channel string
    The channel of the cluster.
    CrateVersion string
    The CrateDB version of the cluster.
    Dc KomminarLabs.CrateDB.Outputs.GetClusterDc
    The DublinCore of the cluster.
    DeletionProtected bool
    The deletion protected flag.
    ExternalIp string
    The external IP address.
    Fqdn string
    The Fully Qualified Domain Name.
    GcAvailable bool
    The garbage collection available flag.
    HardwareSpecs KomminarLabs.CrateDB.Outputs.GetClusterHardwareSpecs
    The hardware specs of the cluster.
    Health KomminarLabs.CrateDB.Outputs.GetClusterHealth
    The health of the cluster.
    Id string
    The id of the cluster.
    IpWhitelists List<KomminarLabs.CrateDB.Outputs.GetClusterIpWhitelist>
    The IP whitelist of the cluster.
    LastAsyncOperation KomminarLabs.CrateDB.Outputs.GetClusterLastAsyncOperation
    The last async operation of the cluster.
    Name string
    The name of the cluster.
    NumNodes int
    The number of nodes in the cluster.
    Origin string
    The origin of the cluster.
    Password string
    The password of the cluster.
    ProductName string
    The product name of the cluster.
    ProductTier string
    The product tier of the cluster.
    ProductUnit int
    The product unit of the cluster.
    ProjectId string
    The project id of the cluster.
    SubscriptionId string
    The subscription id of the cluster.
    Suspended bool
    The suspended flag.
    Url string
    The URL of the cluster.
    Username string
    The username of the cluster.
    AllowCustomStorage bool
    The allow custom storage flag.
    AllowSuspend bool
    The allow suspend flag.
    BackupSchedule string
    The backup schedule.
    Channel string
    The channel of the cluster.
    CrateVersion string
    The CrateDB version of the cluster.
    Dc GetClusterDc
    The DublinCore of the cluster.
    DeletionProtected bool
    The deletion protected flag.
    ExternalIp string
    The external IP address.
    Fqdn string
    The Fully Qualified Domain Name.
    GcAvailable bool
    The garbage collection available flag.
    HardwareSpecs GetClusterHardwareSpecs
    The hardware specs of the cluster.
    Health GetClusterHealth
    The health of the cluster.
    Id string
    The id of the cluster.
    IpWhitelists []GetClusterIpWhitelist
    The IP whitelist of the cluster.
    LastAsyncOperation GetClusterLastAsyncOperation
    The last async operation of the cluster.
    Name string
    The name of the cluster.
    NumNodes int
    The number of nodes in the cluster.
    Origin string
    The origin of the cluster.
    Password string
    The password of the cluster.
    ProductName string
    The product name of the cluster.
    ProductTier string
    The product tier of the cluster.
    ProductUnit int
    The product unit of the cluster.
    ProjectId string
    The project id of the cluster.
    SubscriptionId string
    The subscription id of the cluster.
    Suspended bool
    The suspended flag.
    Url string
    The URL of the cluster.
    Username string
    The username of the cluster.
    allowCustomStorage Boolean
    The allow custom storage flag.
    allowSuspend Boolean
    The allow suspend flag.
    backupSchedule String
    The backup schedule.
    channel String
    The channel of the cluster.
    crateVersion String
    The CrateDB version of the cluster.
    dc GetClusterDc
    The DublinCore of the cluster.
    deletionProtected Boolean
    The deletion protected flag.
    externalIp String
    The external IP address.
    fqdn String
    The Fully Qualified Domain Name.
    gcAvailable Boolean
    The garbage collection available flag.
    hardwareSpecs GetClusterHardwareSpecs
    The hardware specs of the cluster.
    health GetClusterHealth
    The health of the cluster.
    id String
    The id of the cluster.
    ipWhitelists List<GetClusterIpWhitelist>
    The IP whitelist of the cluster.
    lastAsyncOperation GetClusterLastAsyncOperation
    The last async operation of the cluster.
    name String
    The name of the cluster.
    numNodes Integer
    The number of nodes in the cluster.
    origin String
    The origin of the cluster.
    password String
    The password of the cluster.
    productName String
    The product name of the cluster.
    productTier String
    The product tier of the cluster.
    productUnit Integer
    The product unit of the cluster.
    projectId String
    The project id of the cluster.
    subscriptionId String
    The subscription id of the cluster.
    suspended Boolean
    The suspended flag.
    url String
    The URL of the cluster.
    username String
    The username of the cluster.
    allowCustomStorage boolean
    The allow custom storage flag.
    allowSuspend boolean
    The allow suspend flag.
    backupSchedule string
    The backup schedule.
    channel string
    The channel of the cluster.
    crateVersion string
    The CrateDB version of the cluster.
    dc GetClusterDc
    The DublinCore of the cluster.
    deletionProtected boolean
    The deletion protected flag.
    externalIp string
    The external IP address.
    fqdn string
    The Fully Qualified Domain Name.
    gcAvailable boolean
    The garbage collection available flag.
    hardwareSpecs GetClusterHardwareSpecs
    The hardware specs of the cluster.
    health GetClusterHealth
    The health of the cluster.
    id string
    The id of the cluster.
    ipWhitelists GetClusterIpWhitelist[]
    The IP whitelist of the cluster.
    lastAsyncOperation GetClusterLastAsyncOperation
    The last async operation of the cluster.
    name string
    The name of the cluster.
    numNodes number
    The number of nodes in the cluster.
    origin string
    The origin of the cluster.
    password string
    The password of the cluster.
    productName string
    The product name of the cluster.
    productTier string
    The product tier of the cluster.
    productUnit number
    The product unit of the cluster.
    projectId string
    The project id of the cluster.
    subscriptionId string
    The subscription id of the cluster.
    suspended boolean
    The suspended flag.
    url string
    The URL of the cluster.
    username string
    The username of the cluster.
    allow_custom_storage bool
    The allow custom storage flag.
    allow_suspend bool
    The allow suspend flag.
    backup_schedule str
    The backup schedule.
    channel str
    The channel of the cluster.
    crate_version str
    The CrateDB version of the cluster.
    dc GetClusterDc
    The DublinCore of the cluster.
    deletion_protected bool
    The deletion protected flag.
    external_ip str
    The external IP address.
    fqdn str
    The Fully Qualified Domain Name.
    gc_available bool
    The garbage collection available flag.
    hardware_specs GetClusterHardwareSpecs
    The hardware specs of the cluster.
    health GetClusterHealth
    The health of the cluster.
    id str
    The id of the cluster.
    ip_whitelists Sequence[GetClusterIpWhitelist]
    The IP whitelist of the cluster.
    last_async_operation GetClusterLastAsyncOperation
    The last async operation of the cluster.
    name str
    The name of the cluster.
    num_nodes int
    The number of nodes in the cluster.
    origin str
    The origin of the cluster.
    password str
    The password of the cluster.
    product_name str
    The product name of the cluster.
    product_tier str
    The product tier of the cluster.
    product_unit int
    The product unit of the cluster.
    project_id str
    The project id of the cluster.
    subscription_id str
    The subscription id of the cluster.
    suspended bool
    The suspended flag.
    url str
    The URL of the cluster.
    username str
    The username of the cluster.
    allowCustomStorage Boolean
    The allow custom storage flag.
    allowSuspend Boolean
    The allow suspend flag.
    backupSchedule String
    The backup schedule.
    channel String
    The channel of the cluster.
    crateVersion String
    The CrateDB version of the cluster.
    dc Property Map
    The DublinCore of the cluster.
    deletionProtected Boolean
    The deletion protected flag.
    externalIp String
    The external IP address.
    fqdn String
    The Fully Qualified Domain Name.
    gcAvailable Boolean
    The garbage collection available flag.
    hardwareSpecs Property Map
    The hardware specs of the cluster.
    health Property Map
    The health of the cluster.
    id String
    The id of the cluster.
    ipWhitelists List<Property Map>
    The IP whitelist of the cluster.
    lastAsyncOperation Property Map
    The last async operation of the cluster.
    name String
    The name of the cluster.
    numNodes Number
    The number of nodes in the cluster.
    origin String
    The origin of the cluster.
    password String
    The password of the cluster.
    productName String
    The product name of the cluster.
    productTier String
    The product tier of the cluster.
    productUnit Number
    The product unit of the cluster.
    projectId String
    The project id of the cluster.
    subscriptionId String
    The subscription id of the cluster.
    suspended Boolean
    The suspended flag.
    url String
    The URL of the cluster.
    username String
    The username of the cluster.

    Supporting Types

    GetClusterDc

    Created string
    The created time.
    Modified string
    The modified time.
    Created string
    The created time.
    Modified string
    The modified time.
    created String
    The created time.
    modified String
    The modified time.
    created string
    The created time.
    modified string
    The modified time.
    created str
    The created time.
    modified str
    The modified time.
    created String
    The created time.
    modified String
    The modified time.

    GetClusterHardwareSpecs

    CpusPerNode int
    The cpus per node.
    DiskSizePerNodeBytes int
    The disk size per node in bytes.
    DiskType string
    The disk type.
    DisksPerNode int
    The disks per node.
    HeapSizeBytes int
    The heap size in bytes.
    MemoryPerNodeBytes int
    The memory per node in bytes.
    CpusPerNode int
    The cpus per node.
    DiskSizePerNodeBytes int
    The disk size per node in bytes.
    DiskType string
    The disk type.
    DisksPerNode int
    The disks per node.
    HeapSizeBytes int
    The heap size in bytes.
    MemoryPerNodeBytes int
    The memory per node in bytes.
    cpusPerNode Integer
    The cpus per node.
    diskSizePerNodeBytes Integer
    The disk size per node in bytes.
    diskType String
    The disk type.
    disksPerNode Integer
    The disks per node.
    heapSizeBytes Integer
    The heap size in bytes.
    memoryPerNodeBytes Integer
    The memory per node in bytes.
    cpusPerNode number
    The cpus per node.
    diskSizePerNodeBytes number
    The disk size per node in bytes.
    diskType string
    The disk type.
    disksPerNode number
    The disks per node.
    heapSizeBytes number
    The heap size in bytes.
    memoryPerNodeBytes number
    The memory per node in bytes.
    cpus_per_node int
    The cpus per node.
    disk_size_per_node_bytes int
    The disk size per node in bytes.
    disk_type str
    The disk type.
    disks_per_node int
    The disks per node.
    heap_size_bytes int
    The heap size in bytes.
    memory_per_node_bytes int
    The memory per node in bytes.
    cpusPerNode Number
    The cpus per node.
    diskSizePerNodeBytes Number
    The disk size per node in bytes.
    diskType String
    The disk type.
    disksPerNode Number
    The disks per node.
    heapSizeBytes Number
    The heap size in bytes.
    memoryPerNodeBytes Number
    The memory per node in bytes.

    GetClusterHealth

    LastSeen string
    The last seen time.
    RunningOperation string
    The type of the currently running operation. Returns an empty string if there is no operation in progress.
    Status string
    The health status of the cluster.
    LastSeen string
    The last seen time.
    RunningOperation string
    The type of the currently running operation. Returns an empty string if there is no operation in progress.
    Status string
    The health status of the cluster.
    lastSeen String
    The last seen time.
    runningOperation String
    The type of the currently running operation. Returns an empty string if there is no operation in progress.
    status String
    The health status of the cluster.
    lastSeen string
    The last seen time.
    runningOperation string
    The type of the currently running operation. Returns an empty string if there is no operation in progress.
    status string
    The health status of the cluster.
    last_seen str
    The last seen time.
    running_operation str
    The type of the currently running operation. Returns an empty string if there is no operation in progress.
    status str
    The health status of the cluster.
    lastSeen String
    The last seen time.
    runningOperation String
    The type of the currently running operation. Returns an empty string if there is no operation in progress.
    status String
    The health status of the cluster.

    GetClusterIpWhitelist

    Cidr string
    The CIDR.
    Description string
    The description.
    Cidr string
    The CIDR.
    Description string
    The description.
    cidr String
    The CIDR.
    description String
    The description.
    cidr string
    The CIDR.
    description string
    The description.
    cidr str
    The CIDR.
    description str
    The description.
    cidr String
    The CIDR.
    description String
    The description.

    GetClusterLastAsyncOperation

    Dc KomminarLabs.CrateDB.Inputs.GetClusterLastAsyncOperationDc
    The DublinCore of the cluster.
    Id string
    The id of the last async operation.
    Status string
    The status of the last async operation.
    Type string
    The type of the last async operation.
    Dc GetClusterLastAsyncOperationDc
    The DublinCore of the cluster.
    Id string
    The id of the last async operation.
    Status string
    The status of the last async operation.
    Type string
    The type of the last async operation.
    dc GetClusterLastAsyncOperationDc
    The DublinCore of the cluster.
    id String
    The id of the last async operation.
    status String
    The status of the last async operation.
    type String
    The type of the last async operation.
    dc GetClusterLastAsyncOperationDc
    The DublinCore of the cluster.
    id string
    The id of the last async operation.
    status string
    The status of the last async operation.
    type string
    The type of the last async operation.
    dc GetClusterLastAsyncOperationDc
    The DublinCore of the cluster.
    id str
    The id of the last async operation.
    status str
    The status of the last async operation.
    type str
    The type of the last async operation.
    dc Property Map
    The DublinCore of the cluster.
    id String
    The id of the last async operation.
    status String
    The status of the last async operation.
    type String
    The type of the last async operation.

    GetClusterLastAsyncOperationDc

    Created string
    The created time.
    Modified string
    The modified time.
    Created string
    The created time.
    Modified string
    The modified time.
    created String
    The created time.
    modified String
    The modified time.
    created string
    The created time.
    modified string
    The modified time.
    created str
    The created time.
    modified str
    The modified time.
    created String
    The created time.
    modified String
    The modified time.

    Package Details

    Repository
    cratedb komminarlabs/pulumi-cratedb
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cratedb Terraform Provider.
    cratedb logo
    Viewing docs for CrateDB v0.3.0
    published on Tuesday, Mar 11, 2025 by DEPRECATED
    Schema (JSON)
    thulasirajkomminar/pulumi-cratedb
      Try Pulumi Cloud free. Your team will thank you.