Oracle Opensearch Cluster Pipeline API

openapi: 3.2.0
info:
  description: The OpenSearch service API provides access to OCI Search Service with OpenSearch.
  title: OpenSearch Service Opensearch Cluster Pipeline API
  version: '20180828'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/db7aead90481c47e0d0e3f85d7516754adc899cb5606ea20d87eb9c20d2c0d0e.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OpenSearch Service API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/db7aead90481c47e0d0e3f85d7516754adc899cb5606ea20d87eb9c20d2c0d0e.yaml
    what: the harvested document for OpenSearch Service API
servers:
- url: http://127.0.0.1/20180828
- url: https://127.0.0.1/20180828
tags:
- name: opensearchClusterPipeline
paths:
  /opensearchClusterPipelines:
    get:
      description: 'Returns a list of OpensearchClusterPipelines.

        '
      operationId: ListOpensearchClusterPipelines
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/OpensearchClusterPipelineLifecycleStateQueryParam'
      - $ref: '#/components/parameters/OpensearchClusterPipelineComponentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/OpensearchClusterPipelineIdentifierQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of OpensearchClusterPipelineSummary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpensearchClusterPipelineCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all OpensearchClusterPipelines in a compartment
      tags:
      - opensearchClusterPipeline
      x-related-resource: '#/definitions/OpensearchClusterPipelineCollection'
    post:
      description: 'Creates a new OpensearchCluster Pipeline.

        '
      operationId: CreateOpensearchClusterPipeline
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DryRunHeader'
      responses:
        202:
          description: Accepted the request. The OpensearchCluster Pipeline will be created.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        204:
          description: The dry run of the Create Pipeline request is completed.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new OpensearchCluster Pipeline
      tags:
      - opensearchClusterPipeline
      x-related-resource: '#/definitions/OpensearchClusterPipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOpensearchClusterPipelineDetails'
        description: Details for the new OpensearchCluster Pipeline.
        required: true
  /opensearchClusterPipelines/{opensearchClusterPipelineId}:
    delete:
      description: Deletes a OpensearchCluster Pipeline resource by identifier
      operationId: DeleteOpensearchClusterPipeline
      parameters:
      - $ref: '#/components/parameters/OpensearchClusterPipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The OpensearchCluster Pipeline will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a provisioned OpensearchCluster Pipeline
      tags:
      - opensearchClusterPipeline
      x-related-resource: '#/definitions/OpensearchClusterPipeline'
    get:
      description: Gets a OpensearchCluster Pipeline by identifier
      operationId: GetOpensearchClusterPipeline
      parameters:
      - $ref: '#/components/parameters/OpensearchClusterPipelineIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the OpensearchCluster Pipeline details with the given id
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpensearchClusterPipeline'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get OpensearchCluster Pipeline
      tags:
      - opensearchClusterPipeline
    put:
      description: Updates the OpensearchCluster Pipeline
      operationId: UpdateOpensearchClusterPipeline
      parameters:
      - $ref: '#/components/parameters/OpensearchClusterPipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DryRunHeader'
      responses:
        202:
          description: Accepted the request. The OpensearchCluster Pipeline will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        204:
          description: The dry run of the Update Pipeline request is completed.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the OpensearchCluster Pipeline identified by the id
      tags:
      - opensearchClusterPipeline
      x-related-resource: '#/definitions/OpensearchClusterPipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOpensearchClusterPipelineDetails'
        description: Update the opensearch cluster pipeline details.
        required: true
  /opensearchClusterPipelines/{opensearchClusterPipelineId}/actions/startPipeline:
    post:
      description: 'Start the pipeline.

        '
      operationId: StartPipeline
      parameters:
      - $ref: '#/components/parameters/OpensearchClusterPipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The OpensearchCluster Pipeline will be started.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Start the pipeline.
      tags:
      - opensearchClusterPipeline
      x-obmcs-terraform:
        actionType: START
      x-related-resource: '#/definitions/OpensearchClusterPipeline'
  /opensearchClusterPipelines/{opensearchClusterPipelineId}/actions/stopPipeline:
    post:
      description: 'Stop the pipeline.

        '
      operationId: StopPipeline
      parameters:
      - $ref: '#/components/parameters/OpensearchClusterPipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The OpensearchCluster Pipeline will be stopped.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Stop the pipeline.
      tags:
      - opensearchClusterPipeline
      x-obmcs-terraform:
        actionType: STOP
      x-related-resource: '#/definitions/OpensearchClusterPipeline'
components:
  schemas:
    OpensearchPipelineReverseConnectionEndpoint:
      description: 'The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.

        '
      properties:
        customerFqdn:
          description: The fully qualified domain name of the customerIp in the customer VCN
          maxLength: 255
          minLength: 1
          type: string
        customerIp:
          description: The IPv4 address in the customer VCN
          maxLength: 255
          minLength: 1
          type: string
      required:
      - customerFqdn
      - customerIp
    OpensearchClusterPipelineCollection:
      description: The list of cluster pipelines returned in a cluster pipeline search.
      properties:
        items:
          description: The list of cluster pipeline.
          items:
            $ref: '#/components/schemas/OpensearchClusterPipelineSummary'
          type: array
      required:
      - items
      type: object
    OpensearchClusterPipelineSummary:
      description: The summary of information about an OpenSearch cluster Pipeline.
      properties:
        compartmentId:
          description: The OCID of the compartment where the cluster pipeline is located.
          maxLength: 255
          minLength: 1
          type: string
        dataPrepperConfigurationBody:
          description: '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 \.

            '
          maxLength: 24000
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        displayName:
          description: The name of the cluster pipeline. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: The OCID of the cluster pipeline.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the cluster pipeline.
          type: string
          x-obmcs-enumref: '#/definitions/OpensearchClusterPipeline/lifecycleState'
        memoryGB:
          description: The amount of memory in GB, for each pipeline node.
          maximum: 99999
          minimum: 1
          type: integer
        nodeCount:
          description: The number of nodes configured for the pipeline.
          maximum: 999
          minimum: 1
          type: integer
        nodeShape:
          description: The pipeline node shape.
          maxLength: 255
          minLength: 1
          type: string
        ocpuCount:
          description: The number of OCPUs configured for each pipeline node.
          maximum: 9999
          minimum: 1
          type: integer
        pipelineConfigurationBody:
          description: '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 \.

            '
          maxLength: 24000
          minLength: 1
          type: string
        pipelineMode:
          description: The current state of the pipeline.
          type: string
          x-obmcs-enumref: '#/definitions/OpensearchClusterPipeline/pipelineMode'
        subnetId:
          description: The OCID of the pipeline's subnet.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The date and time the cluster pipeline was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
        timeUpdated:
          description: The date and time the cluster pipeline was updated. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
        vcnId:
          description: The OCID of the pipeline's VCN.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - displayName
      - compartmentId
      - ocpuCount
      - memoryGB
      - nodeCount
      - pipelineConfigurationBody
      - dataPrepperConfigurationBody
      - lifecycleState
      - pipelineMode
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    OpensearchClusterPipeline:
      description: 'An OpenSearch cluster Pipeline resource. An cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch.

        For more information, see [Cluster Pipelines](/iaas/Content/search-opensearch/Concepts/ociopensearchpipeline.htm).

        '
      properties:
        compartmentId:
          description: The OCID of the compartment where the pipeline is located.
          maxLength: 255
          minLength: 1
          type: string
        dataPrepperConfigurationBody:
          description: '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 \.

            '
          maxLength: 24000
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        displayName:
          description: The name of the pipeline. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: The OCID of the cluster pipeline.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the cluster backup.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        memoryGB:
          description: The amount of memory in GB, for each pipeline node.
          maximum: 99999
          minimum: 1
          type: integer
        nodeCount:
          description: The number of nodes configured for the pipeline.
          maximum: 999
          minimum: 1
          type: integer
        nodeShape:
          description: The pipeline node shape.
          maxLength: 255
          minLength: 1
          type: string
        nsgId:
          description: The OCID of the NSG where the pipeline private endpoint vnic will be attached.
          maxLength: 255
          minLength: 1
          type: string
        ocpuCount:
          description: The number of OCPUs configured for each pipeline node.
          maximum: 9999
          minimum: 1
          type: integer
        opensearchPipelineFqdn:
          description: The fully qualified domain name (FQDN) for the cluster's API endpoint.
          maxLength: 255
          minLength: 1
          type: string
        opensearchPipelinePrivateIp:
          description: The pipeline's private IP address.
          maxLength: 255
          minLength: 1
          type: string
        pipelineConfigurationBody:
          description: '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 \.

            '
          maxLength: 24000
          minLength: 1
          type: string
        pipelineMode:
          description: The current state of the pipeline.
          enum:
          - RUNNING
          - STOPPED
          type: string
        reverseConnectionEndpoints:
          description: The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
          items:
            $ref: '#/components/schemas/OpensearchPipelineReverseConnectionEndpoint'
          type: array
        subnetCompartmentId:
          description: The OCID for the compartment where the pipeline's subnet is located.
          maxLength: 255
          minLength: 1
          type: string
        subnetId:
          description: The OCID of the pipeline's subnet.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The date and time the cluster pipeline was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
        timeUpdated:
          description: The amount of time in milliseconds since the pipeline was updated.
          format: date-time
          type: string
        vcnCompartmentId:
          description: The OCID for the compartment where the pipeline's VCN is located.
          maxLength: 255
          minLength: 1
          type: string
        vcnId:
          description: The OCID of the pipeline's VCN.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - displayName
      - compartmentId
      - vcnId
      - subnetId
      - vcnCompartmentId
      - subnetCompartmentId
      - ocpuCount
      - memoryGB
      - nodeCount
      - pipelineConfigurationBody
      - dataPrepperConfigurationBody
      - opensearchPipelineFqdn
      - opensearchPipelinePrivateIp
      - lifecycleState
      - pipelineMode
      type: object
    CreateOpensearchClusterPipelineDetails:
      description: The configuration details for a new OpenSearch cluster pipeline.
      properties:
        compartmentId:
          description: The OCID of the compartment to create the pipeline in.
          maxLength: 255
          minLength: 1
          type: string
        dataPrepperConfigurationBody:
          description: '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 \.

            '
          maxLength: 24000
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        displayName:
          description: The name of the cluster pipeline. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        memoryGB:
          description: The amount of memory in GB, for each pipeline node.
          maximum: 99999
          minimum: 1
          type: integer
        nodeCount:
          description: The number of nodes configured for the pipeline.
          maximum: 999
          minimum: 1
          type: integer
        nodeShape:
          description: The pipeline node shape.
          maxLength: 255
          minLength: 1
          type: string
        nsgId:
          description: The OCID of the NSG where the pipeline private endpoint vnic will be attached.
          maxLength: 255
          minLength: 1
          type: string
        ocpuCount:
          description: The number of OCPUs configured for each pipeline node.
          maximum: 9999
          minimum: 1
          type: integer
        pipelineConfigurationBody:
          description: '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 \.

            '
          maxLength: 24000
          minLength: 1
          type: string
        reverseConnectionEndpoints:
          description: The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
          items:
            $ref: '#/components/schemas/OpensearchPipelineReverseConnectionEndpoint'
          type: array
        subnetCompartmentId:
          description: The OCID for the compartment where the pipeline's subnet is located.
          maxLength: 255
          minLength: 1
          type: string
        subnetId:
          description: The OCID of the pipeline's subnet.
          maxLength: 255
          minLength: 1
          type: string
        vcnCompartmentId:
          description: The OCID for the compartment where the pipeline's VCN is located.
          maxLength: 255
          minLength: 1
          type: string
        vcnId:
          description: The OCID of the pipeline's VCN.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - displayName
      - ocpuCount
      - memoryGB
      - nodeCount
      - pipelineConfigurationBody
      - dataPrepperConfigurationBody
      - compartmentId
      type: object
    UpdateOpensearchClusterPipelineDetails:
      description: 'The configuration to update on an existing OpenSearch cluster pipeline. You can only edit capacity limits and pipeline configurations. You can''t edit its network settings.

        '
      properties:
        dataPrepperConfigurationBody:
          description: '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 \.

            '
          maxLength: 24000
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is pred

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-opensearchclusterpipeline-api-openapi.yml