Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Opensearch
  5. getOpensearchClusters
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

oci.Opensearch.getOpensearchClusters

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Opensearch Clusters in Oracle Cloud Infrastructure Opensearch service.

    Returns a list of OpensearchClusters.

    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 testOpensearchClusters = oci.Opensearch.getOpensearchClusters({
    compartmentId: compartmentId,
    displayName: opensearchClusterDisplayName,
    id: opensearchClusterId,
    state: opensearchClusterState,
});

    import pulumi
import pulumi_oci as oci

test_opensearch_clusters = oci.Opensearch.get_opensearch_clusters(compartment_id=compartment_id,
    display_name=opensearch_cluster_display_name,
    id=opensearch_cluster_id,
    state=opensearch_cluster_state)

    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.GetOpensearchClusters(ctx, &opensearch.GetOpensearchClustersArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(opensearchClusterDisplayName),
			Id:            pulumi.StringRef(opensearchClusterId),
			State:         pulumi.StringRef(opensearchClusterState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testOpensearchClusters = Oci.Opensearch.GetOpensearchClusters.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = opensearchClusterDisplayName,
        Id = opensearchClusterId,
        State = opensearchClusterState,
    });

});

    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.GetOpensearchClustersArgs;
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 testOpensearchClusters = OpensearchFunctions.getOpensearchClusters(GetOpensearchClustersArgs.builder()
            .compartmentId(compartmentId)
            .displayName(opensearchClusterDisplayName)
            .id(opensearchClusterId)
            .state(opensearchClusterState)
            .build());

    }
}

    variables:
  testOpensearchClusters:
    fn::invoke:
      function: oci:Opensearch:getOpensearchClusters
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${opensearchClusterDisplayName}
        id: ${opensearchClusterId}
        state: ${opensearchClusterState}

    Using getOpensearchClusters

    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 getOpensearchClusters(args: GetOpensearchClustersArgs, opts?: InvokeOptions): Promise<GetOpensearchClustersResult>
function getOpensearchClustersOutput(args: GetOpensearchClustersOutputArgs, opts?: InvokeOptions): Output<GetOpensearchClustersResult>
    def get_opensearch_clusters(compartment_id: Optional[str] = None,
                            display_name: Optional[str] = None,
                            filters: Optional[Sequence[_opensearch.GetOpensearchClustersFilter]] = None,
                            id: Optional[str] = None,
                            state: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetOpensearchClustersResult
def get_opensearch_clusters_output(compartment_id: Optional[pulumi.Input[str]] = None,
                            display_name: Optional[pulumi.Input[str]] = None,
                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[_opensearch.GetOpensearchClustersFilterArgs]]]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            state: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetOpensearchClustersResult]
    func GetOpensearchClusters(ctx *Context, args *GetOpensearchClustersArgs, opts ...InvokeOption) (*GetOpensearchClustersResult, error)
func GetOpensearchClustersOutput(ctx *Context, args *GetOpensearchClustersOutputArgs, opts ...InvokeOption) GetOpensearchClustersResultOutput

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

    public static class GetOpensearchClusters 
{
    public static Task<GetOpensearchClustersResult> InvokeAsync(GetOpensearchClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetOpensearchClustersResult> Invoke(GetOpensearchClustersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOpensearchClustersResult> getOpensearchClusters(GetOpensearchClustersArgs args, InvokeOptions options)
public static Output<GetOpensearchClustersResult> getOpensearchClusters(GetOpensearchClustersArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:Opensearch/getOpensearchClusters:getOpensearchClusters
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters List<GetOpensearchClustersFilter>
    Id string
    unique OpensearchCluster identifier
    State string
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters []GetOpensearchClustersFilter
    Id string
    unique OpensearchCluster identifier
    State string
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<GetClustersFilter>
    id String
    unique OpensearchCluster identifier
    state String
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    compartmentId string
    The ID of the compartment in which to list resources.
    displayName string
    A filter to return only resources that match the entire display name given.
    filters GetOpensearchClustersFilter[]
    id string
    unique OpensearchCluster identifier
    state string
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    compartment_id str
    The ID of the compartment in which to list resources.
    display_name str
    A filter to return only resources that match the entire display name given.
    filters Sequence[opensearch.GetOpensearchClustersFilter]
    id str
    unique OpensearchCluster identifier
    state str
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<Property Map>
    id String
    unique OpensearchCluster identifier
    state String
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.

    getOpensearchClusters Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment where the cluster is located.
    OpensearchClusterCollections List<GetOpensearchClustersOpensearchClusterCollection>
    The list of opensearch_cluster_collection.
    DisplayName string
    Name of the Outbound cluster. Avoid entering confidential information.
    Filters List<GetOpensearchClustersFilter>
    Id string
    The OCID of the cluster.
    State string
    The current state of the cluster.
    CompartmentId string
    The OCID of the compartment where the cluster is located.
    OpensearchClusterCollections []GetOpensearchClustersOpensearchClusterCollection
    The list of opensearch_cluster_collection.
    DisplayName string
    Name of the Outbound cluster. Avoid entering confidential information.
    Filters []GetOpensearchClustersFilter
    Id string
    The OCID of the cluster.
    State string
    The current state of the cluster.
    compartmentId String
    The OCID of the compartment where the cluster is located.
    opensearchClusterCollections List<GetClustersClusterCollection>
    The list of opensearch_cluster_collection.
    displayName String
    Name of the Outbound cluster. Avoid entering confidential information.
    filters List<GetClustersFilter>
    id String
    The OCID of the cluster.
    state String
    The current state of the cluster.
    compartmentId string
    The OCID of the compartment where the cluster is located.
    opensearchClusterCollections GetOpensearchClustersOpensearchClusterCollection[]
    The list of opensearch_cluster_collection.
    displayName string
    Name of the Outbound cluster. Avoid entering confidential information.
    filters GetOpensearchClustersFilter[]
    id string
    The OCID of the cluster.
    state string
    The current state of the cluster.
    compartment_id str
    The OCID of the compartment where the cluster is located.
    opensearch_cluster_collections Sequence[opensearch.GetOpensearchClustersOpensearchClusterCollection]
    The list of opensearch_cluster_collection.
    display_name str
    Name of the Outbound cluster. Avoid entering confidential information.
    filters Sequence[opensearch.GetOpensearchClustersFilter]
    id str
    The OCID of the cluster.
    state str
    The current state of the cluster.
    compartmentId String
    The OCID of the compartment where the cluster is located.
    opensearchClusterCollections List<Property Map>
    The list of opensearch_cluster_collection.
    displayName String
    Name of the Outbound cluster. Avoid entering confidential information.
    filters List<Property Map>
    id String
    The OCID of the cluster.
    state String
    The current state of the cluster.

    Supporting Types

    GetOpensearchClustersFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetOpensearchClustersOpensearchClusterCollection

    GetOpensearchClustersOpensearchClusterCollectionItem

    AvailabilityDomains List<string>
    The availability domains to distribute the cluser nodes across.
    CompartmentId string
    The ID of the compartment in which to list resources.
    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
    A filter to return only resources that match the entire display name given.
    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
    unique OpensearchCluster identifier
    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<GetOpensearchClustersOpensearchClusterCollectionItemMaintenanceDetail>
    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.
    OpensearchFqdn string
    The fully qualified domain name (FQDN) for the cluster's API endpoint.
    OpensearchPrivateIp string
    The cluster's private IP address.
    OutboundClusterConfigs List<GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfig>
    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<GetOpensearchClustersOpensearchClusterCollectionItemReverseConnectionEndpoint>
    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
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    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 ID of the compartment in which to list resources.
    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
    A filter to return only resources that match the entire display name given.
    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
    unique OpensearchCluster identifier
    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 []GetOpensearchClustersOpensearchClusterCollectionItemMaintenanceDetail
    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.
    OpensearchFqdn string
    The fully qualified domain name (FQDN) for the cluster's API endpoint.
    OpensearchPrivateIp string
    The cluster's private IP address.
    OutboundClusterConfigs []GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfig
    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 []GetOpensearchClustersOpensearchClusterCollectionItemReverseConnectionEndpoint
    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
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    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 ID of the compartment in which to list resources.
    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
    A filter to return only resources that match the entire display name given.
    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
    unique OpensearchCluster identifier
    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<GetClustersClusterCollectionItemMaintenanceDetail>
    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.
    opensearchFqdn String
    The fully qualified domain name (FQDN) for the cluster's API endpoint.
    opensearchPrivateIp String
    The cluster's private IP address.
    outboundClusterConfigs List<GetClustersClusterCollectionItemOutboundClusterConfig>
    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<GetClustersClusterCollectionItemReverseConnectionEndpoint>
    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
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    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 ID of the compartment in which to list resources.
    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
    A filter to return only resources that match the entire display name given.
    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
    unique OpensearchCluster identifier
    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 GetOpensearchClustersOpensearchClusterCollectionItemMaintenanceDetail[]
    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.
    opensearchFqdn string
    The fully qualified domain name (FQDN) for the cluster's API endpoint.
    opensearchPrivateIp string
    The cluster's private IP address.
    outboundClusterConfigs GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfig[]
    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 GetOpensearchClustersOpensearchClusterCollectionItemReverseConnectionEndpoint[]
    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
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    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 ID of the compartment in which to list resources.
    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
    A filter to return only resources that match the entire display name given.
    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
    unique OpensearchCluster identifier
    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.GetOpensearchClustersOpensearchClusterCollectionItemMaintenanceDetail]
    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_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.GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfig]
    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.GetOpensearchClustersOpensearchClusterCollectionItemReverseConnectionEndpoint]
    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
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    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 ID of the compartment in which to list resources.
    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
    A filter to return only resources that match the entire display name given.
    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
    unique OpensearchCluster identifier
    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.
    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
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    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.

    GetOpensearchClustersOpensearchClusterCollectionItemMaintenanceDetail

    EndTime string
    End time of the maintenance activity
    NotificationEmailIds List<string>
    The Email Ids given the by customer to get notified about maintenance activities
    StartTime string
    Start time of the maintenance activity
    State string
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    EndTime string
    End time of the maintenance activity
    NotificationEmailIds []string
    The Email Ids given the by customer to get notified about maintenance activities
    StartTime string
    Start time of the maintenance activity
    State string
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    endTime String
    End time of the maintenance activity
    notificationEmailIds List<String>
    The Email Ids given the by customer to get notified about maintenance activities
    startTime String
    Start time of the maintenance activity
    state String
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    endTime string
    End time of the maintenance activity
    notificationEmailIds string[]
    The Email Ids given the by customer to get notified about maintenance activities
    startTime string
    Start time of the maintenance activity
    state string
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    end_time str
    End time of the maintenance activity
    notification_email_ids Sequence[str]
    The Email Ids given the by customer to get notified about maintenance activities
    start_time str
    Start time of the maintenance activity
    state str
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
    endTime String
    End time of the maintenance activity
    notificationEmailIds List<String>
    The Email Ids given the by customer to get notified about maintenance activities
    startTime String
    Start time of the maintenance activity
    state String
    A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.

    GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfig

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

    GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfigOutboundCluster

    DisplayName string
    A filter to return only resources that match the entire display name given.
    IsSkipUnavailable bool
    Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    Mode string
    Mode for the cross cluster connection
    PingSchedule 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 string
    OCID of the Outbound cluster
    DisplayName string
    A filter to return only resources that match the entire display name given.
    IsSkipUnavailable bool
    Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    Mode string
    Mode for the cross cluster connection
    PingSchedule 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 string
    OCID of the Outbound cluster
    displayName String
    A filter to return only resources that match the entire display name given.
    isSkipUnavailable Boolean
    Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    mode String
    Mode for the cross cluster connection
    pingSchedule 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 String
    OCID of the Outbound cluster
    displayName string
    A filter to return only resources that match the entire display name given.
    isSkipUnavailable boolean
    Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    mode string
    Mode for the cross cluster connection
    pingSchedule 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 string
    OCID of the Outbound cluster
    display_name str
    A filter to return only resources that match the entire display name given.
    is_skip_unavailable bool
    Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    mode str
    Mode for the cross cluster connection
    ping_schedule 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 str
    OCID of the Outbound cluster
    displayName String
    A filter to return only resources that match the entire display name given.
    isSkipUnavailable Boolean
    Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable
    mode String
    Mode for the cross cluster connection
    pingSchedule 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 String
    OCID of the Outbound cluster

    GetOpensearchClustersOpensearchClusterCollectionItemReverseConnectionEndpoint

    CustomerIp string
    The IP addresses of the endpoint in customer VCN
    NatIp string
    The NAT IP addresses of the endpoint in service VCN
    CustomerIp string
    The IP addresses of the endpoint in customer VCN
    NatIp string
    The NAT IP addresses of the endpoint in service VCN
    customerIp String
    The IP addresses of the endpoint in customer VCN
    natIp String
    The NAT IP addresses of the endpoint in service VCN
    customerIp string
    The IP addresses of the endpoint in customer VCN
    natIp string
    The NAT IP addresses of the endpoint in service VCN
    customer_ip str
    The IP addresses of the endpoint in customer VCN
    nat_ip str
    The NAT IP addresses of the endpoint in service VCN
    customerIp String
    The IP addresses of the endpoint in customer VCN
    natIp 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.
    oci logo
    Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-oci