oci logo
Oracle Cloud Infrastructure v0.6.0, Jan 23 23

oci.Opensearch.getOpensearchCluster

This data source provides details about a specific Opensearch Cluster resource in Oracle Cloud Infrastructure Opensearch service.

Gets a OpensearchCluster by identifier

Prerequisites

The below policies must be created in compartment before creating OpensearchCluster

{Compartment-Name} - Name of your compartment
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}
{}

For latest documentation on OpenSearch use please refer to https://docs.oracle.com/en-us/iaas/Content/search-opensearch/home.htm
Required permissions: https://docs.oracle.com/en-us/iaas/Content/search-opensearch/Concepts/ocisearchpermissions.htm

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testOpensearchCluster = Oci.Opensearch.GetOpensearchCluster.Invoke(new()
    {
        OpensearchClusterId = oci_opensearch_opensearch_cluster.Test_opensearch_cluster.Id,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Opensearch.GetOpensearchCluster(ctx, &opensearch.GetOpensearchClusterArgs{
			OpensearchClusterId: oci_opensearch_opensearch_cluster.Test_opensearch_cluster.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.Opensearch.OpensearchFunctions;
import com.pulumi.oci.Opensearch.inputs.GetOpensearchClusterArgs;
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 testOpensearchCluster = OpensearchFunctions.getOpensearchCluster(GetOpensearchClusterArgs.builder()
            .opensearchClusterId(oci_opensearch_opensearch_cluster.test_opensearch_cluster().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_opensearch_cluster = oci.Opensearch.get_opensearch_cluster(opensearch_cluster_id=oci_opensearch_opensearch_cluster["test_opensearch_cluster"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testOpensearchCluster = oci.Opensearch.getOpensearchCluster({
    opensearchClusterId: oci_opensearch_opensearch_cluster.test_opensearch_cluster.id,
});
variables:
  testOpensearchCluster:
    fn::invoke:
      Function: oci:Opensearch:getOpensearchCluster
      Arguments:
        opensearchClusterId: ${oci_opensearch_opensearch_cluster.test_opensearch_cluster.id}

Using getOpensearchCluster

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 getOpensearchCluster(args: GetOpensearchClusterArgs, opts?: InvokeOptions): Promise<GetOpensearchClusterResult>
function getOpensearchClusterOutput(args: GetOpensearchClusterOutputArgs, opts?: InvokeOptions): Output<GetOpensearchClusterResult>
def get_opensearch_cluster(opensearch_cluster_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetOpensearchClusterResult
def get_opensearch_cluster_output(opensearch_cluster_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetOpensearchClusterResult]
func GetOpensearchCluster(ctx *Context, args *GetOpensearchClusterArgs, opts ...InvokeOption) (*GetOpensearchClusterResult, error)
func GetOpensearchClusterOutput(ctx *Context, args *GetOpensearchClusterOutputArgs, opts ...InvokeOption) GetOpensearchClusterResultOutput

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

public static class GetOpensearchCluster 
{
    public static Task<GetOpensearchClusterResult> InvokeAsync(GetOpensearchClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetOpensearchClusterResult> Invoke(GetOpensearchClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetOpensearchClusterResult> getOpensearchCluster(GetOpensearchClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:Opensearch/getOpensearchCluster:getOpensearchCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

OpensearchClusterId string

unique OpensearchCluster identifier

OpensearchClusterId string

unique OpensearchCluster identifier

opensearchClusterId String

unique OpensearchCluster identifier

opensearchClusterId string

unique OpensearchCluster identifier

opensearch_cluster_id str

unique OpensearchCluster identifier

opensearchClusterId String

unique OpensearchCluster identifier

getOpensearchCluster Result

The following output properties are available:

AvailabilityDomains List<string>

The availability domains to distribute the cluser nodes across.

CompartmentId string

The OCID of the compartment where the cluster is located.

DataNodeCount int

The number of data nodes configured for the cluster.

DataNodeHostBareMetalShape string

The bare metal shape for the cluster's data nodes.

DataNodeHostMemoryGb int

The amount of memory in GB, for the cluster's data nodes.

DataNodeHostOcpuCount int

The number of OCPUs configured for the cluster's data nodes.

DataNodeHostType string

The instance type for the cluster's data nodes.

DataNodeStorageGb int

The amount of storage in GB, to configure per node for the cluster's data nodes.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

The name of the cluster. Avoid entering confidential information.

Fqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

FreeformTags Dictionary<string, object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id string

The OCID of the cluster.

LifecycleDetails string

Additional information about the current lifecycle state of the cluster.

MasterNodeCount int

The number of master nodes configured for the cluster.

MasterNodeHostBareMetalShape string

The bare metal shape for the cluster's master nodes.

MasterNodeHostMemoryGb int

The amount of memory in GB, for the cluster's master nodes.

MasterNodeHostOcpuCount int

The number of OCPUs configured for cluster's master nodes.

MasterNodeHostType string

The instance type for the cluster's master nodes.

OpendashboardFqdn string

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

OpendashboardNodeCount int

The number of OpenSearch Dashboard nodes configured for the cluster.

OpendashboardNodeHostMemoryGb int

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

OpendashboardNodeHostOcpuCount int

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

OpendashboardPrivateIp string

The private IP address for the cluster's OpenSearch Dashboard.

OpensearchClusterId string
OpensearchFqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

OpensearchPrivateIp string

The cluster's private IP address.

SoftwareVersion string

The software version the cluster is running.

State string

The current state of the cluster.

SubnetCompartmentId string

The OCID for the compartment where the cluster's subnet is located.

SubnetId string

The OCID of the cluster's subnet.

SystemTags Dictionary<string, object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The amount of time in milliseconds since the cluster was created.

TimeDeleted string

The amount of time in milliseconds since the cluster was updated.

TimeUpdated string

The amount of time in milliseconds since the cluster was updated.

TotalStorageGb int

The size in GB of the cluster's total storage.

VcnCompartmentId string

The OCID for the compartment where the cluster's VCN is located.

VcnId string

The OCID of the cluster's VCN.

AvailabilityDomains []string

The availability domains to distribute the cluser nodes across.

CompartmentId string

The OCID of the compartment where the cluster is located.

DataNodeCount int

The number of data nodes configured for the cluster.

DataNodeHostBareMetalShape string

The bare metal shape for the cluster's data nodes.

DataNodeHostMemoryGb int

The amount of memory in GB, for the cluster's data nodes.

DataNodeHostOcpuCount int

The number of OCPUs configured for the cluster's data nodes.

DataNodeHostType string

The instance type for the cluster's data nodes.

DataNodeStorageGb int

The amount of storage in GB, to configure per node for the cluster's data nodes.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

The name of the cluster. Avoid entering confidential information.

Fqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

FreeformTags map[string]interface{}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id string

The OCID of the cluster.

LifecycleDetails string

Additional information about the current lifecycle state of the cluster.

MasterNodeCount int

The number of master nodes configured for the cluster.

MasterNodeHostBareMetalShape string

The bare metal shape for the cluster's master nodes.

MasterNodeHostMemoryGb int

The amount of memory in GB, for the cluster's master nodes.

MasterNodeHostOcpuCount int

The number of OCPUs configured for cluster's master nodes.

MasterNodeHostType string

The instance type for the cluster's master nodes.

OpendashboardFqdn string

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

OpendashboardNodeCount int

The number of OpenSearch Dashboard nodes configured for the cluster.

OpendashboardNodeHostMemoryGb int

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

OpendashboardNodeHostOcpuCount int

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

OpendashboardPrivateIp string

The private IP address for the cluster's OpenSearch Dashboard.

OpensearchClusterId string
OpensearchFqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

OpensearchPrivateIp string

The cluster's private IP address.

SoftwareVersion string

The software version the cluster is running.

State string

The current state of the cluster.

SubnetCompartmentId string

The OCID for the compartment where the cluster's subnet is located.

SubnetId string

The OCID of the cluster's subnet.

SystemTags map[string]interface{}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

The amount of time in milliseconds since the cluster was created.

TimeDeleted string

The amount of time in milliseconds since the cluster was updated.

TimeUpdated string

The amount of time in milliseconds since the cluster was updated.

TotalStorageGb int

The size in GB of the cluster's total storage.

VcnCompartmentId string

The OCID for the compartment where the cluster's VCN is located.

VcnId string

The OCID of the cluster's VCN.

availabilityDomains List<String>

The availability domains to distribute the cluser nodes across.

compartmentId String

The OCID of the compartment where the cluster is located.

dataNodeCount Integer

The number of data nodes configured for the cluster.

dataNodeHostBareMetalShape String

The bare metal shape for the cluster's data nodes.

dataNodeHostMemoryGb Integer

The amount of memory in GB, for the cluster's data nodes.

dataNodeHostOcpuCount Integer

The number of OCPUs configured for the cluster's data nodes.

dataNodeHostType String

The instance type for the cluster's data nodes.

dataNodeStorageGb Integer

The amount of storage in GB, to configure per node for the cluster's data nodes.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

The name of the cluster. Avoid entering confidential information.

fqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

freeformTags Map<String,Object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

id String

The OCID of the cluster.

lifecycleDetails String

Additional information about the current lifecycle state of the cluster.

masterNodeCount Integer

The number of master nodes configured for the cluster.

masterNodeHostBareMetalShape String

The bare metal shape for the cluster's master nodes.

masterNodeHostMemoryGb Integer

The amount of memory in GB, for the cluster's master nodes.

masterNodeHostOcpuCount Integer

The number of OCPUs configured for cluster's master nodes.

masterNodeHostType String

The instance type for the cluster's master nodes.

opendashboardFqdn String

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboardNodeCount Integer

The number of OpenSearch Dashboard nodes configured for the cluster.

opendashboardNodeHostMemoryGb Integer

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

opendashboardNodeHostOcpuCount Integer

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

opendashboardPrivateIp String

The private IP address for the cluster's OpenSearch Dashboard.

opensearchClusterId String
opensearchFqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearchPrivateIp String

The cluster's private IP address.

softwareVersion String

The software version the cluster is running.

state String

The current state of the cluster.

subnetCompartmentId String

The OCID for the compartment where the cluster's subnet is located.

subnetId String

The OCID of the cluster's subnet.

systemTags Map<String,Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The amount of time in milliseconds since the cluster was created.

timeDeleted String

The amount of time in milliseconds since the cluster was updated.

timeUpdated String

The amount of time in milliseconds since the cluster was updated.

totalStorageGb Integer

The size in GB of the cluster's total storage.

vcnCompartmentId String

The OCID for the compartment where the cluster's VCN is located.

vcnId String

The OCID of the cluster's VCN.

availabilityDomains string[]

The availability domains to distribute the cluser nodes across.

compartmentId string

The OCID of the compartment where the cluster is located.

dataNodeCount number

The number of data nodes configured for the cluster.

dataNodeHostBareMetalShape string

The bare metal shape for the cluster's data nodes.

dataNodeHostMemoryGb number

The amount of memory in GB, for the cluster's data nodes.

dataNodeHostOcpuCount number

The number of OCPUs configured for the cluster's data nodes.

dataNodeHostType string

The instance type for the cluster's data nodes.

dataNodeStorageGb number

The amount of storage in GB, to configure per node for the cluster's data nodes.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName string

The name of the cluster. Avoid entering confidential information.

fqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

freeformTags {[key: string]: any}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

id string

The OCID of the cluster.

lifecycleDetails string

Additional information about the current lifecycle state of the cluster.

masterNodeCount number

The number of master nodes configured for the cluster.

masterNodeHostBareMetalShape string

The bare metal shape for the cluster's master nodes.

masterNodeHostMemoryGb number

The amount of memory in GB, for the cluster's master nodes.

masterNodeHostOcpuCount number

The number of OCPUs configured for cluster's master nodes.

masterNodeHostType string

The instance type for the cluster's master nodes.

opendashboardFqdn string

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboardNodeCount number

The number of OpenSearch Dashboard nodes configured for the cluster.

opendashboardNodeHostMemoryGb number

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

opendashboardNodeHostOcpuCount number

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

opendashboardPrivateIp string

The private IP address for the cluster's OpenSearch Dashboard.

opensearchClusterId string
opensearchFqdn string

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearchPrivateIp string

The cluster's private IP address.

softwareVersion string

The software version the cluster is running.

state string

The current state of the cluster.

subnetCompartmentId string

The OCID for the compartment where the cluster's subnet is located.

subnetId string

The OCID of the cluster's subnet.

systemTags {[key: string]: any}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

The amount of time in milliseconds since the cluster was created.

timeDeleted string

The amount of time in milliseconds since the cluster was updated.

timeUpdated string

The amount of time in milliseconds since the cluster was updated.

totalStorageGb number

The size in GB of the cluster's total storage.

vcnCompartmentId string

The OCID for the compartment where the cluster's VCN is located.

vcnId string

The OCID of the cluster's VCN.

availability_domains Sequence[str]

The availability domains to distribute the cluser nodes across.

compartment_id str

The OCID of the compartment where the cluster is located.

data_node_count int

The number of data nodes configured for the cluster.

data_node_host_bare_metal_shape str

The bare metal shape for the cluster's data nodes.

data_node_host_memory_gb int

The amount of memory in GB, for the cluster's data nodes.

data_node_host_ocpu_count int

The number of OCPUs configured for the cluster's data nodes.

data_node_host_type str

The instance type for the cluster's data nodes.

data_node_storage_gb int

The amount of storage in GB, to configure per node for the cluster's data nodes.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

display_name str

The name of the cluster. Avoid entering confidential information.

fqdn str

The fully qualified domain name (FQDN) for the cluster's API endpoint.

freeform_tags Mapping[str, Any]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

id str

The OCID of the cluster.

lifecycle_details str

Additional information about the current lifecycle state of the cluster.

master_node_count int

The number of master nodes configured for the cluster.

master_node_host_bare_metal_shape str

The bare metal shape for the cluster's master nodes.

master_node_host_memory_gb int

The amount of memory in GB, for the cluster's master nodes.

master_node_host_ocpu_count int

The number of OCPUs configured for cluster's master nodes.

master_node_host_type str

The instance type for the cluster's master nodes.

opendashboard_fqdn str

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboard_node_count int

The number of OpenSearch Dashboard nodes configured for the cluster.

opendashboard_node_host_memory_gb int

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

opendashboard_node_host_ocpu_count int

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

opendashboard_private_ip str

The private IP address for the cluster's OpenSearch Dashboard.

opensearch_cluster_id str
opensearch_fqdn str

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearch_private_ip str

The cluster's private IP address.

software_version str

The software version the cluster is running.

state str

The current state of the cluster.

subnet_compartment_id str

The OCID for the compartment where the cluster's subnet is located.

subnet_id str

The OCID of the cluster's subnet.

system_tags Mapping[str, Any]

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

The amount of time in milliseconds since the cluster was created.

time_deleted str

The amount of time in milliseconds since the cluster was updated.

time_updated str

The amount of time in milliseconds since the cluster was updated.

total_storage_gb int

The size in GB of the cluster's total storage.

vcn_compartment_id str

The OCID for the compartment where the cluster's VCN is located.

vcn_id str

The OCID of the cluster's VCN.

availabilityDomains List<String>

The availability domains to distribute the cluser nodes across.

compartmentId String

The OCID of the compartment where the cluster is located.

dataNodeCount Number

The number of data nodes configured for the cluster.

dataNodeHostBareMetalShape String

The bare metal shape for the cluster's data nodes.

dataNodeHostMemoryGb Number

The amount of memory in GB, for the cluster's data nodes.

dataNodeHostOcpuCount Number

The number of OCPUs configured for the cluster's data nodes.

dataNodeHostType String

The instance type for the cluster's data nodes.

dataNodeStorageGb Number

The amount of storage in GB, to configure per node for the cluster's data nodes.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

The name of the cluster. Avoid entering confidential information.

fqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

freeformTags Map<Any>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

id String

The OCID of the cluster.

lifecycleDetails String

Additional information about the current lifecycle state of the cluster.

masterNodeCount Number

The number of master nodes configured for the cluster.

masterNodeHostBareMetalShape String

The bare metal shape for the cluster's master nodes.

masterNodeHostMemoryGb Number

The amount of memory in GB, for the cluster's master nodes.

masterNodeHostOcpuCount Number

The number of OCPUs configured for cluster's master nodes.

masterNodeHostType String

The instance type for the cluster's master nodes.

opendashboardFqdn String

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboardNodeCount Number

The number of OpenSearch Dashboard nodes configured for the cluster.

opendashboardNodeHostMemoryGb Number

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

opendashboardNodeHostOcpuCount Number

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

opendashboardPrivateIp String

The private IP address for the cluster's OpenSearch Dashboard.

opensearchClusterId String
opensearchFqdn String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

opensearchPrivateIp String

The cluster's private IP address.

softwareVersion String

The software version the cluster is running.

state String

The current state of the cluster.

subnetCompartmentId String

The OCID for the compartment where the cluster's subnet is located.

subnetId String

The OCID of the cluster's subnet.

systemTags Map<Any>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

The amount of time in milliseconds since the cluster was created.

timeDeleted String

The amount of time in milliseconds since the cluster was updated.

timeUpdated String

The amount of time in milliseconds since the cluster was updated.

totalStorageGb Number

The size in GB of the cluster's total storage.

vcnCompartmentId String

The OCID for the compartment where the cluster's VCN is located.

vcnId String

The OCID of the cluster's VCN.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.