import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Opensearch Cluster resource in Oracle Cloud Infrastructure Opensearch service. * * Gets a OpensearchCluster by identifier * * ## Prerequisites * * The below policies must be created in compartment before creating OpensearchCluster * * ##### {Compartment-Name} - Name of your compartment * * 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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testOpensearchCluster = oci.opensearch.getOpensearchCluster({ * opensearchClusterId: testOpensearchClusterOciOpensearchOpensearchCluster.id, * }); * ``` */ export declare function getOpensearchCluster(args: GetOpensearchClusterArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getOpensearchCluster. */ export interface GetOpensearchClusterArgs { /** * unique OpensearchCluster identifier */ opensearchClusterId: string; } /** * A collection of values returned by getOpensearchCluster. */ export interface GetOpensearchClusterResult { /** * The availability domains to distribute the cluser nodes across. */ readonly availabilityDomains: string[]; /** * Custom certificate config for customer provided certs. */ readonly certificateConfigs: outputs.Opensearch.GetOpensearchClusterCertificateConfig[]; /** * The OCID of the compartment where the cluster is located. */ readonly compartmentId: string; readonly configureOutboundClusterTrigger: number; /** * The number of coordinator nodes configured for the cluster. */ readonly coordinatorNodeCount: number; /** * The amount of memory in GB, for the cluster's coordinator nodes. */ readonly coordinatorNodeHostMemoryGb: number; /** * The number of OCPUs configured for the cluster's coordinator nodes. */ readonly coordinatorNodeHostOcpuCount: number; /** * The node shape for the cluster's coordinator nodes. */ readonly coordinatorNodeHostShape: string; /** * The instance type for the cluster's coordinator nodes. */ readonly coordinatorNodeHostType: string; /** * The number of data nodes configured for the cluster. */ readonly dataNodeCount: number; /** * The bare metal shape for the cluster's data nodes. */ readonly dataNodeHostBareMetalShape: string; /** * The amount of memory in GB, for the cluster's data nodes. */ readonly dataNodeHostMemoryGb: number; /** * The number of OCPUs configured for the cluster's data nodes. */ readonly dataNodeHostOcpuCount: number; /** * The node shape for the cluster's data nodes. */ readonly dataNodeHostShape: string; /** * The instance type for the cluster's data nodes. */ readonly dataNodeHostType: string; /** * The amount of storage in GB, to configure per node for the cluster's data nodes. */ readonly dataNodeStorageGb: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: { [key: string]: string; }; /** * Name of the Outbound cluster. Avoid entering confidential information. */ readonly displayName: string; /** * The fully qualified domain name (FQDN) for the cluster's API endpoint. */ readonly fqdn: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ readonly freeformTags: { [key: string]: string; }; /** * The OCID of the cluster. */ readonly id: string; /** * List of inbound clusters for which this cluster is an outbound cluster */ readonly inboundClusterIds: string[]; /** * Additional information about the current lifecycle state of the cluster. */ readonly lifecycleDetails: string; /** * This config is used to choose the load balancer service and bandwidth for OpenSearch and OpenDashboard load balancers. */ readonly loadBalancerConfigs: outputs.Opensearch.GetOpensearchClusterLoadBalancerConfig[]; /** * Details for the maintenance activity. */ readonly maintenanceDetails: outputs.Opensearch.GetOpensearchClusterMaintenanceDetail[]; /** * The number of master nodes configured for the cluster. */ readonly masterNodeCount: number; /** * The bare metal shape for the cluster's master nodes. */ readonly masterNodeHostBareMetalShape: string; /** * The amount of memory in GB, for the cluster's master nodes. */ readonly masterNodeHostMemoryGb: number; /** * The number of OCPUs configured for cluster's master nodes. */ readonly masterNodeHostOcpuCount: number; /** * The node shape for the cluster's master nodes. */ readonly masterNodeHostShape: string; /** * The instance type for the cluster's master nodes. */ readonly masterNodeHostType: string; /** * The number of ML nodes configured for the cluster. */ readonly mlNodeCount: number; /** * The amount of memory in GB, for the cluster's ML nodes. */ readonly mlNodeHostMemoryGb: number; /** * The number of OCPUs configured for the cluster's ML nodes. */ readonly mlNodeHostOcpuCount: number; /** * The node shape for the cluster's ML nodes. */ readonly mlNodeHostShape: string; /** * The instance type for the cluster's ML nodes. */ readonly mlNodeHostType: string; /** * The amount of storage in GB, to configure per node for the cluster's ML nodes. */ readonly mlNodeStorageGb: number; /** * The OCID of the NSG where the private endpoint vnic will be attached. */ readonly nsgId: string; /** * The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint. */ readonly opendashboardFqdn: string; /** * The number of OpenSearch Dashboard nodes configured for the cluster. */ readonly opendashboardNodeCount: number; /** * The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes. */ readonly opendashboardNodeHostMemoryGb: number; /** * The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes. */ readonly opendashboardNodeHostOcpuCount: number; /** * The node shape for the cluster's OpenSearch Dashboard nodes. */ readonly opendashboardNodeHostShape: string; /** * The private IP address for the cluster's OpenSearch Dashboard. */ readonly opendashboardPrivateIp: string; readonly opensearchClusterId: string; /** * The fully qualified domain name (FQDN) for the cluster's API endpoint. */ readonly opensearchFqdn: string; /** * The cluster's private IP address. */ readonly opensearchPrivateIp: string; /** * This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster) */ readonly outboundClusterConfigs: outputs.Opensearch.GetOpensearchClusterOutboundClusterConfig[]; /** * The customer IP addresses of the endpoint in customer VCN */ readonly reverseConnectionEndpointCustomerIps: string[]; /** * The list of reverse connection endpoints. */ readonly reverseConnectionEndpoints: outputs.Opensearch.GetOpensearchClusterReverseConnectionEndpoint[]; /** * The number of search nodes configured for the cluster. */ readonly searchNodeCount: number; /** * The amount of memory in GB, for the cluster's search nodes. */ readonly searchNodeHostMemoryGb: number; /** * The number of OCPUs configured for the cluster's search nodes. */ readonly searchNodeHostOcpuCount: number; /** * The node shape for the cluster's search nodes. */ readonly searchNodeHostShape: string; /** * The instance type for the cluster's search nodes. */ readonly searchNodeHostType: string; /** * The amount of storage in GB, to configure per node for the cluster's search nodes. */ readonly searchNodeStorageGb: number; /** * Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` */ readonly securityAttributes: { [key: string]: string; }; /** * The name of the master user that are used to manage security config */ readonly securityMasterUserName: string; /** * The password hash of the master user that are used to manage security config */ readonly securityMasterUserPasswordHash: string; /** * The security mode of the cluster. */ readonly securityMode: string; readonly securitySamlConfigs: outputs.Opensearch.GetOpensearchClusterSecuritySamlConfig[]; /** * The software version the cluster is running. */ readonly softwareVersion: string; /** * The current state of the cluster. */ readonly state: string; /** * The OCID for the compartment where the cluster's subnet is located. */ readonly subnetCompartmentId: string; /** * The OCID of the cluster's subnet. */ readonly subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: { [key: string]: string; }; /** * The amount of time in milliseconds since the cluster was created. */ readonly timeCreated: string; /** * The amount of time in milliseconds since the cluster was updated. */ readonly timeDeleted: string; /** * The amount of time in milliseconds since the cluster was updated. */ readonly timeUpdated: string; /** * The size in GB of the cluster's total storage. */ readonly totalStorageGb: number; readonly upgradeMajorVersionTrigger: number; /** * The OCID for the compartment where the cluster's VCN is located. */ readonly vcnCompartmentId: string; /** * The OCID of the cluster's VCN. */ readonly vcnId: string; } /** * This data source provides details about a specific Opensearch Cluster resource in Oracle Cloud Infrastructure Opensearch service. * * Gets a OpensearchCluster by identifier * * ## Prerequisites * * The below policies must be created in compartment before creating OpensearchCluster * * ##### {Compartment-Name} - Name of your compartment * * 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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testOpensearchCluster = oci.opensearch.getOpensearchCluster({ * opensearchClusterId: testOpensearchClusterOciOpensearchOpensearchCluster.id, * }); * ``` */ export declare function getOpensearchClusterOutput(args: GetOpensearchClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getOpensearchCluster. */ export interface GetOpensearchClusterOutputArgs { /** * unique OpensearchCluster identifier */ opensearchClusterId: pulumi.Input; } //# sourceMappingURL=getOpensearchCluster.d.ts.map