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

oci.Opensearch.getOpensearchClusterPipeline

Explore with Pulumi AI

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

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

    Gets a OpensearchCluster Pipeline by identifier

    Example Usage

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

const testOpensearchClusterPipeline = oci.Opensearch.getOpensearchClusterPipeline({
    opensearchClusterPipelineId: testOpensearchClusterPipelineOciOpensearchOpensearchClusterPipeline.id,
});

    import pulumi
import pulumi_oci as oci

test_opensearch_cluster_pipeline = oci.Opensearch.get_opensearch_cluster_pipeline(opensearch_cluster_pipeline_id=test_opensearch_cluster_pipeline_oci_opensearch_opensearch_cluster_pipeline["id"])

    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.GetOpensearchClusterPipeline(ctx, &opensearch.GetOpensearchClusterPipelineArgs{
			OpensearchClusterPipelineId: testOpensearchClusterPipelineOciOpensearchOpensearchClusterPipeline.Id,
		}, 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 testOpensearchClusterPipeline = Oci.Opensearch.GetOpensearchClusterPipeline.Invoke(new()
    {
        OpensearchClusterPipelineId = testOpensearchClusterPipelineOciOpensearchOpensearchClusterPipeline.Id,
    });

});

    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.GetOpensearchClusterPipelineArgs;
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 testOpensearchClusterPipeline = OpensearchFunctions.getOpensearchClusterPipeline(GetOpensearchClusterPipelineArgs.builder()
            .opensearchClusterPipelineId(testOpensearchClusterPipelineOciOpensearchOpensearchClusterPipeline.id())
            .build());

    }
}

    variables:
  testOpensearchClusterPipeline:
    fn::invoke:
      function: oci:Opensearch:getOpensearchClusterPipeline
      arguments:
        opensearchClusterPipelineId: ${testOpensearchClusterPipelineOciOpensearchOpensearchClusterPipeline.id}

    Using getOpensearchClusterPipeline

    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 getOpensearchClusterPipeline(args: GetOpensearchClusterPipelineArgs, opts?: InvokeOptions): Promise<GetOpensearchClusterPipelineResult>
function getOpensearchClusterPipelineOutput(args: GetOpensearchClusterPipelineOutputArgs, opts?: InvokeOptions): Output<GetOpensearchClusterPipelineResult>
    def get_opensearch_cluster_pipeline(opensearch_cluster_pipeline_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetOpensearchClusterPipelineResult
def get_opensearch_cluster_pipeline_output(opensearch_cluster_pipeline_id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetOpensearchClusterPipelineResult]
    func GetOpensearchClusterPipeline(ctx *Context, args *GetOpensearchClusterPipelineArgs, opts ...InvokeOption) (*GetOpensearchClusterPipelineResult, error)
func GetOpensearchClusterPipelineOutput(ctx *Context, args *GetOpensearchClusterPipelineOutputArgs, opts ...InvokeOption) GetOpensearchClusterPipelineResultOutput

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

    public static class GetOpensearchClusterPipeline 
{
    public static Task<GetOpensearchClusterPipelineResult> InvokeAsync(GetOpensearchClusterPipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetOpensearchClusterPipelineResult> Invoke(GetOpensearchClusterPipelineInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOpensearchClusterPipelineResult> getOpensearchClusterPipeline(GetOpensearchClusterPipelineArgs args, InvokeOptions options)
public static Output<GetOpensearchClusterPipelineResult> getOpensearchClusterPipeline(GetOpensearchClusterPipelineArgs args, InvokeOptions options)

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

    The following arguments are supported:

    OpensearchClusterPipelineId string
    unique OpensearchClusterPipeline identifier
    OpensearchClusterPipelineId string
    unique OpensearchClusterPipeline identifier
    opensearchClusterPipelineId String
    unique OpensearchClusterPipeline identifier
    opensearchClusterPipelineId string
    unique OpensearchClusterPipeline identifier
    opensearch_cluster_pipeline_id str
    unique OpensearchClusterPipeline identifier
    opensearchClusterPipelineId String
    unique OpensearchClusterPipeline identifier

    getOpensearchClusterPipeline Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment where the pipeline is located.
    DataPrepperConfigurationBody string
    The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    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
    The name of the pipeline. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the cluster pipeline.
    MemoryGb int
    The amount of memory in GB, for each pipeline node.
    NodeCount int
    The number of nodes configured for the pipeline.
    NsgId string
    The OCID of the NSG where the pipeline private endpoint vnic will be attached.
    OcpuCount int
    The number of OCPUs configured for each pipeline node.
    OpcDryRun bool
    OpensearchClusterPipelineId string
    OpensearchPipelineFqdn string
    The fully qualified domain name (FQDN) for the cluster's API endpoint.
    OpensearchPipelinePrivateIp string
    The pipeline's private IP address.
    PipelineConfigurationBody string
    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    PipelineMode string
    The current state of the pipeline.
    ReverseConnectionEndpoints List<GetOpensearchClusterPipelineReverseConnectionEndpoint>
    The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
    State string
    The current state of the cluster backup.
    SubnetCompartmentId string
    The OCID for the compartment where the pipeline's subnet is located.
    SubnetId string
    The OCID of the pipeline'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 date and time the cluster pipeline was created. Format defined by RFC3339.
    TimeUpdated string
    The amount of time in milliseconds since the pipeline was updated.
    VcnCompartmentId string
    The OCID for the compartment where the pipeline's VCN is located.
    VcnId string
    The OCID of the pipeline's VCN.
    CompartmentId string
    The OCID of the compartment where the pipeline is located.
    DataPrepperConfigurationBody string
    The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    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
    The name of the pipeline. Avoid entering confidential information.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the cluster pipeline.
    MemoryGb int
    The amount of memory in GB, for each pipeline node.
    NodeCount int
    The number of nodes configured for the pipeline.
    NsgId string
    The OCID of the NSG where the pipeline private endpoint vnic will be attached.
    OcpuCount int
    The number of OCPUs configured for each pipeline node.
    OpcDryRun bool
    OpensearchClusterPipelineId string
    OpensearchPipelineFqdn string
    The fully qualified domain name (FQDN) for the cluster's API endpoint.
    OpensearchPipelinePrivateIp string
    The pipeline's private IP address.
    PipelineConfigurationBody string
    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    PipelineMode string
    The current state of the pipeline.
    ReverseConnectionEndpoints []GetOpensearchClusterPipelineReverseConnectionEndpoint
    The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
    State string
    The current state of the cluster backup.
    SubnetCompartmentId string
    The OCID for the compartment where the pipeline's subnet is located.
    SubnetId string
    The OCID of the pipeline'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 date and time the cluster pipeline was created. Format defined by RFC3339.
    TimeUpdated string
    The amount of time in milliseconds since the pipeline was updated.
    VcnCompartmentId string
    The OCID for the compartment where the pipeline's VCN is located.
    VcnId string
    The OCID of the pipeline's VCN.
    compartmentId String
    The OCID of the compartment where the pipeline is located.
    dataPrepperConfigurationBody String
    The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    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
    The name of the pipeline. Avoid entering confidential information.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the cluster pipeline.
    memoryGb Integer
    The amount of memory in GB, for each pipeline node.
    nodeCount Integer
    The number of nodes configured for the pipeline.
    nsgId String
    The OCID of the NSG where the pipeline private endpoint vnic will be attached.
    ocpuCount Integer
    The number of OCPUs configured for each pipeline node.
    opcDryRun Boolean
    opensearchClusterPipelineId String
    opensearchPipelineFqdn String
    The fully qualified domain name (FQDN) for the cluster's API endpoint.
    opensearchPipelinePrivateIp String
    The pipeline's private IP address.
    pipelineConfigurationBody String
    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    pipelineMode String
    The current state of the pipeline.
    reverseConnectionEndpoints List<GetClusterPipelineReverseConnectionEndpoint>
    The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
    state String
    The current state of the cluster backup.
    subnetCompartmentId String
    The OCID for the compartment where the pipeline's subnet is located.
    subnetId String
    The OCID of the pipeline'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 date and time the cluster pipeline was created. Format defined by RFC3339.
    timeUpdated String
    The amount of time in milliseconds since the pipeline was updated.
    vcnCompartmentId String
    The OCID for the compartment where the pipeline's VCN is located.
    vcnId String
    The OCID of the pipeline's VCN.
    compartmentId string
    The OCID of the compartment where the pipeline is located.
    dataPrepperConfigurationBody string
    The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    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
    The name of the pipeline. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    The OCID of the cluster pipeline.
    memoryGb number
    The amount of memory in GB, for each pipeline node.
    nodeCount number
    The number of nodes configured for the pipeline.
    nsgId string
    The OCID of the NSG where the pipeline private endpoint vnic will be attached.
    ocpuCount number
    The number of OCPUs configured for each pipeline node.
    opcDryRun boolean
    opensearchClusterPipelineId string
    opensearchPipelineFqdn string
    The fully qualified domain name (FQDN) for the cluster's API endpoint.
    opensearchPipelinePrivateIp string
    The pipeline's private IP address.
    pipelineConfigurationBody string
    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    pipelineMode string
    The current state of the pipeline.
    reverseConnectionEndpoints GetOpensearchClusterPipelineReverseConnectionEndpoint[]
    The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
    state string
    The current state of the cluster backup.
    subnetCompartmentId string
    The OCID for the compartment where the pipeline's subnet is located.
    subnetId string
    The OCID of the pipeline'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 date and time the cluster pipeline was created. Format defined by RFC3339.
    timeUpdated string
    The amount of time in milliseconds since the pipeline was updated.
    vcnCompartmentId string
    The OCID for the compartment where the pipeline's VCN is located.
    vcnId string
    The OCID of the pipeline's VCN.
    compartment_id str
    The OCID of the compartment where the pipeline is located.
    data_prepper_configuration_body str
    The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    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
    The name of the pipeline. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    The OCID of the cluster pipeline.
    memory_gb int
    The amount of memory in GB, for each pipeline node.
    node_count int
    The number of nodes configured for the pipeline.
    nsg_id str
    The OCID of the NSG where the pipeline private endpoint vnic will be attached.
    ocpu_count int
    The number of OCPUs configured for each pipeline node.
    opc_dry_run bool
    opensearch_cluster_pipeline_id str
    opensearch_pipeline_fqdn str
    The fully qualified domain name (FQDN) for the cluster's API endpoint.
    opensearch_pipeline_private_ip str
    The pipeline's private IP address.
    pipeline_configuration_body str
    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    pipeline_mode str
    The current state of the pipeline.
    reverse_connection_endpoints Sequence[opensearch.GetOpensearchClusterPipelineReverseConnectionEndpoint]
    The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
    state str
    The current state of the cluster backup.
    subnet_compartment_id str
    The OCID for the compartment where the pipeline's subnet is located.
    subnet_id str
    The OCID of the pipeline'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 date and time the cluster pipeline was created. Format defined by RFC3339.
    time_updated str
    The amount of time in milliseconds since the pipeline was updated.
    vcn_compartment_id str
    The OCID for the compartment where the pipeline's VCN is located.
    vcn_id str
    The OCID of the pipeline's VCN.
    compartmentId String
    The OCID of the compartment where the pipeline is located.
    dataPrepperConfigurationBody String
    The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    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
    The name of the pipeline. Avoid entering confidential information.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the cluster pipeline.
    memoryGb Number
    The amount of memory in GB, for each pipeline node.
    nodeCount Number
    The number of nodes configured for the pipeline.
    nsgId String
    The OCID of the NSG where the pipeline private endpoint vnic will be attached.
    ocpuCount Number
    The number of OCPUs configured for each pipeline node.
    opcDryRun Boolean
    opensearchClusterPipelineId String
    opensearchPipelineFqdn String
    The fully qualified domain name (FQDN) for the cluster's API endpoint.
    opensearchPipelinePrivateIp String
    The pipeline's private IP address.
    pipelineConfigurationBody String
    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .
    pipelineMode String
    The current state of the pipeline.
    reverseConnectionEndpoints List<Property Map>
    The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
    state String
    The current state of the cluster backup.
    subnetCompartmentId String
    The OCID for the compartment where the pipeline's subnet is located.
    subnetId String
    The OCID of the pipeline'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 date and time the cluster pipeline was created. Format defined by RFC3339.
    timeUpdated String
    The amount of time in milliseconds since the pipeline was updated.
    vcnCompartmentId String
    The OCID for the compartment where the pipeline's VCN is located.
    vcnId String
    The OCID of the pipeline's VCN.

    Supporting Types

    GetOpensearchClusterPipelineReverseConnectionEndpoint

    CustomerFqdn string
    The fully qualified domain name of the customerIp in the customer VCN
    CustomerIp string
    The IPv4 address in the customer VCN
    CustomerFqdn string
    The fully qualified domain name of the customerIp in the customer VCN
    CustomerIp string
    The IPv4 address in the customer VCN
    customerFqdn String
    The fully qualified domain name of the customerIp in the customer VCN
    customerIp String
    The IPv4 address in the customer VCN
    customerFqdn string
    The fully qualified domain name of the customerIp in the customer VCN
    customerIp string
    The IPv4 address in the customer VCN
    customer_fqdn str
    The fully qualified domain name of the customerIp in the customer VCN
    customer_ip str
    The IPv4 address in the customer VCN
    customerFqdn String
    The fully qualified domain name of the customerIp in the customer VCN
    customerIp String
    The IPv4 address in the customer 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.28.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-oci