Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Mysql
  5. getHeatWaveCluster
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.Mysql.getHeatWaveCluster

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific HeatWave cluster resource in Oracle Cloud Infrastructure MySQL Database service.

Gets information about the HeatWave cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testHeatWaveCluster = oci.Mysql.getHeatWaveCluster({
    dbSystemId: testDbSystem.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_heat_wave_cluster = oci.Mysql.get_heat_wave_cluster(db_system_id=test_db_system["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/mysql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mysql.GetHeatWaveCluster(ctx, &mysql.GetHeatWaveClusterArgs{
			DbSystemId: testDbSystem.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testHeatWaveCluster = Oci.Mysql.GetHeatWaveCluster.Invoke(new()
    {
        DbSystemId = testDbSystem.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Mysql.MysqlFunctions;
import com.pulumi.oci.Mysql.inputs.GetHeatWaveClusterArgs;
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 testHeatWaveCluster = MysqlFunctions.getHeatWaveCluster(GetHeatWaveClusterArgs.builder()
            .dbSystemId(testDbSystem.id())
            .build());

    }
}
Copy
variables:
  testHeatWaveCluster:
    fn::invoke:
      function: oci:Mysql:getHeatWaveCluster
      arguments:
        dbSystemId: ${testDbSystem.id}
Copy

Using getHeatWaveCluster

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 getHeatWaveCluster(args: GetHeatWaveClusterArgs, opts?: InvokeOptions): Promise<GetHeatWaveClusterResult>
function getHeatWaveClusterOutput(args: GetHeatWaveClusterOutputArgs, opts?: InvokeOptions): Output<GetHeatWaveClusterResult>
Copy
def get_heat_wave_cluster(db_system_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetHeatWaveClusterResult
def get_heat_wave_cluster_output(db_system_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetHeatWaveClusterResult]
Copy
func GetHeatWaveCluster(ctx *Context, args *GetHeatWaveClusterArgs, opts ...InvokeOption) (*GetHeatWaveClusterResult, error)
func GetHeatWaveClusterOutput(ctx *Context, args *GetHeatWaveClusterOutputArgs, opts ...InvokeOption) GetHeatWaveClusterResultOutput
Copy

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

public static class GetHeatWaveCluster 
{
    public static Task<GetHeatWaveClusterResult> InvokeAsync(GetHeatWaveClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetHeatWaveClusterResult> Invoke(GetHeatWaveClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHeatWaveClusterResult> getHeatWaveCluster(GetHeatWaveClusterArgs args, InvokeOptions options)
public static Output<GetHeatWaveClusterResult> getHeatWaveCluster(GetHeatWaveClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Mysql/getHeatWaveCluster:getHeatWaveCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DbSystemId This property is required. string
The DB System OCID.
DbSystemId This property is required. string
The DB System OCID.
dbSystemId This property is required. String
The DB System OCID.
dbSystemId This property is required. string
The DB System OCID.
db_system_id This property is required. str
The DB System OCID.
dbSystemId This property is required. String
The DB System OCID.

getHeatWaveCluster Result

The following output properties are available:

ClusterNodes List<GetHeatWaveClusterClusterNode>
A HeatWave node is a compute host that is part of a HeatWave cluster.
ClusterSize int
The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.
DbSystemId string
The OCID of the parent DB System this HeatWave cluster is attached to.
Id string
IsLakehouseEnabled bool
Lakehouse enabled status for the HeatWave cluster.
LifecycleDetails string
Additional information about the current lifecycleState.
ShapeName string
The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.
State string
The current state of the HeatWave cluster.
TimeCreated string
The date and time the HeatWave cluster was created, as described by RFC 3339.
TimeUpdated string
The time the HeatWave cluster was last updated, as described by RFC 3339.
ClusterNodes []GetHeatWaveClusterClusterNode
A HeatWave node is a compute host that is part of a HeatWave cluster.
ClusterSize int
The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.
DbSystemId string
The OCID of the parent DB System this HeatWave cluster is attached to.
Id string
IsLakehouseEnabled bool
Lakehouse enabled status for the HeatWave cluster.
LifecycleDetails string
Additional information about the current lifecycleState.
ShapeName string
The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.
State string
The current state of the HeatWave cluster.
TimeCreated string
The date and time the HeatWave cluster was created, as described by RFC 3339.
TimeUpdated string
The time the HeatWave cluster was last updated, as described by RFC 3339.
clusterNodes List<GetHeatWaveClusterClusterNode>
A HeatWave node is a compute host that is part of a HeatWave cluster.
clusterSize Integer
The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.
dbSystemId String
The OCID of the parent DB System this HeatWave cluster is attached to.
id String
isLakehouseEnabled Boolean
Lakehouse enabled status for the HeatWave cluster.
lifecycleDetails String
Additional information about the current lifecycleState.
shapeName String
The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.
state String
The current state of the HeatWave cluster.
timeCreated String
The date and time the HeatWave cluster was created, as described by RFC 3339.
timeUpdated String
The time the HeatWave cluster was last updated, as described by RFC 3339.
clusterNodes GetHeatWaveClusterClusterNode[]
A HeatWave node is a compute host that is part of a HeatWave cluster.
clusterSize number
The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.
dbSystemId string
The OCID of the parent DB System this HeatWave cluster is attached to.
id string
isLakehouseEnabled boolean
Lakehouse enabled status for the HeatWave cluster.
lifecycleDetails string
Additional information about the current lifecycleState.
shapeName string
The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.
state string
The current state of the HeatWave cluster.
timeCreated string
The date and time the HeatWave cluster was created, as described by RFC 3339.
timeUpdated string
The time the HeatWave cluster was last updated, as described by RFC 3339.
cluster_nodes Sequence[mysql.GetHeatWaveClusterClusterNode]
A HeatWave node is a compute host that is part of a HeatWave cluster.
cluster_size int
The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.
db_system_id str
The OCID of the parent DB System this HeatWave cluster is attached to.
id str
is_lakehouse_enabled bool
Lakehouse enabled status for the HeatWave cluster.
lifecycle_details str
Additional information about the current lifecycleState.
shape_name str
The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.
state str
The current state of the HeatWave cluster.
time_created str
The date and time the HeatWave cluster was created, as described by RFC 3339.
time_updated str
The time the HeatWave cluster was last updated, as described by RFC 3339.
clusterNodes List<Property Map>
A HeatWave node is a compute host that is part of a HeatWave cluster.
clusterSize Number
The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.
dbSystemId String
The OCID of the parent DB System this HeatWave cluster is attached to.
id String
isLakehouseEnabled Boolean
Lakehouse enabled status for the HeatWave cluster.
lifecycleDetails String
Additional information about the current lifecycleState.
shapeName String
The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.
state String
The current state of the HeatWave cluster.
timeCreated String
The date and time the HeatWave cluster was created, as described by RFC 3339.
timeUpdated String
The time the HeatWave cluster was last updated, as described by RFC 3339.

Supporting Types

GetHeatWaveClusterClusterNode

NodeId This property is required. string
The ID of the node within MySQL HeatWave cluster.
State This property is required. string
The current state of the HeatWave cluster.
TimeCreated This property is required. string
The date and time the HeatWave cluster was created, as described by RFC 3339.
TimeUpdated This property is required. string
The time the HeatWave cluster was last updated, as described by RFC 3339.
NodeId This property is required. string
The ID of the node within MySQL HeatWave cluster.
State This property is required. string
The current state of the HeatWave cluster.
TimeCreated This property is required. string
The date and time the HeatWave cluster was created, as described by RFC 3339.
TimeUpdated This property is required. string
The time the HeatWave cluster was last updated, as described by RFC 3339.
nodeId This property is required. String
The ID of the node within MySQL HeatWave cluster.
state This property is required. String
The current state of the HeatWave cluster.
timeCreated This property is required. String
The date and time the HeatWave cluster was created, as described by RFC 3339.
timeUpdated This property is required. String
The time the HeatWave cluster was last updated, as described by RFC 3339.
nodeId This property is required. string
The ID of the node within MySQL HeatWave cluster.
state This property is required. string
The current state of the HeatWave cluster.
timeCreated This property is required. string
The date and time the HeatWave cluster was created, as described by RFC 3339.
timeUpdated This property is required. string
The time the HeatWave cluster was last updated, as described by RFC 3339.
node_id This property is required. str
The ID of the node within MySQL HeatWave cluster.
state This property is required. str
The current state of the HeatWave cluster.
time_created This property is required. str
The date and time the HeatWave cluster was created, as described by RFC 3339.
time_updated This property is required. str
The time the HeatWave cluster was last updated, as described by RFC 3339.
nodeId This property is required. String
The ID of the node within MySQL HeatWave cluster.
state This property is required. String
The current state of the HeatWave cluster.
timeCreated This property is required. String
The date and time the HeatWave cluster was created, as described by RFC 3339.
timeUpdated This property is required. String
The time the HeatWave cluster was last updated, as described by RFC 3339.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci