published on Thursday, Mar 19, 2026 by Pulumi
published on Thursday, Mar 19, 2026 by Pulumi
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/v4/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[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[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 dictionaryThe following arguments are supported:
- Compartment
Id string - The ID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the entire display name given.
- Filters
List<Get
Opensearch Clusters Filter> - Id string
- unique OpensearchCluster identifier
- State string
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- Compartment
Id string - The ID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the entire display name given.
- Filters
[]Get
Opensearch Clusters Filter - Id string
- unique OpensearchCluster identifier
- State string
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- compartment
Id String - The ID of the compartment in which to list resources.
- display
Name String - A filter to return only resources that match the entire display name given.
- filters
List<Get
Clusters Filter> - id String
- unique OpensearchCluster identifier
- state String
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- compartment
Id string - The ID of the compartment in which to list resources.
- display
Name string - A filter to return only resources that match the entire display name given.
- filters
Get
Opensearch Clusters Filter[] - 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[Get
Opensearch Clusters Filter] - id str
- unique OpensearchCluster identifier
- state str
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- compartment
Id String - The ID of the compartment in which to list resources.
- display
Name 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:
- Compartment
Id string - The OCID of the compartment where the cluster is located.
- Opensearch
Cluster List<GetCollections Opensearch Clusters Opensearch Cluster Collection> - The list of opensearch_cluster_collection.
- Display
Name string - Name of the Outbound cluster. Avoid entering confidential information.
- Filters
List<Get
Opensearch Clusters Filter> - Id string
- The OCID of the cluster.
- State string
- The current state of the cluster.
- Compartment
Id string - The OCID of the compartment where the cluster is located.
- Opensearch
Cluster []GetCollections Opensearch Clusters Opensearch Cluster Collection - The list of opensearch_cluster_collection.
- Display
Name string - Name of the Outbound cluster. Avoid entering confidential information.
- Filters
[]Get
Opensearch Clusters Filter - Id string
- The OCID of the cluster.
- State string
- The current state of the cluster.
- compartment
Id String - The OCID of the compartment where the cluster is located.
- opensearch
Cluster List<GetCollections Clusters Cluster Collection> - The list of opensearch_cluster_collection.
- display
Name String - Name of the Outbound cluster. Avoid entering confidential information.
- filters
List<Get
Clusters Filter> - id String
- The OCID of the cluster.
- state String
- The current state of the cluster.
- compartment
Id string - The OCID of the compartment where the cluster is located.
- opensearch
Cluster GetCollections Opensearch Clusters Opensearch Cluster Collection[] - The list of opensearch_cluster_collection.
- display
Name string - Name of the Outbound cluster. Avoid entering confidential information.
- filters
Get
Opensearch Clusters Filter[] - 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_ Sequence[Getcollections Opensearch Clusters Opensearch Cluster Collection] - The list of opensearch_cluster_collection.
- display_
name str - Name of the Outbound cluster. Avoid entering confidential information.
- filters
Sequence[Get
Opensearch Clusters Filter] - id str
- The OCID of the cluster.
- state str
- The current state of the cluster.
- compartment
Id String - The OCID of the compartment where the cluster is located.
- opensearch
Cluster List<Property Map>Collections - The list of opensearch_cluster_collection.
- display
Name 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
GetOpensearchClustersOpensearchClusterCollection
GetOpensearchClustersOpensearchClusterCollectionItem
- Availability
Domains List<string> - The availability domains to distribute the cluser nodes across.
- Certificate
Configs List<GetOpensearch Clusters Opensearch Cluster Collection Item Certificate Config> - Custom certificate config for customer provided certs.
- Compartment
Id string - The ID of the compartment in which to list resources.
- Configure
Outbound intCluster Trigger - Data
Node intCount - The number of data nodes configured for the cluster.
- Data
Node stringHost Bare Metal Shape - The bare metal shape for the cluster's data nodes.
- Data
Node intHost Memory Gb - The amount of memory in GB, for the cluster's data nodes.
- Data
Node intHost Ocpu Count - The number of OCPUs configured for the cluster's data nodes.
- Data
Node stringHost Shape - The node shape for the cluster's data nodes.
- Data
Node stringHost Type - The instance type for the cluster's data nodes.
- Data
Node intStorage Gb - The amount of storage in GB, to configure per node for the cluster's data nodes.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Display
Name 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.
- 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
- Inbound
Cluster List<string>Ids - List of inbound clusters for which this cluster is an outbound cluster
- Lifecycle
Details string - Additional information about the current lifecycle state of the cluster.
- Load
Balancer List<GetConfigs Opensearch Clusters Opensearch Cluster Collection Item Load Balancer Config> - This config is used to choose the load balancer service and bandwidth for OpenSearch and OpenDashboard load balancers.
- Maintenance
Details List<GetOpensearch Clusters Opensearch Cluster Collection Item Maintenance Detail> - Details for the maintenance activity.
- Master
Node intCount - The number of master nodes configured for the cluster.
- Master
Node stringHost Bare Metal Shape - The bare metal shape for the cluster's master nodes.
- Master
Node intHost Memory Gb - The amount of memory in GB, for the cluster's master nodes.
- Master
Node intHost Ocpu Count - The number of OCPUs configured for cluster's master nodes.
- Master
Node stringHost Shape - The node shape for the cluster's master nodes.
- Master
Node stringHost Type - The instance type for the cluster's master nodes.
- Ml
Node intCount - The number of ML nodes configured for the cluster.
- Ml
Node intHost Memory Gb - The amount of memory in GB, for the cluster's ML nodes.
- Ml
Node intHost Ocpu Count - The number of OCPUs configured for the cluster's ML nodes.
- Ml
Node stringHost Shape - The node shape for the cluster's ML nodes.
- Ml
Node stringHost Type - The instance type for the cluster's ML nodes.
- Ml
Node intStorage Gb - The amount of storage in GB, to configure per node for the cluster's ML nodes.
- Nsg
Id string - The OCID of the NSG where the private endpoint vnic will be attached.
- Opendashboard
Fqdn string - The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.
- Opendashboard
Node intCount - The number of OpenSearch Dashboard nodes configured for the cluster.
- Opendashboard
Node intHost Memory Gb - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- Opendashboard
Node intHost Ocpu Count - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- Opendashboard
Node stringHost Shape - The node shape for the cluster's OpenSearch Dashboard nodes.
- Opendashboard
Private stringIp - The private IP address for the cluster's OpenSearch Dashboard.
- Opensearch
Fqdn string - The fully qualified domain name (FQDN) for the cluster's API endpoint.
- Opensearch
Private stringIp - The cluster's private IP address.
- Outbound
Cluster List<GetConfigs Opensearch Clusters Opensearch Cluster Collection Item Outbound Cluster Config> - This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
- Reverse
Connection List<string>Endpoint Customer Ips - The customer IP addresses of the endpoint in customer VCN
- Reverse
Connection List<GetEndpoints Opensearch Clusters Opensearch Cluster Collection Item Reverse Connection Endpoint> - The list of reverse connection endpoints.
- Search
Node intCount - The number of search nodes configured for the cluster.
- Search
Node intHost Memory Gb - The amount of memory in GB, for the cluster's search nodes.
- Search
Node intHost Ocpu Count - The number of OCPUs configured for the cluster's search nodes.
- Search
Node stringHost Shape - The node shape for the cluster's search nodes.
- Search
Node stringHost Type - The instance type for the cluster's search nodes.
- Search
Node intStorage Gb - The amount of storage in GB, to configure per node for the cluster's search nodes.
- Security
Attributes Dictionary<string, string> - Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - Security
Master stringUser Name - The name of the master user that are used to manage security config
- Security
Master stringUser Password Hash - The password hash of the master user that are used to manage security config
- Security
Mode string - The security mode of the cluster.
- Security
Saml List<GetConfigs Opensearch Clusters Opensearch Cluster Collection Item Security Saml Config> - Software
Version string - The software version the cluster is running.
- State string
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- Subnet
Compartment stringId - The OCID for the compartment where the cluster's subnet is located.
- Subnet
Id string - The OCID of the cluster's subnet.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The amount of time in milliseconds since the cluster was created.
- Time
Deleted string - The amount of time in milliseconds since the cluster was updated.
- Time
Updated string - The amount of time in milliseconds since the cluster was updated.
- Total
Storage intGb - The size in GB of the cluster's total storage.
- Upgrade
Major intVersion Trigger - Vcn
Compartment stringId - The OCID for the compartment where the cluster's VCN is located.
- Vcn
Id string - The OCID of the cluster's VCN.
- Availability
Domains []string - The availability domains to distribute the cluser nodes across.
- Certificate
Configs []GetOpensearch Clusters Opensearch Cluster Collection Item Certificate Config - Custom certificate config for customer provided certs.
- Compartment
Id string - The ID of the compartment in which to list resources.
- Configure
Outbound intCluster Trigger - Data
Node intCount - The number of data nodes configured for the cluster.
- Data
Node stringHost Bare Metal Shape - The bare metal shape for the cluster's data nodes.
- Data
Node intHost Memory Gb - The amount of memory in GB, for the cluster's data nodes.
- Data
Node intHost Ocpu Count - The number of OCPUs configured for the cluster's data nodes.
- Data
Node stringHost Shape - The node shape for the cluster's data nodes.
- Data
Node stringHost Type - The instance type for the cluster's data nodes.
- Data
Node intStorage Gb - The amount of storage in GB, to configure per node for the cluster's data nodes.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Display
Name 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.
- 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
- Inbound
Cluster []stringIds - List of inbound clusters for which this cluster is an outbound cluster
- Lifecycle
Details string - Additional information about the current lifecycle state of the cluster.
- Load
Balancer []GetConfigs Opensearch Clusters Opensearch Cluster Collection Item Load Balancer Config - This config is used to choose the load balancer service and bandwidth for OpenSearch and OpenDashboard load balancers.
- Maintenance
Details []GetOpensearch Clusters Opensearch Cluster Collection Item Maintenance Detail - Details for the maintenance activity.
- Master
Node intCount - The number of master nodes configured for the cluster.
- Master
Node stringHost Bare Metal Shape - The bare metal shape for the cluster's master nodes.
- Master
Node intHost Memory Gb - The amount of memory in GB, for the cluster's master nodes.
- Master
Node intHost Ocpu Count - The number of OCPUs configured for cluster's master nodes.
- Master
Node stringHost Shape - The node shape for the cluster's master nodes.
- Master
Node stringHost Type - The instance type for the cluster's master nodes.
- Ml
Node intCount - The number of ML nodes configured for the cluster.
- Ml
Node intHost Memory Gb - The amount of memory in GB, for the cluster's ML nodes.
- Ml
Node intHost Ocpu Count - The number of OCPUs configured for the cluster's ML nodes.
- Ml
Node stringHost Shape - The node shape for the cluster's ML nodes.
- Ml
Node stringHost Type - The instance type for the cluster's ML nodes.
- Ml
Node intStorage Gb - The amount of storage in GB, to configure per node for the cluster's ML nodes.
- Nsg
Id string - The OCID of the NSG where the private endpoint vnic will be attached.
- Opendashboard
Fqdn string - The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.
- Opendashboard
Node intCount - The number of OpenSearch Dashboard nodes configured for the cluster.
- Opendashboard
Node intHost Memory Gb - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- Opendashboard
Node intHost Ocpu Count - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- Opendashboard
Node stringHost Shape - The node shape for the cluster's OpenSearch Dashboard nodes.
- Opendashboard
Private stringIp - The private IP address for the cluster's OpenSearch Dashboard.
- Opensearch
Fqdn string - The fully qualified domain name (FQDN) for the cluster's API endpoint.
- Opensearch
Private stringIp - The cluster's private IP address.
- Outbound
Cluster []GetConfigs Opensearch Clusters Opensearch Cluster Collection Item Outbound Cluster Config - This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
- Reverse
Connection []stringEndpoint Customer Ips - The customer IP addresses of the endpoint in customer VCN
- Reverse
Connection []GetEndpoints Opensearch Clusters Opensearch Cluster Collection Item Reverse Connection Endpoint - The list of reverse connection endpoints.
- Search
Node intCount - The number of search nodes configured for the cluster.
- Search
Node intHost Memory Gb - The amount of memory in GB, for the cluster's search nodes.
- Search
Node intHost Ocpu Count - The number of OCPUs configured for the cluster's search nodes.
- Search
Node stringHost Shape - The node shape for the cluster's search nodes.
- Search
Node stringHost Type - The instance type for the cluster's search nodes.
- Search
Node intStorage Gb - The amount of storage in GB, to configure per node for the cluster's search nodes.
- Security
Attributes map[string]string - Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - Security
Master stringUser Name - The name of the master user that are used to manage security config
- Security
Master stringUser Password Hash - The password hash of the master user that are used to manage security config
- Security
Mode string - The security mode of the cluster.
- Security
Saml []GetConfigs Opensearch Clusters Opensearch Cluster Collection Item Security Saml Config - Software
Version string - The software version the cluster is running.
- State string
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- Subnet
Compartment stringId - The OCID for the compartment where the cluster's subnet is located.
- Subnet
Id string - The OCID of the cluster's subnet.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The amount of time in milliseconds since the cluster was created.
- Time
Deleted string - The amount of time in milliseconds since the cluster was updated.
- Time
Updated string - The amount of time in milliseconds since the cluster was updated.
- Total
Storage intGb - The size in GB of the cluster's total storage.
- Upgrade
Major intVersion Trigger - Vcn
Compartment stringId - The OCID for the compartment where the cluster's VCN is located.
- Vcn
Id string - The OCID of the cluster's VCN.
- availability
Domains List<String> - The availability domains to distribute the cluser nodes across.
- certificate
Configs List<GetClusters Cluster Collection Item Certificate Config> - Custom certificate config for customer provided certs.
- compartment
Id String - The ID of the compartment in which to list resources.
- configure
Outbound IntegerCluster Trigger - data
Node IntegerCount - The number of data nodes configured for the cluster.
- data
Node StringHost Bare Metal Shape - The bare metal shape for the cluster's data nodes.
- data
Node IntegerHost Memory Gb - The amount of memory in GB, for the cluster's data nodes.
- data
Node IntegerHost Ocpu Count - The number of OCPUs configured for the cluster's data nodes.
- data
Node StringHost Shape - The node shape for the cluster's data nodes.
- data
Node StringHost Type - The instance type for the cluster's data nodes.
- data
Node IntegerStorage Gb - The amount of storage in GB, to configure per node for the cluster's data nodes.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name 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.
- 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
- inbound
Cluster List<String>Ids - List of inbound clusters for which this cluster is an outbound cluster
- lifecycle
Details String - Additional information about the current lifecycle state of the cluster.
- load
Balancer List<GetConfigs Clusters Cluster Collection Item Load Balancer Config> - This config is used to choose the load balancer service and bandwidth for OpenSearch and OpenDashboard load balancers.
- maintenance
Details List<GetClusters Cluster Collection Item Maintenance Detail> - Details for the maintenance activity.
- master
Node IntegerCount - The number of master nodes configured for the cluster.
- master
Node StringHost Bare Metal Shape - The bare metal shape for the cluster's master nodes.
- master
Node IntegerHost Memory Gb - The amount of memory in GB, for the cluster's master nodes.
- master
Node IntegerHost Ocpu Count - The number of OCPUs configured for cluster's master nodes.
- master
Node StringHost Shape - The node shape for the cluster's master nodes.
- master
Node StringHost Type - The instance type for the cluster's master nodes.
- ml
Node IntegerCount - The number of ML nodes configured for the cluster.
- ml
Node IntegerHost Memory Gb - The amount of memory in GB, for the cluster's ML nodes.
- ml
Node IntegerHost Ocpu Count - The number of OCPUs configured for the cluster's ML nodes.
- ml
Node StringHost Shape - The node shape for the cluster's ML nodes.
- ml
Node StringHost Type - The instance type for the cluster's ML nodes.
- ml
Node IntegerStorage Gb - The amount of storage in GB, to configure per node for the cluster's ML nodes.
- nsg
Id String - The OCID of the NSG where the private endpoint vnic will be attached.
- opendashboard
Fqdn String - The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.
- opendashboard
Node IntegerCount - The number of OpenSearch Dashboard nodes configured for the cluster.
- opendashboard
Node IntegerHost Memory Gb - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- opendashboard
Node IntegerHost Ocpu Count - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- opendashboard
Node StringHost Shape - The node shape for the cluster's OpenSearch Dashboard nodes.
- opendashboard
Private StringIp - The private IP address for the cluster's OpenSearch Dashboard.
- opensearch
Fqdn String - The fully qualified domain name (FQDN) for the cluster's API endpoint.
- opensearch
Private StringIp - The cluster's private IP address.
- outbound
Cluster List<GetConfigs Clusters Cluster Collection Item Outbound Cluster Config> - This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
- reverse
Connection List<String>Endpoint Customer Ips - The customer IP addresses of the endpoint in customer VCN
- reverse
Connection List<GetEndpoints Clusters Cluster Collection Item Reverse Connection Endpoint> - The list of reverse connection endpoints.
- search
Node IntegerCount - The number of search nodes configured for the cluster.
- search
Node IntegerHost Memory Gb - The amount of memory in GB, for the cluster's search nodes.
- search
Node IntegerHost Ocpu Count - The number of OCPUs configured for the cluster's search nodes.
- search
Node StringHost Shape - The node shape for the cluster's search nodes.
- search
Node StringHost Type - The instance type for the cluster's search nodes.
- search
Node IntegerStorage Gb - The amount of storage in GB, to configure per node for the cluster's search nodes.
- security
Attributes Map<String,String> - Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security
Master StringUser Name - The name of the master user that are used to manage security config
- security
Master StringUser Password Hash - The password hash of the master user that are used to manage security config
- security
Mode String - The security mode of the cluster.
- security
Saml List<GetConfigs Clusters Cluster Collection Item Security Saml Config> - software
Version String - The software version the cluster is running.
- state String
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- subnet
Compartment StringId - The OCID for the compartment where the cluster's subnet is located.
- subnet
Id String - The OCID of the cluster's subnet.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The amount of time in milliseconds since the cluster was created.
- time
Deleted String - The amount of time in milliseconds since the cluster was updated.
- time
Updated String - The amount of time in milliseconds since the cluster was updated.
- total
Storage IntegerGb - The size in GB of the cluster's total storage.
- upgrade
Major IntegerVersion Trigger - vcn
Compartment StringId - The OCID for the compartment where the cluster's VCN is located.
- vcn
Id String - The OCID of the cluster's VCN.
- availability
Domains string[] - The availability domains to distribute the cluser nodes across.
- certificate
Configs GetOpensearch Clusters Opensearch Cluster Collection Item Certificate Config[] - Custom certificate config for customer provided certs.
- compartment
Id string - The ID of the compartment in which to list resources.
- configure
Outbound numberCluster Trigger - data
Node numberCount - The number of data nodes configured for the cluster.
- data
Node stringHost Bare Metal Shape - The bare metal shape for the cluster's data nodes.
- data
Node numberHost Memory Gb - The amount of memory in GB, for the cluster's data nodes.
- data
Node numberHost Ocpu Count - The number of OCPUs configured for the cluster's data nodes.
- data
Node stringHost Shape - The node shape for the cluster's data nodes.
- data
Node stringHost Type - The instance type for the cluster's data nodes.
- data
Node numberStorage Gb - The amount of storage in GB, to configure per node for the cluster's data nodes.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name 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.
- {[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
- inbound
Cluster string[]Ids - List of inbound clusters for which this cluster is an outbound cluster
- lifecycle
Details string - Additional information about the current lifecycle state of the cluster.
- load
Balancer GetConfigs Opensearch Clusters Opensearch Cluster Collection Item Load Balancer Config[] - This config is used to choose the load balancer service and bandwidth for OpenSearch and OpenDashboard load balancers.
- maintenance
Details GetOpensearch Clusters Opensearch Cluster Collection Item Maintenance Detail[] - Details for the maintenance activity.
- master
Node numberCount - The number of master nodes configured for the cluster.
- master
Node stringHost Bare Metal Shape - The bare metal shape for the cluster's master nodes.
- master
Node numberHost Memory Gb - The amount of memory in GB, for the cluster's master nodes.
- master
Node numberHost Ocpu Count - The number of OCPUs configured for cluster's master nodes.
- master
Node stringHost Shape - The node shape for the cluster's master nodes.
- master
Node stringHost Type - The instance type for the cluster's master nodes.
- ml
Node numberCount - The number of ML nodes configured for the cluster.
- ml
Node numberHost Memory Gb - The amount of memory in GB, for the cluster's ML nodes.
- ml
Node numberHost Ocpu Count - The number of OCPUs configured for the cluster's ML nodes.
- ml
Node stringHost Shape - The node shape for the cluster's ML nodes.
- ml
Node stringHost Type - The instance type for the cluster's ML nodes.
- ml
Node numberStorage Gb - The amount of storage in GB, to configure per node for the cluster's ML nodes.
- nsg
Id string - The OCID of the NSG where the private endpoint vnic will be attached.
- opendashboard
Fqdn string - The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.
- opendashboard
Node numberCount - The number of OpenSearch Dashboard nodes configured for the cluster.
- opendashboard
Node numberHost Memory Gb - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- opendashboard
Node numberHost Ocpu Count - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- opendashboard
Node stringHost Shape - The node shape for the cluster's OpenSearch Dashboard nodes.
- opendashboard
Private stringIp - The private IP address for the cluster's OpenSearch Dashboard.
- opensearch
Fqdn string - The fully qualified domain name (FQDN) for the cluster's API endpoint.
- opensearch
Private stringIp - The cluster's private IP address.
- outbound
Cluster GetConfigs Opensearch Clusters Opensearch Cluster Collection Item Outbound Cluster Config[] - This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
- reverse
Connection string[]Endpoint Customer Ips - The customer IP addresses of the endpoint in customer VCN
- reverse
Connection GetEndpoints Opensearch Clusters Opensearch Cluster Collection Item Reverse Connection Endpoint[] - The list of reverse connection endpoints.
- search
Node numberCount - The number of search nodes configured for the cluster.
- search
Node numberHost Memory Gb - The amount of memory in GB, for the cluster's search nodes.
- search
Node numberHost Ocpu Count - The number of OCPUs configured for the cluster's search nodes.
- search
Node stringHost Shape - The node shape for the cluster's search nodes.
- search
Node stringHost Type - The instance type for the cluster's search nodes.
- search
Node numberStorage Gb - The amount of storage in GB, to configure per node for the cluster's search nodes.
- security
Attributes {[key: string]: string} - Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security
Master stringUser Name - The name of the master user that are used to manage security config
- security
Master stringUser Password Hash - The password hash of the master user that are used to manage security config
- security
Mode string - The security mode of the cluster.
- security
Saml GetConfigs Opensearch Clusters Opensearch Cluster Collection Item Security Saml Config[] - software
Version string - The software version the cluster is running.
- state string
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- subnet
Compartment stringId - The OCID for the compartment where the cluster's subnet is located.
- subnet
Id string - The OCID of the cluster's subnet.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The amount of time in milliseconds since the cluster was created.
- time
Deleted string - The amount of time in milliseconds since the cluster was updated.
- time
Updated string - The amount of time in milliseconds since the cluster was updated.
- total
Storage numberGb - The size in GB of the cluster's total storage.
- upgrade
Major numberVersion Trigger - vcn
Compartment stringId - The OCID for the compartment where the cluster's VCN is located.
- vcn
Id string - The OCID of the cluster's VCN.
- availability_
domains Sequence[str] - The availability domains to distribute the cluser nodes across.
- certificate_
configs Sequence[GetOpensearch Clusters Opensearch Cluster Collection Item Certificate Config] - Custom certificate config for customer provided certs.
- compartment_
id str - The ID of the compartment in which to list resources.
- configure_
outbound_ intcluster_ trigger - data_
node_ intcount - The number of data nodes configured for the cluster.
- data_
node_ strhost_ bare_ metal_ shape - The bare metal shape for the cluster's data nodes.
- data_
node_ inthost_ memory_ gb - The amount of memory in GB, for the cluster's data nodes.
- data_
node_ inthost_ ocpu_ count - The number of OCPUs configured for the cluster's data nodes.
- data_
node_ strhost_ shape - The node shape for the cluster's data nodes.
- data_
node_ strhost_ type - The instance type for the cluster's data nodes.
- data_
node_ intstorage_ gb - The amount of storage in GB, to configure per node for the cluster's data nodes.
- 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.
- 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_ Sequence[str]ids - 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.
- load_
balancer_ Sequence[Getconfigs Opensearch Clusters Opensearch Cluster Collection Item Load Balancer Config] - This config is used to choose the load balancer service and bandwidth for OpenSearch and OpenDashboard load balancers.
- maintenance_
details Sequence[GetOpensearch Clusters Opensearch Cluster Collection Item Maintenance Detail] - Details for the maintenance activity.
- master_
node_ intcount - The number of master nodes configured for the cluster.
- master_
node_ strhost_ bare_ metal_ shape - The bare metal shape for the cluster's master nodes.
- master_
node_ inthost_ memory_ gb - The amount of memory in GB, for the cluster's master nodes.
- master_
node_ inthost_ ocpu_ count - The number of OCPUs configured for cluster's master nodes.
- master_
node_ strhost_ shape - The node shape for the cluster's master nodes.
- master_
node_ strhost_ type - The instance type for the cluster's master nodes.
- ml_
node_ intcount - The number of ML nodes configured for the cluster.
- ml_
node_ inthost_ memory_ gb - The amount of memory in GB, for the cluster's ML nodes.
- ml_
node_ inthost_ ocpu_ count - The number of OCPUs configured for the cluster's ML nodes.
- ml_
node_ strhost_ shape - The node shape for the cluster's ML nodes.
- ml_
node_ strhost_ type - The instance type for the cluster's ML nodes.
- ml_
node_ intstorage_ gb - The amount of storage in GB, to configure per node for the cluster's ML nodes.
- nsg_
id str - The OCID of the NSG where the private endpoint vnic will be attached.
- opendashboard_
fqdn str - The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.
- opendashboard_
node_ intcount - The number of OpenSearch Dashboard nodes configured for the cluster.
- opendashboard_
node_ inthost_ memory_ gb - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- opendashboard_
node_ inthost_ ocpu_ count - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- opendashboard_
node_ strhost_ shape - The node shape for the cluster's OpenSearch Dashboard nodes.
- opendashboard_
private_ strip - 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_ strip - The cluster's private IP address.
- outbound_
cluster_ Sequence[Getconfigs Opensearch Clusters Opensearch Cluster Collection Item Outbound Cluster Config] - This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
- reverse_
connection_ Sequence[str]endpoint_ customer_ ips - The customer IP addresses of the endpoint in customer VCN
- reverse_
connection_ Sequence[Getendpoints Opensearch Clusters Opensearch Cluster Collection Item Reverse Connection Endpoint] - The list of reverse connection endpoints.
- search_
node_ intcount - The number of search nodes configured for the cluster.
- search_
node_ inthost_ memory_ gb - The amount of memory in GB, for the cluster's search nodes.
- search_
node_ inthost_ ocpu_ count - The number of OCPUs configured for the cluster's search nodes.
- search_
node_ strhost_ shape - The node shape for the cluster's search nodes.
- search_
node_ strhost_ type - The instance type for the cluster's search nodes.
- search_
node_ intstorage_ gb - The amount of storage in GB, to configure per node for the cluster's search nodes.
- security_
attributes Mapping[str, str] - Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security_
master_ struser_ name - The name of the master user that are used to manage security config
- security_
master_ struser_ password_ hash - The password hash of the master user that are used to manage security config
- security_
mode str - The security mode of the cluster.
- security_
saml_ Sequence[Getconfigs Opensearch Clusters Opensearch Cluster Collection Item Security Saml Config] - 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_ strid - The OCID for the compartment where the cluster's subnet is located.
- subnet_
id str - The OCID of the cluster's subnet.
- 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_ intgb - The size in GB of the cluster's total storage.
- upgrade_
major_ intversion_ trigger - vcn_
compartment_ strid - The OCID for the compartment where the cluster's VCN is located.
- vcn_
id str - The OCID of the cluster's VCN.
- availability
Domains List<String> - The availability domains to distribute the cluser nodes across.
- certificate
Configs List<Property Map> - Custom certificate config for customer provided certs.
- compartment
Id String - The ID of the compartment in which to list resources.
- configure
Outbound NumberCluster Trigger - data
Node NumberCount - The number of data nodes configured for the cluster.
- data
Node StringHost Bare Metal Shape - The bare metal shape for the cluster's data nodes.
- data
Node NumberHost Memory Gb - The amount of memory in GB, for the cluster's data nodes.
- data
Node NumberHost Ocpu Count - The number of OCPUs configured for the cluster's data nodes.
- data
Node StringHost Shape - The node shape for the cluster's data nodes.
- data
Node StringHost Type - The instance type for the cluster's data nodes.
- data
Node NumberStorage Gb - The amount of storage in GB, to configure per node for the cluster's data nodes.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name 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.
- 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
- inbound
Cluster List<String>Ids - List of inbound clusters for which this cluster is an outbound cluster
- lifecycle
Details String - Additional information about the current lifecycle state of the cluster.
- load
Balancer List<Property Map>Configs - This config is used to choose the load balancer service and bandwidth for OpenSearch and OpenDashboard load balancers.
- maintenance
Details List<Property Map> - Details for the maintenance activity.
- master
Node NumberCount - The number of master nodes configured for the cluster.
- master
Node StringHost Bare Metal Shape - The bare metal shape for the cluster's master nodes.
- master
Node NumberHost Memory Gb - The amount of memory in GB, for the cluster's master nodes.
- master
Node NumberHost Ocpu Count - The number of OCPUs configured for cluster's master nodes.
- master
Node StringHost Shape - The node shape for the cluster's master nodes.
- master
Node StringHost Type - The instance type for the cluster's master nodes.
- ml
Node NumberCount - The number of ML nodes configured for the cluster.
- ml
Node NumberHost Memory Gb - The amount of memory in GB, for the cluster's ML nodes.
- ml
Node NumberHost Ocpu Count - The number of OCPUs configured for the cluster's ML nodes.
- ml
Node StringHost Shape - The node shape for the cluster's ML nodes.
- ml
Node StringHost Type - The instance type for the cluster's ML nodes.
- ml
Node NumberStorage Gb - The amount of storage in GB, to configure per node for the cluster's ML nodes.
- nsg
Id String - The OCID of the NSG where the private endpoint vnic will be attached.
- opendashboard
Fqdn String - The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.
- opendashboard
Node NumberCount - The number of OpenSearch Dashboard nodes configured for the cluster.
- opendashboard
Node NumberHost Memory Gb - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- opendashboard
Node NumberHost Ocpu Count - The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.
- opendashboard
Node StringHost Shape - The node shape for the cluster's OpenSearch Dashboard nodes.
- opendashboard
Private StringIp - The private IP address for the cluster's OpenSearch Dashboard.
- opensearch
Fqdn String - The fully qualified domain name (FQDN) for the cluster's API endpoint.
- opensearch
Private StringIp - The cluster's private IP address.
- outbound
Cluster List<Property Map>Configs - This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
- reverse
Connection List<String>Endpoint Customer Ips - The customer IP addresses of the endpoint in customer VCN
- reverse
Connection List<Property Map>Endpoints - The list of reverse connection endpoints.
- search
Node NumberCount - The number of search nodes configured for the cluster.
- search
Node NumberHost Memory Gb - The amount of memory in GB, for the cluster's search nodes.
- search
Node NumberHost Ocpu Count - The number of OCPUs configured for the cluster's search nodes.
- search
Node StringHost Shape - The node shape for the cluster's search nodes.
- search
Node StringHost Type - The instance type for the cluster's search nodes.
- search
Node NumberStorage Gb - The amount of storage in GB, to configure per node for the cluster's search nodes.
- security
Attributes Map<String> - Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} - security
Master StringUser Name - The name of the master user that are used to manage security config
- security
Master StringUser Password Hash - The password hash of the master user that are used to manage security config
- security
Mode String - The security mode of the cluster.
- security
Saml List<Property Map>Configs - software
Version String - The software version the cluster is running.
- state String
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- subnet
Compartment StringId - The OCID for the compartment where the cluster's subnet is located.
- subnet
Id String - The OCID of the cluster's subnet.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The amount of time in milliseconds since the cluster was created.
- time
Deleted String - The amount of time in milliseconds since the cluster was updated.
- time
Updated String - The amount of time in milliseconds since the cluster was updated.
- total
Storage NumberGb - The size in GB of the cluster's total storage.
- upgrade
Major NumberVersion Trigger - vcn
Compartment StringId - The OCID for the compartment where the cluster's VCN is located.
- vcn
Id String - The OCID of the cluster's VCN.
GetOpensearchClustersOpensearchClusterCollectionItemCertificateConfig
- Cluster
Certificate stringMode - Specifies whether the certificate to be used in cluster is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- Dashboard
Certificate stringMode - Specifies whether the certificate to be used in dashboard is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- Open
Search stringApi Certificate Id - certificate to be used for OpenSearch cluster api communication
- Open
Search stringDashboard Certificate Id - certificate to be used for OpenSearch dashboard api communication
- Cluster
Certificate stringMode - Specifies whether the certificate to be used in cluster is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- Dashboard
Certificate stringMode - Specifies whether the certificate to be used in dashboard is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- Open
Search stringApi Certificate Id - certificate to be used for OpenSearch cluster api communication
- Open
Search stringDashboard Certificate Id - certificate to be used for OpenSearch dashboard api communication
- cluster
Certificate StringMode - Specifies whether the certificate to be used in cluster is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- dashboard
Certificate StringMode - Specifies whether the certificate to be used in dashboard is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- open
Search StringApi Certificate Id - certificate to be used for OpenSearch cluster api communication
- open
Search StringDashboard Certificate Id - certificate to be used for OpenSearch dashboard api communication
- cluster
Certificate stringMode - Specifies whether the certificate to be used in cluster is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- dashboard
Certificate stringMode - Specifies whether the certificate to be used in dashboard is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- open
Search stringApi Certificate Id - certificate to be used for OpenSearch cluster api communication
- open
Search stringDashboard Certificate Id - certificate to be used for OpenSearch dashboard api communication
- cluster_
certificate_ strmode - Specifies whether the certificate to be used in cluster is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- dashboard_
certificate_ strmode - Specifies whether the certificate to be used in dashboard is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- open_
search_ strapi_ certificate_ id - certificate to be used for OpenSearch cluster api communication
- open_
search_ strdashboard_ certificate_ id - certificate to be used for OpenSearch dashboard api communication
- cluster
Certificate StringMode - Specifies whether the certificate to be used in cluster is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- dashboard
Certificate StringMode - Specifies whether the certificate to be used in dashboard is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service.
- open
Search StringApi Certificate Id - certificate to be used for OpenSearch cluster api communication
- open
Search StringDashboard Certificate Id - certificate to be used for OpenSearch dashboard api communication
GetOpensearchClustersOpensearchClusterCollectionItemLoadBalancerConfig
- Load
Balancer intMax Bandwidth In Mbps - Maximum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- Load
Balancer intMin Bandwidth In Mbps - Minimum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- Load
Balancer stringService Type - Load balancer service for OpenSearch and OpenDashboard load balancer. Default value is LOAD_BALANCER.
- Load
Balancer intMax Bandwidth In Mbps - Maximum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- Load
Balancer intMin Bandwidth In Mbps - Minimum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- Load
Balancer stringService Type - Load balancer service for OpenSearch and OpenDashboard load balancer. Default value is LOAD_BALANCER.
- load
Balancer IntegerMax Bandwidth In Mbps - Maximum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- load
Balancer IntegerMin Bandwidth In Mbps - Minimum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- load
Balancer StringService Type - Load balancer service for OpenSearch and OpenDashboard load balancer. Default value is LOAD_BALANCER.
- load
Balancer numberMax Bandwidth In Mbps - Maximum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- load
Balancer numberMin Bandwidth In Mbps - Minimum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- load
Balancer stringService Type - Load balancer service for OpenSearch and OpenDashboard load balancer. Default value is LOAD_BALANCER.
- load_
balancer_ intmax_ bandwidth_ in_ mbps - Maximum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- load_
balancer_ intmin_ bandwidth_ in_ mbps - Minimum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- load_
balancer_ strservice_ type - Load balancer service for OpenSearch and OpenDashboard load balancer. Default value is LOAD_BALANCER.
- load
Balancer NumberMax Bandwidth In Mbps - Maximum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- load
Balancer NumberMin Bandwidth In Mbps - Minimum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service.
- load
Balancer StringService Type - Load balancer service for OpenSearch and OpenDashboard load balancer. Default value is LOAD_BALANCER.
GetOpensearchClustersOpensearchClusterCollectionItemMaintenanceDetail
- End
Time string - End time of the maintenance activity
- Notification
Email List<string>Ids - The Email Ids given the by customer to get notified about maintenance activities
- Start
Time string - Start time of the maintenance activity
- State string
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- End
Time string - End time of the maintenance activity
- Notification
Email []stringIds - The Email Ids given the by customer to get notified about maintenance activities
- Start
Time string - Start time of the maintenance activity
- State string
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- end
Time String - End time of the maintenance activity
- notification
Email List<String>Ids - The Email Ids given the by customer to get notified about maintenance activities
- start
Time String - Start time of the maintenance activity
- state String
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
- end
Time string - End time of the maintenance activity
- notification
Email string[]Ids - The Email Ids given the by customer to get notified about maintenance activities
- start
Time 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_ Sequence[str]ids - 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.
- end
Time String - End time of the maintenance activity
- notification
Email List<String>Ids - The Email Ids given the by customer to get notified about maintenance activities
- start
Time String - Start time of the maintenance activity
- state String
- A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfig
- Is
Enabled bool - Flag to indicate whether outbound cluster configuration is enabled
- Outbound
Clusters List<GetOpensearch Clusters Opensearch Cluster Collection Item Outbound Cluster Config Outbound Cluster> - 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 []GetOpensearch Clusters Opensearch Cluster Collection Item Outbound Cluster Config Outbound Cluster - List of outbound clusters to be connected to the inbound cluster
- is
Enabled Boolean - Flag to indicate whether outbound cluster configuration is enabled
- outbound
Clusters List<GetClusters Cluster Collection Item Outbound Cluster Config Outbound Cluster> - List of outbound clusters to be connected to the inbound cluster
- is
Enabled boolean - Flag to indicate whether outbound cluster configuration is enabled
- outbound
Clusters GetOpensearch Clusters Opensearch Cluster Collection Item Outbound Cluster Config Outbound Cluster[] - 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[GetOpensearch Clusters Opensearch Cluster Collection Item Outbound Cluster Config Outbound Cluster] - List of outbound clusters to be connected to the inbound cluster
- is
Enabled Boolean - Flag to indicate whether outbound cluster configuration is enabled
- outbound
Clusters List<Property Map> - List of outbound clusters to be connected to the inbound cluster
GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfigOutboundCluster
- Display
Name string - A filter to return only resources that match the entire display name given.
- 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
- Ping
Schedule 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.
- Seed
Cluster stringId - OCID of the Outbound cluster
- Display
Name string - A filter to return only resources that match the entire display name given.
- 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
- Ping
Schedule 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.
- Seed
Cluster stringId - OCID of the Outbound cluster
- display
Name String - A filter to return only resources that match the entire display name given.
- 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
- ping
Schedule 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.
- seed
Cluster StringId - OCID of the Outbound cluster
- display
Name string - A filter to return only resources that match the entire display name given.
- 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
- ping
Schedule 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.
- seed
Cluster stringId - OCID of the Outbound cluster
- display_
name str - A filter to return only resources that match the entire display name given.
- 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_ strid - OCID of the Outbound cluster
- display
Name String - A filter to return only resources that match the entire display name given.
- 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
- ping
Schedule 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.
- seed
Cluster StringId - OCID of the Outbound cluster
GetOpensearchClustersOpensearchClusterCollectionItemReverseConnectionEndpoint
- Customer
Ip string - The IP addresses of the endpoint in customer VCN
- Nat
Ip string - The NAT IP addresses of the endpoint in service VCN
- Customer
Ip string - The IP addresses of the endpoint in customer VCN
- Nat
Ip string - The NAT IP addresses of the endpoint in service VCN
- customer
Ip String - The IP addresses of the endpoint in customer VCN
- nat
Ip String - The NAT IP addresses of the endpoint in service VCN
- customer
Ip string - The IP addresses of the endpoint in customer VCN
- nat
Ip 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
- customer
Ip String - The IP addresses of the endpoint in customer VCN
- nat
Ip String - The NAT IP addresses of the endpoint in service VCN
GetOpensearchClustersOpensearchClusterCollectionItemSecuritySamlConfig
- Admin
Backend stringRole - Idp
Entity stringId - Idp
Metadata stringContent - Is
Enabled bool - Flag to indicate whether outbound cluster configuration is enabled
- Opendashboard
Url string - Roles
Key string - Subject
Key string
- Admin
Backend stringRole - Idp
Entity stringId - Idp
Metadata stringContent - Is
Enabled bool - Flag to indicate whether outbound cluster configuration is enabled
- Opendashboard
Url string - Roles
Key string - Subject
Key string
- admin
Backend StringRole - idp
Entity StringId - idp
Metadata StringContent - is
Enabled Boolean - Flag to indicate whether outbound cluster configuration is enabled
- opendashboard
Url String - roles
Key String - subject
Key String
- admin
Backend stringRole - idp
Entity stringId - idp
Metadata stringContent - is
Enabled boolean - Flag to indicate whether outbound cluster configuration is enabled
- opendashboard
Url string - roles
Key string - subject
Key string
- admin_
backend_ strrole - idp_
entity_ strid - idp_
metadata_ strcontent - is_
enabled bool - Flag to indicate whether outbound cluster configuration is enabled
- opendashboard_
url str - roles_
key str - subject_
key str
- admin
Backend StringRole - idp
Entity StringId - idp
Metadata StringContent - is
Enabled Boolean - Flag to indicate whether outbound cluster configuration is enabled
- opendashboard
Url String - roles
Key String - subject
Key String
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
published on Thursday, Mar 19, 2026 by Pulumi
