Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Opensearch
  5. OpensearchClusterPipeline
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

oci.Opensearch.OpensearchClusterPipeline

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Opensearch Cluster Pipeline resource in Oracle Cloud Infrastructure Opensearch service.

Creates a new OpensearchCluster Pipeline.

Example Usage

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

const testOpensearchClusterPipeline = new oci.opensearch.OpensearchClusterPipeline("test_opensearch_cluster_pipeline", {
    compartmentId: compartmentId,
    dataPrepperConfigurationBody: opensearchClusterPipelineDataPrepperConfigurationBody,
    displayName: opensearchClusterPipelineDisplayName,
    memoryGb: opensearchClusterPipelineMemoryGb,
    nodeCount: opensearchClusterPipelineNodeCount,
    ocpuCount: opensearchClusterPipelineOcpuCount,
    pipelineConfigurationBody: opensearchClusterPipelinePipelineConfigurationBody,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    nsgId: testNsg.id,
    opcDryRun: opensearchClusterPipelineOpcDryRun,
    reverseConnectionEndpoints: [{
        customerFqdn: opensearchClusterPipelineReverseConnectionEndpointsCustomerFqdn,
        customerIp: opensearchClusterPipelineReverseConnectionEndpointsCustomerIp,
    }],
    subnetCompartmentId: testCompartment.id,
    subnetId: testSubnet.id,
    vcnCompartmentId: testCompartment.id,
    vcnId: testVcn.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_opensearch_cluster_pipeline = oci.opensearch.OpensearchClusterPipeline("test_opensearch_cluster_pipeline",
    compartment_id=compartment_id,
    data_prepper_configuration_body=opensearch_cluster_pipeline_data_prepper_configuration_body,
    display_name=opensearch_cluster_pipeline_display_name,
    memory_gb=opensearch_cluster_pipeline_memory_gb,
    node_count=opensearch_cluster_pipeline_node_count,
    ocpu_count=opensearch_cluster_pipeline_ocpu_count,
    pipeline_configuration_body=opensearch_cluster_pipeline_pipeline_configuration_body,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    nsg_id=test_nsg["id"],
    opc_dry_run=opensearch_cluster_pipeline_opc_dry_run,
    reverse_connection_endpoints=[{
        "customer_fqdn": opensearch_cluster_pipeline_reverse_connection_endpoints_customer_fqdn,
        "customer_ip": opensearch_cluster_pipeline_reverse_connection_endpoints_customer_ip,
    }],
    subnet_compartment_id=test_compartment["id"],
    subnet_id=test_subnet["id"],
    vcn_compartment_id=test_compartment["id"],
    vcn_id=test_vcn["id"])
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.NewOpensearchClusterPipeline(ctx, "test_opensearch_cluster_pipeline", &opensearch.OpensearchClusterPipelineArgs{
			CompartmentId:                pulumi.Any(compartmentId),
			DataPrepperConfigurationBody: pulumi.Any(opensearchClusterPipelineDataPrepperConfigurationBody),
			DisplayName:                  pulumi.Any(opensearchClusterPipelineDisplayName),
			MemoryGb:                     pulumi.Any(opensearchClusterPipelineMemoryGb),
			NodeCount:                    pulumi.Any(opensearchClusterPipelineNodeCount),
			OcpuCount:                    pulumi.Any(opensearchClusterPipelineOcpuCount),
			PipelineConfigurationBody:    pulumi.Any(opensearchClusterPipelinePipelineConfigurationBody),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			NsgId:     pulumi.Any(testNsg.Id),
			OpcDryRun: pulumi.Any(opensearchClusterPipelineOpcDryRun),
			ReverseConnectionEndpoints: opensearch.OpensearchClusterPipelineReverseConnectionEndpointArray{
				&opensearch.OpensearchClusterPipelineReverseConnectionEndpointArgs{
					CustomerFqdn: pulumi.Any(opensearchClusterPipelineReverseConnectionEndpointsCustomerFqdn),
					CustomerIp:   pulumi.Any(opensearchClusterPipelineReverseConnectionEndpointsCustomerIp),
				},
			},
			SubnetCompartmentId: pulumi.Any(testCompartment.Id),
			SubnetId:            pulumi.Any(testSubnet.Id),
			VcnCompartmentId:    pulumi.Any(testCompartment.Id),
			VcnId:               pulumi.Any(testVcn.Id),
		})
		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 testOpensearchClusterPipeline = new Oci.Opensearch.OpensearchClusterPipeline("test_opensearch_cluster_pipeline", new()
    {
        CompartmentId = compartmentId,
        DataPrepperConfigurationBody = opensearchClusterPipelineDataPrepperConfigurationBody,
        DisplayName = opensearchClusterPipelineDisplayName,
        MemoryGb = opensearchClusterPipelineMemoryGb,
        NodeCount = opensearchClusterPipelineNodeCount,
        OcpuCount = opensearchClusterPipelineOcpuCount,
        PipelineConfigurationBody = opensearchClusterPipelinePipelineConfigurationBody,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        NsgId = testNsg.Id,
        OpcDryRun = opensearchClusterPipelineOpcDryRun,
        ReverseConnectionEndpoints = new[]
        {
            new Oci.Opensearch.Inputs.OpensearchClusterPipelineReverseConnectionEndpointArgs
            {
                CustomerFqdn = opensearchClusterPipelineReverseConnectionEndpointsCustomerFqdn,
                CustomerIp = opensearchClusterPipelineReverseConnectionEndpointsCustomerIp,
            },
        },
        SubnetCompartmentId = testCompartment.Id,
        SubnetId = testSubnet.Id,
        VcnCompartmentId = testCompartment.Id,
        VcnId = testVcn.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Opensearch.OpensearchClusterPipeline;
import com.pulumi.oci.Opensearch.OpensearchClusterPipelineArgs;
import com.pulumi.oci.Opensearch.inputs.OpensearchClusterPipelineReverseConnectionEndpointArgs;
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) {
        var testOpensearchClusterPipeline = new OpensearchClusterPipeline("testOpensearchClusterPipeline", OpensearchClusterPipelineArgs.builder()
            .compartmentId(compartmentId)
            .dataPrepperConfigurationBody(opensearchClusterPipelineDataPrepperConfigurationBody)
            .displayName(opensearchClusterPipelineDisplayName)
            .memoryGb(opensearchClusterPipelineMemoryGb)
            .nodeCount(opensearchClusterPipelineNodeCount)
            .ocpuCount(opensearchClusterPipelineOcpuCount)
            .pipelineConfigurationBody(opensearchClusterPipelinePipelineConfigurationBody)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .nsgId(testNsg.id())
            .opcDryRun(opensearchClusterPipelineOpcDryRun)
            .reverseConnectionEndpoints(OpensearchClusterPipelineReverseConnectionEndpointArgs.builder()
                .customerFqdn(opensearchClusterPipelineReverseConnectionEndpointsCustomerFqdn)
                .customerIp(opensearchClusterPipelineReverseConnectionEndpointsCustomerIp)
                .build())
            .subnetCompartmentId(testCompartment.id())
            .subnetId(testSubnet.id())
            .vcnCompartmentId(testCompartment.id())
            .vcnId(testVcn.id())
            .build());

    }
}
Copy
resources:
  testOpensearchClusterPipeline:
    type: oci:Opensearch:OpensearchClusterPipeline
    name: test_opensearch_cluster_pipeline
    properties:
      compartmentId: ${compartmentId}
      dataPrepperConfigurationBody: ${opensearchClusterPipelineDataPrepperConfigurationBody}
      displayName: ${opensearchClusterPipelineDisplayName}
      memoryGb: ${opensearchClusterPipelineMemoryGb}
      nodeCount: ${opensearchClusterPipelineNodeCount}
      ocpuCount: ${opensearchClusterPipelineOcpuCount}
      pipelineConfigurationBody: ${opensearchClusterPipelinePipelineConfigurationBody}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      nsgId: ${testNsg.id}
      opcDryRun: ${opensearchClusterPipelineOpcDryRun}
      reverseConnectionEndpoints:
        - customerFqdn: ${opensearchClusterPipelineReverseConnectionEndpointsCustomerFqdn}
          customerIp: ${opensearchClusterPipelineReverseConnectionEndpointsCustomerIp}
      subnetCompartmentId: ${testCompartment.id}
      subnetId: ${testSubnet.id}
      vcnCompartmentId: ${testCompartment.id}
      vcnId: ${testVcn.id}
Copy

Create OpensearchClusterPipeline Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new OpensearchClusterPipeline(name: string, args: OpensearchClusterPipelineArgs, opts?: CustomResourceOptions);
@overload
def OpensearchClusterPipeline(resource_name: str,
                              args: OpensearchClusterPipelineArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def OpensearchClusterPipeline(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              ocpu_count: Optional[int] = None,
                              data_prepper_configuration_body: Optional[str] = None,
                              pipeline_configuration_body: Optional[str] = None,
                              display_name: Optional[str] = None,
                              compartment_id: Optional[str] = None,
                              memory_gb: Optional[int] = None,
                              node_count: Optional[int] = None,
                              freeform_tags: Optional[Mapping[str, str]] = None,
                              nsg_id: Optional[str] = None,
                              opc_dry_run: Optional[bool] = None,
                              defined_tags: Optional[Mapping[str, str]] = None,
                              reverse_connection_endpoints: Optional[Sequence[_opensearch.OpensearchClusterPipelineReverseConnectionEndpointArgs]] = None,
                              subnet_compartment_id: Optional[str] = None,
                              subnet_id: Optional[str] = None,
                              vcn_compartment_id: Optional[str] = None,
                              vcn_id: Optional[str] = None)
func NewOpensearchClusterPipeline(ctx *Context, name string, args OpensearchClusterPipelineArgs, opts ...ResourceOption) (*OpensearchClusterPipeline, error)
public OpensearchClusterPipeline(string name, OpensearchClusterPipelineArgs args, CustomResourceOptions? opts = null)
public OpensearchClusterPipeline(String name, OpensearchClusterPipelineArgs args)
public OpensearchClusterPipeline(String name, OpensearchClusterPipelineArgs args, CustomResourceOptions options)

type: oci:Opensearch:OpensearchClusterPipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OpensearchClusterPipelineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OpensearchClusterPipelineArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OpensearchClusterPipelineArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OpensearchClusterPipelineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OpensearchClusterPipelineArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var opensearchClusterPipelineResource = new Oci.Opensearch.OpensearchClusterPipeline("opensearchClusterPipelineResource", new()
{
    OcpuCount = 0,
    DataPrepperConfigurationBody = "string",
    PipelineConfigurationBody = "string",
    DisplayName = "string",
    CompartmentId = "string",
    MemoryGb = 0,
    NodeCount = 0,
    FreeformTags = 
    {
        { "string", "string" },
    },
    NsgId = "string",
    OpcDryRun = false,
    DefinedTags = 
    {
        { "string", "string" },
    },
    ReverseConnectionEndpoints = new[]
    {
        new Oci.Opensearch.Inputs.OpensearchClusterPipelineReverseConnectionEndpointArgs
        {
            CustomerFqdn = "string",
            CustomerIp = "string",
        },
    },
    SubnetCompartmentId = "string",
    SubnetId = "string",
    VcnCompartmentId = "string",
    VcnId = "string",
});
Copy
example, err := Opensearch.NewOpensearchClusterPipeline(ctx, "opensearchClusterPipelineResource", &Opensearch.OpensearchClusterPipelineArgs{
	OcpuCount:                    pulumi.Int(0),
	DataPrepperConfigurationBody: pulumi.String("string"),
	PipelineConfigurationBody:    pulumi.String("string"),
	DisplayName:                  pulumi.String("string"),
	CompartmentId:                pulumi.String("string"),
	MemoryGb:                     pulumi.Int(0),
	NodeCount:                    pulumi.Int(0),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NsgId:     pulumi.String("string"),
	OpcDryRun: pulumi.Bool(false),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ReverseConnectionEndpoints: opensearch.OpensearchClusterPipelineReverseConnectionEndpointArray{
		&opensearch.OpensearchClusterPipelineReverseConnectionEndpointArgs{
			CustomerFqdn: pulumi.String("string"),
			CustomerIp:   pulumi.String("string"),
		},
	},
	SubnetCompartmentId: pulumi.String("string"),
	SubnetId:            pulumi.String("string"),
	VcnCompartmentId:    pulumi.String("string"),
	VcnId:               pulumi.String("string"),
})
Copy
var opensearchClusterPipelineResource = new OpensearchClusterPipeline("opensearchClusterPipelineResource", OpensearchClusterPipelineArgs.builder()
    .ocpuCount(0)
    .dataPrepperConfigurationBody("string")
    .pipelineConfigurationBody("string")
    .displayName("string")
    .compartmentId("string")
    .memoryGb(0)
    .nodeCount(0)
    .freeformTags(Map.of("string", "string"))
    .nsgId("string")
    .opcDryRun(false)
    .definedTags(Map.of("string", "string"))
    .reverseConnectionEndpoints(OpensearchClusterPipelineReverseConnectionEndpointArgs.builder()
        .customerFqdn("string")
        .customerIp("string")
        .build())
    .subnetCompartmentId("string")
    .subnetId("string")
    .vcnCompartmentId("string")
    .vcnId("string")
    .build());
Copy
opensearch_cluster_pipeline_resource = oci.opensearch.OpensearchClusterPipeline("opensearchClusterPipelineResource",
    ocpu_count=0,
    data_prepper_configuration_body="string",
    pipeline_configuration_body="string",
    display_name="string",
    compartment_id="string",
    memory_gb=0,
    node_count=0,
    freeform_tags={
        "string": "string",
    },
    nsg_id="string",
    opc_dry_run=False,
    defined_tags={
        "string": "string",
    },
    reverse_connection_endpoints=[{
        "customer_fqdn": "string",
        "customer_ip": "string",
    }],
    subnet_compartment_id="string",
    subnet_id="string",
    vcn_compartment_id="string",
    vcn_id="string")
Copy
const opensearchClusterPipelineResource = new oci.opensearch.OpensearchClusterPipeline("opensearchClusterPipelineResource", {
    ocpuCount: 0,
    dataPrepperConfigurationBody: "string",
    pipelineConfigurationBody: "string",
    displayName: "string",
    compartmentId: "string",
    memoryGb: 0,
    nodeCount: 0,
    freeformTags: {
        string: "string",
    },
    nsgId: "string",
    opcDryRun: false,
    definedTags: {
        string: "string",
    },
    reverseConnectionEndpoints: [{
        customerFqdn: "string",
        customerIp: "string",
    }],
    subnetCompartmentId: "string",
    subnetId: "string",
    vcnCompartmentId: "string",
    vcnId: "string",
});
Copy
type: oci:Opensearch:OpensearchClusterPipeline
properties:
    compartmentId: string
    dataPrepperConfigurationBody: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    memoryGb: 0
    nodeCount: 0
    nsgId: string
    ocpuCount: 0
    opcDryRun: false
    pipelineConfigurationBody: string
    reverseConnectionEndpoints:
        - customerFqdn: string
          customerIp: string
    subnetCompartmentId: string
    subnetId: string
    vcnCompartmentId: string
    vcnId: string
Copy

OpensearchClusterPipeline Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The OpensearchClusterPipeline resource accepts the following input properties:

CompartmentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the compartment to create the pipeline in.
DataPrepperConfigurationBody This property is required. string
(Updatable) 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 .
DisplayName This property is required. string
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
MemoryGb This property is required. int
(Updatable) The amount of memory in GB, for each pipeline node.
NodeCount This property is required. int
(Updatable) The number of nodes configured for the pipeline.
OcpuCount This property is required. int
(Updatable) The number of OCPUs configured for each pipeline node.
PipelineConfigurationBody This property is required. string
(Updatable) 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 .
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
NsgId string
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
OpcDryRun bool
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
ReverseConnectionEndpoints List<OpensearchClusterPipelineReverseConnectionEndpoint>
(Updatable) The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
SubnetCompartmentId string
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
SubnetId string
(Updatable) The OCID of the pipeline's subnet.
VcnCompartmentId string
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
VcnId string

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CompartmentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the compartment to create the pipeline in.
DataPrepperConfigurationBody This property is required. string
(Updatable) 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 .
DisplayName This property is required. string
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
MemoryGb This property is required. int
(Updatable) The amount of memory in GB, for each pipeline node.
NodeCount This property is required. int
(Updatable) The number of nodes configured for the pipeline.
OcpuCount This property is required. int
(Updatable) The number of OCPUs configured for each pipeline node.
PipelineConfigurationBody This property is required. string
(Updatable) 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 .
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
NsgId string
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
OpcDryRun bool
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
ReverseConnectionEndpoints []OpensearchClusterPipelineReverseConnectionEndpointArgs
(Updatable) The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
SubnetCompartmentId string
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
SubnetId string
(Updatable) The OCID of the pipeline's subnet.
VcnCompartmentId string
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
VcnId string

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the compartment to create the pipeline in.
dataPrepperConfigurationBody This property is required. String
(Updatable) 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 .
displayName This property is required. String
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
memoryGb This property is required. Integer
(Updatable) The amount of memory in GB, for each pipeline node.
nodeCount This property is required. Integer
(Updatable) The number of nodes configured for the pipeline.
ocpuCount This property is required. Integer
(Updatable) The number of OCPUs configured for each pipeline node.
pipelineConfigurationBody This property is required. String
(Updatable) 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 .
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
nsgId String
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
opcDryRun Boolean
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
reverseConnectionEndpoints List<ClusterPipelineReverseConnectionEndpoint>
(Updatable) The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
subnetCompartmentId String
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
subnetId String
(Updatable) The OCID of the pipeline's subnet.
vcnCompartmentId String
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
vcnId String

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the compartment to create the pipeline in.
dataPrepperConfigurationBody This property is required. string
(Updatable) 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 .
displayName This property is required. string
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
memoryGb This property is required. number
(Updatable) The amount of memory in GB, for each pipeline node.
nodeCount This property is required. number
(Updatable) The number of nodes configured for the pipeline.
ocpuCount This property is required. number
(Updatable) The number of OCPUs configured for each pipeline node.
pipelineConfigurationBody This property is required. string
(Updatable) 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 .
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
nsgId string
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
opcDryRun boolean
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
reverseConnectionEndpoints OpensearchClusterPipelineReverseConnectionEndpoint[]
(Updatable) The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
subnetCompartmentId string
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
subnetId string
(Updatable) The OCID of the pipeline's subnet.
vcnCompartmentId string
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
vcnId string

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartment_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the compartment to create the pipeline in.
data_prepper_configuration_body This property is required. str
(Updatable) 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 .
display_name This property is required. str
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
memory_gb This property is required. int
(Updatable) The amount of memory in GB, for each pipeline node.
node_count This property is required. int
(Updatable) The number of nodes configured for the pipeline.
ocpu_count This property is required. int
(Updatable) The number of OCPUs configured for each pipeline node.
pipeline_configuration_body This property is required. str
(Updatable) 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 .
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
nsg_id str
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
opc_dry_run bool
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
reverse_connection_endpoints Sequence[opensearch.OpensearchClusterPipelineReverseConnectionEndpointArgs]
(Updatable) The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
subnet_compartment_id str
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
subnet_id str
(Updatable) The OCID of the pipeline's subnet.
vcn_compartment_id str
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
vcn_id str

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the compartment to create the pipeline in.
dataPrepperConfigurationBody This property is required. String
(Updatable) 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 .
displayName This property is required. String
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
memoryGb This property is required. Number
(Updatable) The amount of memory in GB, for each pipeline node.
nodeCount This property is required. Number
(Updatable) The number of nodes configured for the pipeline.
ocpuCount This property is required. Number
(Updatable) The number of OCPUs configured for each pipeline node.
pipelineConfigurationBody This property is required. String
(Updatable) 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 .
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
nsgId String
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
opcDryRun Boolean
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
reverseConnectionEndpoints List<Property Map>
(Updatable) The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
subnetCompartmentId String
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
subnetId String
(Updatable) The OCID of the pipeline's subnet.
vcnCompartmentId String
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
vcnId String

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

All input properties are implicitly available as output properties. Additionally, the OpensearchClusterPipeline resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
OpensearchPipelineFqdn string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
OpensearchPipelinePrivateIp string
The pipeline's private IP address.
PipelineMode string
The current state of the pipeline.
State string
The current state of the cluster backup.
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.
Id string
The provider-assigned unique ID for this managed resource.
OpensearchPipelineFqdn string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
OpensearchPipelinePrivateIp string
The pipeline's private IP address.
PipelineMode string
The current state of the pipeline.
State string
The current state of the cluster backup.
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.
id String
The provider-assigned unique ID for this managed resource.
opensearchPipelineFqdn String
The fully qualified domain name (FQDN) for the cluster's API endpoint.
opensearchPipelinePrivateIp String
The pipeline's private IP address.
pipelineMode String
The current state of the pipeline.
state String
The current state of the cluster backup.
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.
id string
The provider-assigned unique ID for this managed resource.
opensearchPipelineFqdn string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
opensearchPipelinePrivateIp string
The pipeline's private IP address.
pipelineMode string
The current state of the pipeline.
state string
The current state of the cluster backup.
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.
id str
The provider-assigned unique ID for this managed resource.
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_mode str
The current state of the pipeline.
state str
The current state of the cluster backup.
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.
id String
The provider-assigned unique ID for this managed resource.
opensearchPipelineFqdn String
The fully qualified domain name (FQDN) for the cluster's API endpoint.
opensearchPipelinePrivateIp String
The pipeline's private IP address.
pipelineMode String
The current state of the pipeline.
state String
The current state of the cluster backup.
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.

Look up Existing OpensearchClusterPipeline Resource

Get an existing OpensearchClusterPipeline resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OpensearchClusterPipelineState, opts?: CustomResourceOptions): OpensearchClusterPipeline
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        data_prepper_configuration_body: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        memory_gb: Optional[int] = None,
        node_count: Optional[int] = None,
        nsg_id: Optional[str] = None,
        ocpu_count: Optional[int] = None,
        opc_dry_run: Optional[bool] = None,
        opensearch_pipeline_fqdn: Optional[str] = None,
        opensearch_pipeline_private_ip: Optional[str] = None,
        pipeline_configuration_body: Optional[str] = None,
        pipeline_mode: Optional[str] = None,
        reverse_connection_endpoints: Optional[Sequence[_opensearch.OpensearchClusterPipelineReverseConnectionEndpointArgs]] = None,
        state: Optional[str] = None,
        subnet_compartment_id: Optional[str] = None,
        subnet_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        vcn_compartment_id: Optional[str] = None,
        vcn_id: Optional[str] = None) -> OpensearchClusterPipeline
func GetOpensearchClusterPipeline(ctx *Context, name string, id IDInput, state *OpensearchClusterPipelineState, opts ...ResourceOption) (*OpensearchClusterPipeline, error)
public static OpensearchClusterPipeline Get(string name, Input<string> id, OpensearchClusterPipelineState? state, CustomResourceOptions? opts = null)
public static OpensearchClusterPipeline get(String name, Output<String> id, OpensearchClusterPipelineState state, CustomResourceOptions options)
resources:  _:    type: oci:Opensearch:OpensearchClusterPipeline    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId Changes to this property will trigger replacement. string
The OCID of the compartment to create the pipeline in.
DataPrepperConfigurationBody string
(Updatable) 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>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
MemoryGb int
(Updatable) The amount of memory in GB, for each pipeline node.
NodeCount int
(Updatable) The number of nodes configured for the pipeline.
NsgId string
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
OcpuCount int
(Updatable) The number of OCPUs configured for each pipeline node.
OpcDryRun bool
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
OpensearchPipelineFqdn string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
OpensearchPipelinePrivateIp string
The pipeline's private IP address.
PipelineConfigurationBody string
(Updatable) 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<OpensearchClusterPipelineReverseConnectionEndpoint>
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
SubnetId string
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
VcnId string

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CompartmentId Changes to this property will trigger replacement. string
The OCID of the compartment to create the pipeline in.
DataPrepperConfigurationBody string
(Updatable) 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
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
MemoryGb int
(Updatable) The amount of memory in GB, for each pipeline node.
NodeCount int
(Updatable) The number of nodes configured for the pipeline.
NsgId string
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
OcpuCount int
(Updatable) The number of OCPUs configured for each pipeline node.
OpcDryRun bool
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
OpensearchPipelineFqdn string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
OpensearchPipelinePrivateIp string
The pipeline's private IP address.
PipelineConfigurationBody string
(Updatable) 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 []OpensearchClusterPipelineReverseConnectionEndpointArgs
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
SubnetId string
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
VcnId string

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId Changes to this property will trigger replacement. String
The OCID of the compartment to create the pipeline in.
dataPrepperConfigurationBody String
(Updatable) 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>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
memoryGb Integer
(Updatable) The amount of memory in GB, for each pipeline node.
nodeCount Integer
(Updatable) The number of nodes configured for the pipeline.
nsgId String
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
ocpuCount Integer
(Updatable) The number of OCPUs configured for each pipeline node.
opcDryRun Boolean
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
opensearchPipelineFqdn String
The fully qualified domain name (FQDN) for the cluster's API endpoint.
opensearchPipelinePrivateIp String
The pipeline's private IP address.
pipelineConfigurationBody String
(Updatable) 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<ClusterPipelineReverseConnectionEndpoint>
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
subnetId String
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
vcnId String

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId Changes to this property will trigger replacement. string
The OCID of the compartment to create the pipeline in.
dataPrepperConfigurationBody string
(Updatable) 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}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
memoryGb number
(Updatable) The amount of memory in GB, for each pipeline node.
nodeCount number
(Updatable) The number of nodes configured for the pipeline.
nsgId string
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
ocpuCount number
(Updatable) The number of OCPUs configured for each pipeline node.
opcDryRun boolean
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
opensearchPipelineFqdn string
The fully qualified domain name (FQDN) for the cluster's API endpoint.
opensearchPipelinePrivateIp string
The pipeline's private IP address.
pipelineConfigurationBody string
(Updatable) 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 OpensearchClusterPipelineReverseConnectionEndpoint[]
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
subnetId string
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
vcnId string

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartment_id Changes to this property will trigger replacement. str
The OCID of the compartment to create the pipeline in.
data_prepper_configuration_body str
(Updatable) 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]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
memory_gb int
(Updatable) The amount of memory in GB, for each pipeline node.
node_count int
(Updatable) The number of nodes configured for the pipeline.
nsg_id str
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
ocpu_count int
(Updatable) The number of OCPUs configured for each pipeline node.
opc_dry_run bool
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
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
(Updatable) 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.OpensearchClusterPipelineReverseConnectionEndpointArgs]
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
subnet_id str
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
vcn_id str

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId Changes to this property will trigger replacement. String
The OCID of the compartment to create the pipeline in.
dataPrepperConfigurationBody String
(Updatable) 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>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
(Updatable) The name of the cluster pipeline. Avoid entering confidential information.
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
memoryGb Number
(Updatable) The amount of memory in GB, for each pipeline node.
nodeCount Number
(Updatable) The number of nodes configured for the pipeline.
nsgId String
(Updatable) The OCID of the NSG where the pipeline private endpoint vnic will be attached.
ocpuCount Number
(Updatable) The number of OCPUs configured for each pipeline node.
opcDryRun Boolean
(Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
opensearchPipelineFqdn String
The fully qualified domain name (FQDN) for the cluster's API endpoint.
opensearchPipelinePrivateIp String
The pipeline's private IP address.
pipelineConfigurationBody String
(Updatable) 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>
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's subnet is located.
subnetId String
(Updatable) 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
(Updatable) The OCID for the compartment where the pipeline's VCN is located.
vcnId String

(Updatable) The OCID of the pipeline's VCN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Supporting Types

OpensearchClusterPipelineReverseConnectionEndpoint
, OpensearchClusterPipelineReverseConnectionEndpointArgs

CustomerFqdn This property is required. string
(Updatable) The fully qualified domain name of the customerIp in the customer VCN
CustomerIp This property is required. string
(Updatable) The IPv4 address in the customer VCN
CustomerFqdn This property is required. string
(Updatable) The fully qualified domain name of the customerIp in the customer VCN
CustomerIp This property is required. string
(Updatable) The IPv4 address in the customer VCN
customerFqdn This property is required. String
(Updatable) The fully qualified domain name of the customerIp in the customer VCN
customerIp This property is required. String
(Updatable) The IPv4 address in the customer VCN
customerFqdn This property is required. string
(Updatable) The fully qualified domain name of the customerIp in the customer VCN
customerIp This property is required. string
(Updatable) The IPv4 address in the customer VCN
customer_fqdn This property is required. str
(Updatable) The fully qualified domain name of the customerIp in the customer VCN
customer_ip This property is required. str
(Updatable) The IPv4 address in the customer VCN
customerFqdn This property is required. String
(Updatable) The fully qualified domain name of the customerIp in the customer VCN
customerIp This property is required. String
(Updatable) The IPv4 address in the customer VCN

Import

OpensearchClusterPipelines can be imported using the id, e.g.

$ pulumi import oci:Opensearch/opensearchClusterPipeline:OpensearchClusterPipeline test_opensearch_cluster_pipeline "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

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.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci