Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getHeatWaveCluster

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

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

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

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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: oci_database_db_system.Test_db_system.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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(oci_database_db_system.test_db_system().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_heat_wave_cluster = oci.Mysql.get_heat_wave_cluster(db_system_id=oci_database_db_system["test_db_system"]["id"])

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

const testHeatWaveCluster = oci.Mysql.getHeatWaveCluster({
    dbSystemId: oci_database_db_system.test_db_system.id,
});

variables:
  testHeatWaveCluster:
    Fn::Invoke:
      Function: oci:Mysql:getHeatWaveCluster
      Arguments:
        dbSystemId: ${oci_database_db_system.test_db_system.id}

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>

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]

func GetHeatWaveCluster(ctx *Context, args *GetHeatWaveClusterArgs, opts ...InvokeOption) (*GetHeatWaveClusterResult, error)
func GetHeatWaveClusterOutput(ctx *Context, args *GetHeatWaveClusterOutputArgs, opts ...InvokeOption) GetHeatWaveClusterResultOutput

> 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)
}

public static CompletableFuture<GetHeatWaveClusterResult> getHeatWaveCluster(GetHeatWaveClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Mysql/getHeatWaveCluster:getHeatWaveCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

DbSystemId string: The DB System OCID.

DbSystemId string: The DB System OCID.

dbSystemId String: The DB System OCID.

dbSystemId string: The DB System OCID.

db_system_id str: The DB System OCID.

dbSystemId 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
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
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
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
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 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
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
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 string: The ID of the node within MySQL HeatWave cluster.
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.

NodeId string: The ID of the node within MySQL HeatWave cluster.
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.

nodeId String: The ID of the node within MySQL HeatWave cluster.
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.

nodeId string: The ID of the node within MySQL HeatWave cluster.
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.

node_id str: The ID of the node within MySQL HeatWave cluster.
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.

nodeId String: The ID of the node within MySQL HeatWave cluster.
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.

Package Details

Repository: https://github.com/pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.