Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ResourceManager
  5. PrivateEndpoint
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.ResourceManager.PrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Private Endpoint resource in Oracle Cloud Infrastructure Resource Manager service.

    Creates a a private endpoint in the specified compartment.

    Example Usage

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

const testPrivateEndpoint = new oci.resourcemanager.PrivateEndpoint("test_private_endpoint", {
    compartmentId: compartmentId,
    displayName: privateEndpointDisplayName,
    subnetId: testSubnet.id,
    vcnId: testVcn.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: privateEndpointDescription,
    dnsZones: privateEndpointDnsZones,
    freeformTags: {
        Department: "Finance",
    },
    isUsedWithConfigurationSourceProvider: privateEndpointIsUsedWithConfigurationSourceProvider,
    nsgIdLists: privateEndpointNsgIdList,
});

    import pulumi
import pulumi_oci as oci

test_private_endpoint = oci.resource_manager.PrivateEndpoint("test_private_endpoint",
    compartment_id=compartment_id,
    display_name=private_endpoint_display_name,
    subnet_id=test_subnet["id"],
    vcn_id=test_vcn["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=private_endpoint_description,
    dns_zones=private_endpoint_dns_zones,
    freeform_tags={
        "Department": "Finance",
    },
    is_used_with_configuration_source_provider=private_endpoint_is_used_with_configuration_source_provider,
    nsg_id_lists=private_endpoint_nsg_id_list)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourcemanager.NewPrivateEndpoint(ctx, "test_private_endpoint", &resourcemanager.PrivateEndpointArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DisplayName:   pulumi.Any(privateEndpointDisplayName),
			SubnetId:      pulumi.Any(testSubnet.Id),
			VcnId:         pulumi.Any(testVcn.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(privateEndpointDescription),
			DnsZones:    pulumi.Any(privateEndpointDnsZones),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IsUsedWithConfigurationSourceProvider: pulumi.Any(privateEndpointIsUsedWithConfigurationSourceProvider),
			NsgIdLists:                            pulumi.Any(privateEndpointNsgIdList),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testPrivateEndpoint = new Oci.ResourceManager.PrivateEndpoint("test_private_endpoint", new()
    {
        CompartmentId = compartmentId,
        DisplayName = privateEndpointDisplayName,
        SubnetId = testSubnet.Id,
        VcnId = testVcn.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = privateEndpointDescription,
        DnsZones = privateEndpointDnsZones,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsUsedWithConfigurationSourceProvider = privateEndpointIsUsedWithConfigurationSourceProvider,
        NsgIdLists = privateEndpointNsgIdList,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ResourceManager.PrivateEndpoint;
import com.pulumi.oci.ResourceManager.PrivateEndpointArgs;
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 testPrivateEndpoint = new PrivateEndpoint("testPrivateEndpoint", PrivateEndpointArgs.builder()
            .compartmentId(compartmentId)
            .displayName(privateEndpointDisplayName)
            .subnetId(testSubnet.id())
            .vcnId(testVcn.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(privateEndpointDescription)
            .dnsZones(privateEndpointDnsZones)
            .freeformTags(Map.of("Department", "Finance"))
            .isUsedWithConfigurationSourceProvider(privateEndpointIsUsedWithConfigurationSourceProvider)
            .nsgIdLists(privateEndpointNsgIdList)
            .build());

    }
}

    resources:
  testPrivateEndpoint:
    type: oci:ResourceManager:PrivateEndpoint
    name: test_private_endpoint
    properties:
      compartmentId: ${compartmentId}
      displayName: ${privateEndpointDisplayName}
      subnetId: ${testSubnet.id}
      vcnId: ${testVcn.id}
      definedTags:
        Operations.CostCenter: '42'
      description: ${privateEndpointDescription}
      dnsZones: ${privateEndpointDnsZones}
      freeformTags:
        Department: Finance
      isUsedWithConfigurationSourceProvider: ${privateEndpointIsUsedWithConfigurationSourceProvider}
      nsgIdLists: ${privateEndpointNsgIdList}

    Create PrivateEndpoint Resource

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

    Constructor syntax

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

@overload
def PrivateEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    compartment_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    subnet_id: Optional[str] = None,
                    vcn_id: Optional[str] = None,
                    defined_tags: Optional[Mapping[str, str]] = None,
                    description: Optional[str] = None,
                    dns_zones: Optional[Sequence[str]] = None,
                    freeform_tags: Optional[Mapping[str, str]] = None,
                    is_used_with_configuration_source_provider: Optional[bool] = None,
                    nsg_id_lists: Optional[Sequence[str]] = None)
    func NewPrivateEndpoint(ctx *Context, name string, args PrivateEndpointArgs, opts ...ResourceOption) (*PrivateEndpoint, error)
    public PrivateEndpoint(string name, PrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public PrivateEndpoint(String name, PrivateEndpointArgs args)
public PrivateEndpoint(String name, PrivateEndpointArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateEndpointArgs
    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 exampleprivateEndpointResourceResourceFromResourceManagerprivateEndpoint = new Oci.ResourceManager.PrivateEndpoint("exampleprivateEndpointResourceResourceFromResourceManagerprivateEndpoint", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    SubnetId = "string",
    VcnId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DnsZones = new[]
    {
        "string",
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsUsedWithConfigurationSourceProvider = false,
    NsgIdLists = new[]
    {
        "string",
    },
});

    example, err := resourcemanager.NewPrivateEndpoint(ctx, "exampleprivateEndpointResourceResourceFromResourceManagerprivateEndpoint", &resourcemanager.PrivateEndpointArgs{
	CompartmentId: pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	SubnetId:      pulumi.String("string"),
	VcnId:         pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DnsZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsUsedWithConfigurationSourceProvider: pulumi.Bool(false),
	NsgIdLists: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var exampleprivateEndpointResourceResourceFromResourceManagerprivateEndpoint = new com.pulumi.oci.ResourceManager.PrivateEndpoint("exampleprivateEndpointResourceResourceFromResourceManagerprivateEndpoint", com.pulumi.oci.ResourceManager.PrivateEndpointArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .subnetId("string")
    .vcnId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .dnsZones("string")
    .freeformTags(Map.of("string", "string"))
    .isUsedWithConfigurationSourceProvider(false)
    .nsgIdLists("string")
    .build());

    exampleprivate_endpoint_resource_resource_from_resource_managerprivate_endpoint = oci.resource_manager.PrivateEndpoint("exampleprivateEndpointResourceResourceFromResourceManagerprivateEndpoint",
    compartment_id="string",
    display_name="string",
    subnet_id="string",
    vcn_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    dns_zones=["string"],
    freeform_tags={
        "string": "string",
    },
    is_used_with_configuration_source_provider=False,
    nsg_id_lists=["string"])

    const exampleprivateEndpointResourceResourceFromResourceManagerprivateEndpoint = new oci.resourcemanager.PrivateEndpoint("exampleprivateEndpointResourceResourceFromResourceManagerprivateEndpoint", {
    compartmentId: "string",
    displayName: "string",
    subnetId: "string",
    vcnId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    dnsZones: ["string"],
    freeformTags: {
        string: "string",
    },
    isUsedWithConfigurationSourceProvider: false,
    nsgIdLists: ["string"],
});

    type: oci:ResourceManager:PrivateEndpoint
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    dnsZones:
        - string
    freeformTags:
        string: string
    isUsedWithConfigurationSourceProvider: false
    nsgIdLists:
        - string
    subnetId: string
    vcnId: string

    PrivateEndpoint 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 PrivateEndpoint resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment containing this private endpoint details.
    DisplayName string
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    SubnetId string
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    VcnId string

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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

    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    DnsZones List<string>
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsUsedWithConfigurationSourceProvider bool
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    NsgIdLists List<string>
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    CompartmentId string
    (Updatable) The OCID of the compartment containing this private endpoint details.
    DisplayName string
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    SubnetId string
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    VcnId string

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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

    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    DnsZones []string
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    FreeformTags map[string]string
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsUsedWithConfigurationSourceProvider bool
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    NsgIdLists []string
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    compartmentId String
    (Updatable) The OCID of the compartment containing this private endpoint details.
    displayName String
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    subnetId String
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    vcnId String

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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

    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    dnsZones List<String>
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeformTags Map<String,String>
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isUsedWithConfigurationSourceProvider Boolean
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists List<String>
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    compartmentId string
    (Updatable) The OCID of the compartment containing this private endpoint details.
    displayName string
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    subnetId string
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    vcnId string

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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

    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    dnsZones string[]
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isUsedWithConfigurationSourceProvider boolean
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists string[]
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    compartment_id str
    (Updatable) The OCID of the compartment containing this private endpoint details.
    display_name str
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    subnet_id str
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    vcn_id str

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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

    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    dns_zones Sequence[str]
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    is_used_with_configuration_source_provider bool
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    nsg_id_lists Sequence[str]
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    compartmentId String
    (Updatable) The OCID of the compartment containing this private endpoint details.
    displayName String
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    subnetId String
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    vcnId String

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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

    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    dnsZones List<String>
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeformTags Map<String>
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isUsedWithConfigurationSourceProvider Boolean
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists List<String>
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SourceIps List<string>
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    State string
    The current lifecycle state of the private endpoint.
    TimeCreated string
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceIps []string
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    State string
    The current lifecycle state of the private endpoint.
    TimeCreated string
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    sourceIps List<String>
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state String
    The current lifecycle state of the private endpoint.
    timeCreated String
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    id string
    The provider-assigned unique ID for this managed resource.
    sourceIps string[]
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state string
    The current lifecycle state of the private endpoint.
    timeCreated string
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    id str
    The provider-assigned unique ID for this managed resource.
    source_ips Sequence[str]
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state str
    The current lifecycle state of the private endpoint.
    time_created str
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    sourceIps List<String>
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state String
    The current lifecycle state of the private endpoint.
    timeCreated String
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z

    Look up Existing PrivateEndpoint Resource

    Get an existing PrivateEndpoint 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?: PrivateEndpointState, opts?: CustomResourceOptions): PrivateEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        dns_zones: Optional[Sequence[str]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_used_with_configuration_source_provider: Optional[bool] = None,
        nsg_id_lists: Optional[Sequence[str]] = None,
        source_ips: Optional[Sequence[str]] = None,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        time_created: Optional[str] = None,
        vcn_id: Optional[str] = None) -> PrivateEndpoint
    func GetPrivateEndpoint(ctx *Context, name string, id IDInput, state *PrivateEndpointState, opts ...ResourceOption) (*PrivateEndpoint, error)
    public static PrivateEndpoint Get(string name, Input<string> id, PrivateEndpointState? state, CustomResourceOptions? opts = null)
    public static PrivateEndpoint get(String name, Output<String> id, PrivateEndpointState state, CustomResourceOptions options)
    resources:  _:    type: oci:ResourceManager:PrivateEndpoint    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 string
    (Updatable) The OCID of the compartment containing this private endpoint details.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    DisplayName string
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    DnsZones List<string>
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsUsedWithConfigurationSourceProvider bool
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    NsgIdLists List<string>
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    SourceIps List<string>
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    State string
    The current lifecycle state of the private endpoint.
    SubnetId string
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    TimeCreated string
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    VcnId string

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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 string
    (Updatable) The OCID of the compartment containing this private endpoint details.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    DisplayName string
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    DnsZones []string
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    FreeformTags map[string]string
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsUsedWithConfigurationSourceProvider bool
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    NsgIdLists []string
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    SourceIps []string
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    State string
    The current lifecycle state of the private endpoint.
    SubnetId string
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    TimeCreated string
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    VcnId string

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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 String
    (Updatable) The OCID of the compartment containing this private endpoint details.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    displayName String
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    dnsZones List<String>
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeformTags Map<String,String>
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isUsedWithConfigurationSourceProvider Boolean
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists List<String>
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    sourceIps List<String>
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state String
    The current lifecycle state of the private endpoint.
    subnetId String
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    timeCreated String
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    vcnId String

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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 string
    (Updatable) The OCID of the compartment containing this private endpoint details.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    displayName string
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    dnsZones string[]
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isUsedWithConfigurationSourceProvider boolean
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists string[]
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    sourceIps string[]
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state string
    The current lifecycle state of the private endpoint.
    subnetId string
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    timeCreated string
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    vcnId string

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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 str
    (Updatable) The OCID of the compartment containing this private endpoint details.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    display_name str
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    dns_zones Sequence[str]
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    is_used_with_configuration_source_provider bool
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    nsg_id_lists Sequence[str]
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    source_ips Sequence[str]
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state str
    The current lifecycle state of the private endpoint.
    subnet_id str
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    time_created str
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    vcn_id str

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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 String
    (Updatable) The OCID of the compartment containing this private endpoint details.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) Description of the private endpoint. Avoid entering confidential information.
    displayName String
    (Updatable) The private endpoint display name. Avoid entering confidential information.
    dnsZones List<String>
    (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
    freeformTags Map<String>
    (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isUsedWithConfigurationSourceProvider Boolean
    (Updatable) When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists List<String>
    (Updatable) An array of network security group (NSG) OCIDs for the private endpoint. Order does not matter.
    sourceIps List<String>
    The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
    state String
    The current lifecycle state of the private endpoint.
    subnetId String
    (Updatable) The OCID of the subnet within the VCN for the private endpoint.
    timeCreated String
    The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
    vcnId String

    (Updatable) The OCID of the VCN for the private endpoint.

    ** 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

    Import

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

    $ pulumi import oci:ResourceManager/privateEndpoint:PrivateEndpoint test_private_endpoint "id"

    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.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci