---
id: "oci-private-endpoint"
type: "component"
kind: "private-link"
provider: "oci"
category: "edge"
docs: "https://docs.oracle.com/en-us/iaas/Content/Network/Concepts/privateaccess.htm"
url: "https://localhost:3000/catalogue/components/oci-private-endpoint"
---

# Private Endpoint

Private IP and FQDN in your subnet fronting a single OCI service resource.

| | |
|---|---|
| Provider | [oci](https://localhost:3000/catalogue?provider=oci) |
| Kind | [Private endpoint](https://localhost:3000/catalogue/kinds/private-link) |
| Category | Edge |
| Official docs | [https://docs.oracle.com/en-us/iaas/Content/Network/Concepts/privateaccess.htm](https://docs.oracle.com/en-us/iaas/Content/Network/Concepts/privateaccess.htm) |

## Properties

| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| `approvalRequired` | boolean | — | no | — | **false** |
| `crossRegion` | boolean | — | no | false | **false** |
| `endpointCount` | integer | — | no | — | inherited |
| `endpointType` | enum | `private-endpoint`, `psa-endpoint` | no | "private-endpoint" | inherited |
| `managed` | boolean | — | no | false | **true** |
| `privateDnsIntegration` | boolean | — | no | — | **false** |
| `publicAccessDisabled` | boolean | — | no | — | **false** |
| `securityRulesApply` | boolean | — | no | true | inherited |

Bold values are the ones this component pins.

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 13

- [PrivateLink](https://localhost:3000/catalogue/components/alibaba-privatelink.md) `alibaba-privatelink` — alibabacloud
- [PrivateLink endpoint service](https://localhost:3000/catalogue/components/aws-privatelink-service.md) `aws-privatelink-service` — aws
- [AWS RTB Fabric gateway](https://localhost:3000/catalogue/components/aws-rtb-fabric.md) `aws-rtb-fabric` — aws
- [AWS PrivateLink VPC endpoint](https://localhost:3000/catalogue/components/aws-vpc-endpoint.md) `aws-vpc-endpoint` — aws
- [Azure Private Link](https://localhost:3000/catalogue/components/azure-private-link.md) `azure-private-link` — azure
- [Cloudflare Tunnel](https://localhost:3000/catalogue/components/cloudflare-tunnel.md) `cloudflare-tunnel` — cloudflare
- [Workers VPC](https://localhost:3000/catalogue/components/cloudflare-workers-vpc.md) `cloudflare-workers-vpc` — cloudflare
- [Generic private endpoint](https://localhost:3000/catalogue/components/private-link.md) `private-link` — default
- [Private Service Connect](https://localhost:3000/catalogue/components/google-private-service-connect.md) `google-private-service-connect` — gcp
- [Serverless VPC Access connector](https://localhost:3000/catalogue/components/google-serverless-vpc-access-connector.md) `google-serverless-vpc-access-connector` — gcp
- [Virtual Private Endpoint Gateway](https://localhost:3000/catalogue/components/ibm-virtual-endpoint-gateway.md) `ibm-virtual-endpoint-gateway` — ibm
- [Service Gateway](https://localhost:3000/catalogue/components/oci-service-gateway.md) `oci-service-gateway` — oci
- [OUTSCALE Net access point](https://localhost:3000/catalogue/components/outscale-net-access-point.md) `outscale-net-access-point` — outscale

## Use it in a design

```yaml
nodes:
  - { id: "oci-private-endpoint", component: "oci-private-endpoint" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# Oracle Cloud private endpoint / Private Service Access endpoint: a VNIC with a private IP and an
# FQDN in a customer subnet fronting one OCI service resource ("Private Access to Oracle Services").
# It is an additional path, the service keeps its public endpoint, and DNS must be arranged.
schemaVersion: "1"
type: "component"
id: "oci-private-endpoint"
kind: "private-link"
provider: "oci"
docs: "https://docs.oracle.com/en-us/iaas/Content/Network/Concepts/privateaccess.htm"
defaults:
  managed: true
  approvalRequired: false
  crossRegion: false
  publicAccessDisabled: false
  privateDnsIntegration: false
properties:
  endpointType:
    type: "enum"
    values: ["private-endpoint", "psa-endpoint"]
    default: "private-endpoint"
  securityRulesApply:
    type: "boolean"
    default: true
```

Human page: https://localhost:3000/catalogue/components/oci-private-endpoint