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

oci.Opensearch.getOpensearchCluster

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 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
Allow service opensearch to manage vnics in compartment {Compartment-Name}
Allow service opensearch to use subnets in compartment {Compartment-Name}
Allow service opensearch to use network-security-groups in compartment {Compartment-Name}
Allow service opensearch to manage vcns in compartment {Compartment-Name}

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

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

const testOpensearchCluster = oci.Opensearch.getOpensearchCluster({
    opensearchClusterId: testOpensearchClusterOciOpensearchOpensearchCluster.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_opensearch_cluster = oci.Opensearch.get_opensearch_cluster(opensearch_cluster_id=test_opensearch_cluster_oci_opensearch_opensearch_cluster["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/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: testOpensearchClusterOciOpensearchOpensearchCluster.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 testOpensearchCluster = Oci.Opensearch.GetOpensearchCluster.Invoke(new()
    {
        OpensearchClusterId = testOpensearchClusterOciOpensearchOpensearchCluster.Id,
    });

});
Copy
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(testOpensearchClusterOciOpensearchOpensearchCluster.id())
            .build());

    }
}
Copy
variables:
  testOpensearchCluster:
    fn::invoke:
      function: oci:Opensearch:getOpensearchCluster
      arguments:
        opensearchClusterId: ${testOpensearchClusterOciOpensearchOpensearchCluster.id}
Copy

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>
Copy
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]
Copy
func GetOpensearchCluster(ctx *Context, args *GetOpensearchClusterArgs, opts ...InvokeOption) (*GetOpensearchClusterResult, error)
func GetOpensearchClusterOutput(ctx *Context, args *GetOpensearchClusterOutputArgs, opts ...InvokeOption) GetOpensearchClusterResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetOpensearchClusterResult> getOpensearchCluster(GetOpensearchClusterArgs args, InvokeOptions options)
public static Output<GetOpensearchClusterResult> getOpensearchCluster(GetOpensearchClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Opensearch/getOpensearchCluster:getOpensearchCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OpensearchClusterId This property is required. string
unique OpensearchCluster identifier
OpensearchClusterId This property is required. string
unique OpensearchCluster identifier
opensearchClusterId This property is required. String
unique OpensearchCluster identifier
opensearchClusterId This property is required. string
unique OpensearchCluster identifier
opensearch_cluster_id This property is required. str
unique OpensearchCluster identifier
opensearchClusterId This property is required. 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.
ConfigureOutboundClusterTrigger int
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, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
Name of the Outbound cluster. Avoid entering confidential information.
Fqdn string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
FreeformTags Dictionary<string, string>
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.
InboundClusterIds List<string>
List of inbound clusters for which this cluster is an outbound cluster
LifecycleDetails string
Additional information about the current lifecycle state of the cluster.
MaintenanceDetails List<GetOpensearchClusterMaintenanceDetail>
Details for the maintenance activity.
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.
OutboundClusterConfigs List<GetOpensearchClusterOutboundClusterConfig>
This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
ReverseConnectionEndpointCustomerIps List<string>
The customer IP addresses of the endpoint in customer VCN
ReverseConnectionEndpoints List<GetOpensearchClusterReverseConnectionEndpoint>
The list of reverse connection endpoints.
SecurityMasterUserName string
The name of the master user that are used to manage security config
SecurityMasterUserPasswordHash string
The password hash of the master user that are used to manage security config
SecurityMode string
The security mode of the cluster.
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, string>
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.
UpgradeMajorVersionTrigger int
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.
ConfigureOutboundClusterTrigger int
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]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
Name of the Outbound cluster. Avoid entering confidential information.
Fqdn string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
FreeformTags map[string]string
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.
InboundClusterIds []string
List of inbound clusters for which this cluster is an outbound cluster
LifecycleDetails string
Additional information about the current lifecycle state of the cluster.
MaintenanceDetails []GetOpensearchClusterMaintenanceDetail
Details for the maintenance activity.
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.
OutboundClusterConfigs []GetOpensearchClusterOutboundClusterConfig
This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
ReverseConnectionEndpointCustomerIps []string
The customer IP addresses of the endpoint in customer VCN
ReverseConnectionEndpoints []GetOpensearchClusterReverseConnectionEndpoint
The list of reverse connection endpoints.
SecurityMasterUserName string
The name of the master user that are used to manage security config
SecurityMasterUserPasswordHash string
The password hash of the master user that are used to manage security config
SecurityMode string
The security mode of the cluster.
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]string
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.
UpgradeMajorVersionTrigger int
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.
configureOutboundClusterTrigger Integer
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,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
Name of the Outbound cluster. Avoid entering confidential information.
fqdn String
The fully qualified domain name (FQDN) for the cluster's API endpoint.
freeformTags Map<String,String>
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.
inboundClusterIds List<String>
List of inbound clusters for which this cluster is an outbound cluster
lifecycleDetails String
Additional information about the current lifecycle state of the cluster.
maintenanceDetails List<GetClusterMaintenanceDetail>
Details for the maintenance activity.
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.
outboundClusterConfigs List<GetClusterOutboundClusterConfig>
This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
reverseConnectionEndpointCustomerIps List<String>
The customer IP addresses of the endpoint in customer VCN
reverseConnectionEndpoints List<GetClusterReverseConnectionEndpoint>
The list of reverse connection endpoints.
securityMasterUserName String
The name of the master user that are used to manage security config
securityMasterUserPasswordHash String
The password hash of the master user that are used to manage security config
securityMode String
The security mode of the cluster.
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,String>
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.
upgradeMajorVersionTrigger Integer
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.
configureOutboundClusterTrigger number
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]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string
Name of the Outbound cluster. Avoid entering confidential information.
fqdn string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
freeformTags {[key: string]: string}
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.
inboundClusterIds string[]
List of inbound clusters for which this cluster is an outbound cluster
lifecycleDetails string
Additional information about the current lifecycle state of the cluster.
maintenanceDetails GetOpensearchClusterMaintenanceDetail[]
Details for the maintenance activity.
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.
outboundClusterConfigs GetOpensearchClusterOutboundClusterConfig[]
This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
reverseConnectionEndpointCustomerIps string[]
The customer IP addresses of the endpoint in customer VCN
reverseConnectionEndpoints GetOpensearchClusterReverseConnectionEndpoint[]
The list of reverse connection endpoints.
securityMasterUserName string
The name of the master user that are used to manage security config
securityMasterUserPasswordHash string
The password hash of the master user that are used to manage security config
securityMode string
The security mode of the cluster.
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]: string}
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.
upgradeMajorVersionTrigger number
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.
configure_outbound_cluster_trigger int
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, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str
Name of the Outbound cluster. Avoid entering confidential information.
fqdn str
The fully qualified domain name (FQDN) for the cluster's API endpoint.
freeform_tags Mapping[str, str]
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.
inbound_cluster_ids Sequence[str]
List of inbound clusters for which this cluster is an outbound cluster
lifecycle_details str
Additional information about the current lifecycle state of the cluster.
maintenance_details Sequence[opensearch.GetOpensearchClusterMaintenanceDetail]
Details for the maintenance activity.
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.
outbound_cluster_configs Sequence[opensearch.GetOpensearchClusterOutboundClusterConfig]
This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
reverse_connection_endpoint_customer_ips Sequence[str]
The customer IP addresses of the endpoint in customer VCN
reverse_connection_endpoints Sequence[opensearch.GetOpensearchClusterReverseConnectionEndpoint]
The list of reverse connection endpoints.
security_master_user_name str
The name of the master user that are used to manage security config
security_master_user_password_hash str
The password hash of the master user that are used to manage security config
security_mode str
The security mode of the cluster.
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, str]
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.
upgrade_major_version_trigger int
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.
configureOutboundClusterTrigger Number
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<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
Name of the Outbound cluster. Avoid entering confidential information.
fqdn String
The fully qualified domain name (FQDN) for the cluster's API endpoint.
freeformTags Map<String>
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.
inboundClusterIds List<String>
List of inbound clusters for which this cluster is an outbound cluster
lifecycleDetails String
Additional information about the current lifecycle state of the cluster.
maintenanceDetails List<Property Map>
Details for the maintenance activity.
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.
outboundClusterConfigs List<Property Map>
This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
reverseConnectionEndpointCustomerIps List<String>
The customer IP addresses of the endpoint in customer VCN
reverseConnectionEndpoints List<Property Map>
The list of reverse connection endpoints.
securityMasterUserName String
The name of the master user that are used to manage security config
securityMasterUserPasswordHash String
The password hash of the master user that are used to manage security config
securityMode String
The security mode of the cluster.
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>
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.
upgradeMajorVersionTrigger Number
vcnCompartmentId String
The OCID for the compartment where the cluster's VCN is located.
vcnId String
The OCID of the cluster's VCN.

Supporting Types

GetOpensearchClusterMaintenanceDetail

EndTime This property is required. string
End time of the maintenance activity
NotificationEmailIds This property is required. List<string>
The Email Ids given the by customer to get notified about maintenance activities
StartTime This property is required. string
Start time of the maintenance activity
State This property is required. string
The current state of the cluster.
EndTime This property is required. string
End time of the maintenance activity
NotificationEmailIds This property is required. []string
The Email Ids given the by customer to get notified about maintenance activities
StartTime This property is required. string
Start time of the maintenance activity
State This property is required. string
The current state of the cluster.
endTime This property is required. String
End time of the maintenance activity
notificationEmailIds This property is required. List<String>
The Email Ids given the by customer to get notified about maintenance activities
startTime This property is required. String
Start time of the maintenance activity
state This property is required. String
The current state of the cluster.
endTime This property is required. string
End time of the maintenance activity
notificationEmailIds This property is required. string[]
The Email Ids given the by customer to get notified about maintenance activities
startTime This property is required. string
Start time of the maintenance activity
state This property is required. string
The current state of the cluster.
end_time This property is required. str
End time of the maintenance activity
notification_email_ids This property is required. Sequence[str]
The Email Ids given the by customer to get notified about maintenance activities
start_time This property is required. str
Start time of the maintenance activity
state This property is required. str
The current state of the cluster.
endTime This property is required. String
End time of the maintenance activity
notificationEmailIds This property is required. List<String>
The Email Ids given the by customer to get notified about maintenance activities
startTime This property is required. String
Start time of the maintenance activity
state This property is required. String
The current state of the cluster.

GetOpensearchClusterOutboundClusterConfig

IsEnabled This property is required. bool
Flag to indicate whether outbound cluster configuration is enabled
OutboundClusters This property is required. List<GetOpensearchClusterOutboundClusterConfigOutboundCluster>
List of outbound clusters to be connected to the inbound cluster
IsEnabled This property is required. bool
Flag to indicate whether outbound cluster configuration is enabled
OutboundClusters This property is required. []GetOpensearchClusterOutboundClusterConfigOutboundCluster
List of outbound clusters to be connected to the inbound cluster
isEnabled This property is required. Boolean
Flag to indicate whether outbound cluster configuration is enabled
outboundClusters This property is required. List<GetClusterOutboundClusterConfigOutboundCluster>
List of outbound clusters to be connected to the inbound cluster
isEnabled This property is required. boolean
Flag to indicate whether outbound cluster configuration is enabled
outboundClusters This property is required. GetOpensearchClusterOutboundClusterConfigOutboundCluster[]
List of outbound clusters to be connected to the inbound cluster
is_enabled This property is required. bool
Flag to indicate whether outbound cluster configuration is enabled
outbound_clusters This property is required. Sequence[opensearch.GetOpensearchClusterOutboundClusterConfigOutboundCluster]
List of outbound clusters to be connected to the inbound cluster
isEnabled This property is required. Boolean
Flag to indicate whether outbound cluster configuration is enabled
outboundClusters This property is required. List<Property Map>
List of outbound clusters to be connected to the inbound cluster

GetOpensearchClusterOutboundClusterConfigOutboundCluster

DisplayName This property is required. string
Name of the Outbound cluster. Avoid entering confidential information.
IsSkipUnavailable This property is required. bool
Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
Mode This property is required. string
Mode for the cross cluster connection
PingSchedule This property is required. string
Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
SeedClusterId This property is required. string
OCID of the Outbound cluster
DisplayName This property is required. string
Name of the Outbound cluster. Avoid entering confidential information.
IsSkipUnavailable This property is required. bool
Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
Mode This property is required. string
Mode for the cross cluster connection
PingSchedule This property is required. string
Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
SeedClusterId This property is required. string
OCID of the Outbound cluster
displayName This property is required. String
Name of the Outbound cluster. Avoid entering confidential information.
isSkipUnavailable This property is required. Boolean
Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
mode This property is required. String
Mode for the cross cluster connection
pingSchedule This property is required. String
Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
seedClusterId This property is required. String
OCID of the Outbound cluster
displayName This property is required. string
Name of the Outbound cluster. Avoid entering confidential information.
isSkipUnavailable This property is required. boolean
Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
mode This property is required. string
Mode for the cross cluster connection
pingSchedule This property is required. string
Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
seedClusterId This property is required. string
OCID of the Outbound cluster
display_name This property is required. str
Name of the Outbound cluster. Avoid entering confidential information.
is_skip_unavailable This property is required. bool
Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
mode This property is required. str
Mode for the cross cluster connection
ping_schedule This property is required. str
Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
seed_cluster_id This property is required. str
OCID of the Outbound cluster
displayName This property is required. String
Name of the Outbound cluster. Avoid entering confidential information.
isSkipUnavailable This property is required. Boolean
Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
mode This property is required. String
Mode for the cross cluster connection
pingSchedule This property is required. String
Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.
seedClusterId This property is required. String
OCID of the Outbound cluster

GetOpensearchClusterReverseConnectionEndpoint

CustomerIp This property is required. string
The IP addresses of the endpoint in customer VCN
NatIp This property is required. string
The NAT IP addresses of the endpoint in service VCN
CustomerIp This property is required. string
The IP addresses of the endpoint in customer VCN
NatIp This property is required. string
The NAT IP addresses of the endpoint in service VCN
customerIp This property is required. String
The IP addresses of the endpoint in customer VCN
natIp This property is required. String
The NAT IP addresses of the endpoint in service VCN
customerIp This property is required. string
The IP addresses of the endpoint in customer VCN
natIp This property is required. string
The NAT IP addresses of the endpoint in service VCN
customer_ip This property is required. str
The IP addresses of the endpoint in customer VCN
nat_ip This property is required. str
The NAT IP addresses of the endpoint in service VCN
customerIp This property is required. String
The IP addresses of the endpoint in customer VCN
natIp This property is required. String
The NAT IP addresses of the endpoint in service VCN

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