1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Opensearch
  5. getOpensearchClusterPipelines
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.Opensearch.getOpensearchClusterPipelines

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

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

Returns a list of OpensearchClusterPipelines.

Example Usage

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

const testOpensearchClusterPipelines = oci.Opensearch.getOpensearchClusterPipelines({
    compartmentId: compartmentId,
    displayName: opensearchClusterPipelineDisplayName,
    id: opensearchClusterPipelineId,
    pipelineComponentId: testPipelineComponent.id,
    state: opensearchClusterPipelineState,
});
Copy
import pulumi
import pulumi_oci as oci

test_opensearch_cluster_pipelines = oci.Opensearch.get_opensearch_cluster_pipelines(compartment_id=compartment_id,
    display_name=opensearch_cluster_pipeline_display_name,
    id=opensearch_cluster_pipeline_id,
    pipeline_component_id=test_pipeline_component["id"],
    state=opensearch_cluster_pipeline_state)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/opensearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opensearch.GetOpensearchClusterPipelines(ctx, &opensearch.GetOpensearchClusterPipelinesArgs{
			CompartmentId:       compartmentId,
			DisplayName:         pulumi.StringRef(opensearchClusterPipelineDisplayName),
			Id:                  pulumi.StringRef(opensearchClusterPipelineId),
			PipelineComponentId: pulumi.StringRef(testPipelineComponent.Id),
			State:               pulumi.StringRef(opensearchClusterPipelineState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testOpensearchClusterPipelines = Oci.Opensearch.GetOpensearchClusterPipelines.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = opensearchClusterPipelineDisplayName,
        Id = opensearchClusterPipelineId,
        PipelineComponentId = testPipelineComponent.Id,
        State = opensearchClusterPipelineState,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Opensearch.OpensearchFunctions;
import com.pulumi.oci.Opensearch.inputs.GetOpensearchClusterPipelinesArgs;
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 testOpensearchClusterPipelines = OpensearchFunctions.getOpensearchClusterPipelines(GetOpensearchClusterPipelinesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(opensearchClusterPipelineDisplayName)
            .id(opensearchClusterPipelineId)
            .pipelineComponentId(testPipelineComponent.id())
            .state(opensearchClusterPipelineState)
            .build());

    }
}
Copy
variables:
  testOpensearchClusterPipelines:
    fn::invoke:
      function: oci:Opensearch:getOpensearchClusterPipelines
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${opensearchClusterPipelineDisplayName}
        id: ${opensearchClusterPipelineId}
        pipelineComponentId: ${testPipelineComponent.id}
        state: ${opensearchClusterPipelineState}
Copy

Using getOpensearchClusterPipelines

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 getOpensearchClusterPipelines(args: GetOpensearchClusterPipelinesArgs, opts?: InvokeOptions): Promise<GetOpensearchClusterPipelinesResult>
function getOpensearchClusterPipelinesOutput(args: GetOpensearchClusterPipelinesOutputArgs, opts?: InvokeOptions): Output<GetOpensearchClusterPipelinesResult>
Copy
def get_opensearch_cluster_pipelines(compartment_id: Optional[str] = None,
                                     display_name: Optional[str] = None,
                                     filters: Optional[Sequence[_opensearch.GetOpensearchClusterPipelinesFilter]] = None,
                                     id: Optional[str] = None,
                                     pipeline_component_id: Optional[str] = None,
                                     state: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetOpensearchClusterPipelinesResult
def get_opensearch_cluster_pipelines_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                     display_name: Optional[pulumi.Input[str]] = None,
                                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[_opensearch.GetOpensearchClusterPipelinesFilterArgs]]]] = None,
                                     id: Optional[pulumi.Input[str]] = None,
                                     pipeline_component_id: Optional[pulumi.Input[str]] = None,
                                     state: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetOpensearchClusterPipelinesResult]
Copy
func GetOpensearchClusterPipelines(ctx *Context, args *GetOpensearchClusterPipelinesArgs, opts ...InvokeOption) (*GetOpensearchClusterPipelinesResult, error)
func GetOpensearchClusterPipelinesOutput(ctx *Context, args *GetOpensearchClusterPipelinesOutputArgs, opts ...InvokeOption) GetOpensearchClusterPipelinesResultOutput
Copy

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

public static class GetOpensearchClusterPipelines 
{
    public static Task<GetOpensearchClusterPipelinesResult> InvokeAsync(GetOpensearchClusterPipelinesArgs args, InvokeOptions? opts = null)
    public static Output<GetOpensearchClusterPipelinesResult> Invoke(GetOpensearchClusterPipelinesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOpensearchClusterPipelinesResult> getOpensearchClusterPipelines(GetOpensearchClusterPipelinesArgs args, InvokeOptions options)
public static Output<GetOpensearchClusterPipelinesResult> getOpensearchClusterPipelines(GetOpensearchClusterPipelinesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Opensearch/getOpensearchClusterPipelines:getOpensearchClusterPipelines
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. List<GetOpensearchClusterPipelinesFilter>
Id string
unique OpensearchClusterPipeline identifier
PipelineComponentId string
A filter to return pipelines whose any component has the given pipelineComponentId.
State string
A filter to return only resources their lifecycleState matches the given lifecycleState.
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. []GetOpensearchClusterPipelinesFilter
Id string
unique OpensearchClusterPipeline identifier
PipelineComponentId string
A filter to return pipelines whose any component has the given pipelineComponentId.
State string
A filter to return only resources their lifecycleState matches the given lifecycleState.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<GetClusterPipelinesFilter>
id String
unique OpensearchClusterPipeline identifier
pipelineComponentId String
A filter to return pipelines whose any component has the given pipelineComponentId.
state String
A filter to return only resources their lifecycleState matches the given lifecycleState.
compartmentId This property is required. string
The ID of the compartment in which to list resources.
displayName string
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. GetOpensearchClusterPipelinesFilter[]
id string
unique OpensearchClusterPipeline identifier
pipelineComponentId string
A filter to return pipelines whose any component has the given pipelineComponentId.
state string
A filter to return only resources their lifecycleState matches the given lifecycleState.
compartment_id This property is required. 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 Changes to this property will trigger replacement. Sequence[opensearch.GetOpensearchClusterPipelinesFilter]
id str
unique OpensearchClusterPipeline identifier
pipeline_component_id str
A filter to return pipelines whose any component has the given pipelineComponentId.
state str
A filter to return only resources their lifecycleState matches the given lifecycleState.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<Property Map>
id String
unique OpensearchClusterPipeline identifier
pipelineComponentId String
A filter to return pipelines whose any component has the given pipelineComponentId.
state String
A filter to return only resources their lifecycleState matches the given lifecycleState.

getOpensearchClusterPipelines Result

The following output properties are available:

CompartmentId string
The OCID of the compartment where the pipeline is located.
OpensearchClusterPipelineCollections List<GetOpensearchClusterPipelinesOpensearchClusterPipelineCollection>
The list of opensearch_cluster_pipeline_collection.
DisplayName string
The name of the pipeline. Avoid entering confidential information.
Filters List<GetOpensearchClusterPipelinesFilter>
Id string
The OCID of the cluster pipeline.
PipelineComponentId string
State string
The current state of the cluster backup.
CompartmentId string
The OCID of the compartment where the pipeline is located.
OpensearchClusterPipelineCollections []GetOpensearchClusterPipelinesOpensearchClusterPipelineCollection
The list of opensearch_cluster_pipeline_collection.
DisplayName string
The name of the pipeline. Avoid entering confidential information.
Filters []GetOpensearchClusterPipelinesFilter
Id string
The OCID of the cluster pipeline.
PipelineComponentId string
State string
The current state of the cluster backup.
compartmentId String
The OCID of the compartment where the pipeline is located.
opensearchClusterPipelineCollections List<GetClusterPipelinesClusterPipelineCollection>
The list of opensearch_cluster_pipeline_collection.
displayName String
The name of the pipeline. Avoid entering confidential information.
filters List<GetClusterPipelinesFilter>
id String
The OCID of the cluster pipeline.
pipelineComponentId String
state String
The current state of the cluster backup.
compartmentId string
The OCID of the compartment where the pipeline is located.
opensearchClusterPipelineCollections GetOpensearchClusterPipelinesOpensearchClusterPipelineCollection[]
The list of opensearch_cluster_pipeline_collection.
displayName string
The name of the pipeline. Avoid entering confidential information.
filters GetOpensearchClusterPipelinesFilter[]
id string
The OCID of the cluster pipeline.
pipelineComponentId string
state string
The current state of the cluster backup.
compartment_id str
The OCID of the compartment where the pipeline is located.
opensearch_cluster_pipeline_collections Sequence[opensearch.GetOpensearchClusterPipelinesOpensearchClusterPipelineCollection]
The list of opensearch_cluster_pipeline_collection.
display_name str
The name of the pipeline. Avoid entering confidential information.
filters Sequence[opensearch.GetOpensearchClusterPipelinesFilter]
id str
The OCID of the cluster pipeline.
pipeline_component_id str
state str
The current state of the cluster backup.
compartmentId String
The OCID of the compartment where the pipeline is located.
opensearchClusterPipelineCollections List<Property Map>
The list of opensearch_cluster_pipeline_collection.
displayName String
The name of the pipeline. Avoid entering confidential information.
filters List<Property Map>
id String
The OCID of the cluster pipeline.
pipelineComponentId String
state String
The current state of the cluster backup.

Supporting Types

GetOpensearchClusterPipelinesFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

GetOpensearchClusterPipelinesOpensearchClusterPipelineCollection

items This property is required. List<Property Map>

GetOpensearchClusterPipelinesOpensearchClusterPipelineCollectionItem

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DataPrepperConfigurationBody This property is required. 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 This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
FreeformTags This property is required. 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 This property is required. string
unique OpensearchClusterPipeline identifier
MemoryGb This property is required. int
The amount of memory in GB, for each pipeline node.
NodeCount This property is required. int
The number of nodes configured for the pipeline.
NsgId This property is required. string
The OCID of the NSG where the pipeline private endpoint vnic will be attached.
OcpuCount This property is required. int
The number of OCPUs configured for each pipeline node.
OpcDryRun This property is required. bool
OpensearchPipelineFqdn This property is required. string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
OpensearchPipelinePrivateIp This property is required. string
The pipeline's private IP address.
PipelineConfigurationBody This property is required. 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 This property is required. string
The current state of the pipeline.
ReverseConnectionEndpoints This property is required. List<GetOpensearchClusterPipelinesOpensearchClusterPipelineCollectionItemReverseConnectionEndpoint>
The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
State This property is required. string
A filter to return only resources their lifecycleState matches the given lifecycleState.
SubnetCompartmentId This property is required. string
The OCID for the compartment where the pipeline's subnet is located.
SubnetId This property is required. string
The OCID of the pipeline's subnet.
SystemTags This property is required. Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The date and time the cluster pipeline was created. Format defined by RFC3339.
TimeUpdated This property is required. string
The amount of time in milliseconds since the pipeline was updated.
VcnCompartmentId This property is required. string
The OCID for the compartment where the pipeline's VCN is located.
VcnId This property is required. string
The OCID of the pipeline's VCN.
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DataPrepperConfigurationBody This property is required. 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 This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
FreeformTags This property is required. 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 This property is required. string
unique OpensearchClusterPipeline identifier
MemoryGb This property is required. int
The amount of memory in GB, for each pipeline node.
NodeCount This property is required. int
The number of nodes configured for the pipeline.
NsgId This property is required. string
The OCID of the NSG where the pipeline private endpoint vnic will be attached.
OcpuCount This property is required. int
The number of OCPUs configured for each pipeline node.
OpcDryRun This property is required. bool
OpensearchPipelineFqdn This property is required. string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
OpensearchPipelinePrivateIp This property is required. string
The pipeline's private IP address.
PipelineConfigurationBody This property is required. 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 This property is required. string
The current state of the pipeline.
ReverseConnectionEndpoints This property is required. []GetOpensearchClusterPipelinesOpensearchClusterPipelineCollectionItemReverseConnectionEndpoint
The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
State This property is required. string
A filter to return only resources their lifecycleState matches the given lifecycleState.
SubnetCompartmentId This property is required. string
The OCID for the compartment where the pipeline's subnet is located.
SubnetId This property is required. string
The OCID of the pipeline's subnet.
SystemTags This property is required. map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
The date and time the cluster pipeline was created. Format defined by RFC3339.
TimeUpdated This property is required. string
The amount of time in milliseconds since the pipeline was updated.
VcnCompartmentId This property is required. string
The OCID for the compartment where the pipeline's VCN is located.
VcnId This property is required. string
The OCID of the pipeline's VCN.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
dataPrepperConfigurationBody This property is required. 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 This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
A filter to return only resources that match the entire display name given.
freeformTags This property is required. 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 This property is required. String
unique OpensearchClusterPipeline identifier
memoryGb This property is required. Integer
The amount of memory in GB, for each pipeline node.
nodeCount This property is required. Integer
The number of nodes configured for the pipeline.
nsgId This property is required. String
The OCID of the NSG where the pipeline private endpoint vnic will be attached.
ocpuCount This property is required. Integer
The number of OCPUs configured for each pipeline node.
opcDryRun This property is required. Boolean
opensearchPipelineFqdn This property is required. String
The fully qualified domain name (FQDN) for the cluster's API endpoint.
opensearchPipelinePrivateIp This property is required. String
The pipeline's private IP address.
pipelineConfigurationBody This property is required. 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 This property is required. String
The current state of the pipeline.
reverseConnectionEndpoints This property is required. List<GetClusterPipelinesClusterPipelineCollectionItemReverseConnectionEndpoint>
The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
state This property is required. String
A filter to return only resources their lifecycleState matches the given lifecycleState.
subnetCompartmentId This property is required. String
The OCID for the compartment where the pipeline's subnet is located.
subnetId This property is required. String
The OCID of the pipeline's subnet.
systemTags This property is required. Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The date and time the cluster pipeline was created. Format defined by RFC3339.
timeUpdated This property is required. String
The amount of time in milliseconds since the pipeline was updated.
vcnCompartmentId This property is required. String
The OCID for the compartment where the pipeline's VCN is located.
vcnId This property is required. String
The OCID of the pipeline's VCN.
compartmentId This property is required. string
The ID of the compartment in which to list resources.
dataPrepperConfigurationBody This property is required. 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 This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. string
A filter to return only resources that match the entire display name given.
freeformTags This property is required. {[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 This property is required. string
unique OpensearchClusterPipeline identifier
memoryGb This property is required. number
The amount of memory in GB, for each pipeline node.
nodeCount This property is required. number
The number of nodes configured for the pipeline.
nsgId This property is required. string
The OCID of the NSG where the pipeline private endpoint vnic will be attached.
ocpuCount This property is required. number
The number of OCPUs configured for each pipeline node.
opcDryRun This property is required. boolean
opensearchPipelineFqdn This property is required. string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
opensearchPipelinePrivateIp This property is required. string
The pipeline's private IP address.
pipelineConfigurationBody This property is required. 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 This property is required. string
The current state of the pipeline.
reverseConnectionEndpoints This property is required. GetOpensearchClusterPipelinesOpensearchClusterPipelineCollectionItemReverseConnectionEndpoint[]
The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
state This property is required. string
A filter to return only resources their lifecycleState matches the given lifecycleState.
subnetCompartmentId This property is required. string
The OCID for the compartment where the pipeline's subnet is located.
subnetId This property is required. string
The OCID of the pipeline's subnet.
systemTags This property is required. {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. string
The date and time the cluster pipeline was created. Format defined by RFC3339.
timeUpdated This property is required. string
The amount of time in milliseconds since the pipeline was updated.
vcnCompartmentId This property is required. string
The OCID for the compartment where the pipeline's VCN is located.
vcnId This property is required. string
The OCID of the pipeline's VCN.
compartment_id This property is required. str
The ID of the compartment in which to list resources.
data_prepper_configuration_body This property is required. 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 This property is required. 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 This property is required. str
A filter to return only resources that match the entire display name given.
freeform_tags This property is required. 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 This property is required. str
unique OpensearchClusterPipeline identifier
memory_gb This property is required. int
The amount of memory in GB, for each pipeline node.
node_count This property is required. int
The number of nodes configured for the pipeline.
nsg_id This property is required. str
The OCID of the NSG where the pipeline private endpoint vnic will be attached.
ocpu_count This property is required. int
The number of OCPUs configured for each pipeline node.
opc_dry_run This property is required. bool
opensearch_pipeline_fqdn This property is required. str
The fully qualified domain name (FQDN) for the cluster's API endpoint.
opensearch_pipeline_private_ip This property is required. str
The pipeline's private IP address.
pipeline_configuration_body This property is required. 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 This property is required. str
The current state of the pipeline.
reverse_connection_endpoints This property is required. Sequence[opensearch.GetOpensearchClusterPipelinesOpensearchClusterPipelineCollectionItemReverseConnectionEndpoint]
The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
state This property is required. str
A filter to return only resources their lifecycleState matches the given lifecycleState.
subnet_compartment_id This property is required. str
The OCID for the compartment where the pipeline's subnet is located.
subnet_id This property is required. str
The OCID of the pipeline's subnet.
system_tags This property is required. Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created This property is required. str
The date and time the cluster pipeline was created. Format defined by RFC3339.
time_updated This property is required. str
The amount of time in milliseconds since the pipeline was updated.
vcn_compartment_id This property is required. str
The OCID for the compartment where the pipeline's VCN is located.
vcn_id This property is required. str
The OCID of the pipeline's VCN.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
dataPrepperConfigurationBody This property is required. 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 This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
A filter to return only resources that match the entire display name given.
freeformTags This property is required. 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 This property is required. String
unique OpensearchClusterPipeline identifier
memoryGb This property is required. Number
The amount of memory in GB, for each pipeline node.
nodeCount This property is required. Number
The number of nodes configured for the pipeline.
nsgId This property is required. String
The OCID of the NSG where the pipeline private endpoint vnic will be attached.
ocpuCount This property is required. Number
The number of OCPUs configured for each pipeline node.
opcDryRun This property is required. Boolean
opensearchPipelineFqdn This property is required. String
The fully qualified domain name (FQDN) for the cluster's API endpoint.
opensearchPipelinePrivateIp This property is required. String
The pipeline's private IP address.
pipelineConfigurationBody This property is required. 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 This property is required. String
The current state of the pipeline.
reverseConnectionEndpoints This property is required. List<Property Map>
The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
state This property is required. String
A filter to return only resources their lifecycleState matches the given lifecycleState.
subnetCompartmentId This property is required. String
The OCID for the compartment where the pipeline's subnet is located.
subnetId This property is required. String
The OCID of the pipeline's subnet.
systemTags This property is required. Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
The date and time the cluster pipeline was created. Format defined by RFC3339.
timeUpdated This property is required. String
The amount of time in milliseconds since the pipeline was updated.
vcnCompartmentId This property is required. String
The OCID for the compartment where the pipeline's VCN is located.
vcnId This property is required. String
The OCID of the pipeline's VCN.

GetOpensearchClusterPipelinesOpensearchClusterPipelineCollectionItemReverseConnectionEndpoint

CustomerFqdn This property is required. string
The fully qualified domain name of the customerIp in the customer VCN
CustomerIp This property is required. string
The IPv4 address in the customer VCN
CustomerFqdn This property is required. string
The fully qualified domain name of the customerIp in the customer VCN
CustomerIp This property is required. string
The IPv4 address in the customer VCN
customerFqdn This property is required. String
The fully qualified domain name of the customerIp in the customer VCN
customerIp This property is required. String
The IPv4 address in the customer VCN
customerFqdn This property is required. string
The fully qualified domain name of the customerIp in the customer VCN
customerIp This property is required. string
The IPv4 address in the customer VCN
customer_fqdn This property is required. str
The fully qualified domain name of the customerIp in the customer VCN
customer_ip This property is required. str
The IPv4 address in the customer VCN
customerFqdn This property is required. String
The fully qualified domain name of the customerIp in the customer VCN
customerIp This property is required. 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.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi