1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. DataSafePrivateEndpoint
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.DataSafe.DataSafePrivateEndpoint

Explore with Pulumi AI

This resource provides the Data Safe Private Endpoint resource in Oracle Cloud Infrastructure Data Safe service.

Creates a new Data Safe private endpoint.

Example Usage

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

const testDataSafePrivateEndpoint = new oci.datasafe.DataSafePrivateEndpoint("test_data_safe_private_endpoint", {
    compartmentId: compartmentId,
    displayName: dataSafePrivateEndpointDisplayName,
    subnetId: testSubnet.id,
    vcnId: testVcn.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: dataSafePrivateEndpointDescription,
    freeformTags: {
        Department: "Finance",
    },
    nsgIds: dataSafePrivateEndpointNsgIds,
    privateEndpointIp: dataSafePrivateEndpointPrivateEndpointIp,
});
Copy
import pulumi
import pulumi_oci as oci

test_data_safe_private_endpoint = oci.data_safe.DataSafePrivateEndpoint("test_data_safe_private_endpoint",
    compartment_id=compartment_id,
    display_name=data_safe_private_endpoint_display_name,
    subnet_id=test_subnet["id"],
    vcn_id=test_vcn["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=data_safe_private_endpoint_description,
    freeform_tags={
        "Department": "Finance",
    },
    nsg_ids=data_safe_private_endpoint_nsg_ids,
    private_endpoint_ip=data_safe_private_endpoint_private_endpoint_ip)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasafe.NewDataSafePrivateEndpoint(ctx, "test_data_safe_private_endpoint", &datasafe.DataSafePrivateEndpointArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DisplayName:   pulumi.Any(dataSafePrivateEndpointDisplayName),
			SubnetId:      pulumi.Any(testSubnet.Id),
			VcnId:         pulumi.Any(testVcn.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(dataSafePrivateEndpointDescription),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			NsgIds:            pulumi.Any(dataSafePrivateEndpointNsgIds),
			PrivateEndpointIp: pulumi.Any(dataSafePrivateEndpointPrivateEndpointIp),
		})
		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 testDataSafePrivateEndpoint = new Oci.DataSafe.DataSafePrivateEndpoint("test_data_safe_private_endpoint", new()
    {
        CompartmentId = compartmentId,
        DisplayName = dataSafePrivateEndpointDisplayName,
        SubnetId = testSubnet.Id,
        VcnId = testVcn.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = dataSafePrivateEndpointDescription,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        NsgIds = dataSafePrivateEndpointNsgIds,
        PrivateEndpointIp = dataSafePrivateEndpointPrivateEndpointIp,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.DataSafePrivateEndpoint;
import com.pulumi.oci.DataSafe.DataSafePrivateEndpointArgs;
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 testDataSafePrivateEndpoint = new DataSafePrivateEndpoint("testDataSafePrivateEndpoint", DataSafePrivateEndpointArgs.builder()
            .compartmentId(compartmentId)
            .displayName(dataSafePrivateEndpointDisplayName)
            .subnetId(testSubnet.id())
            .vcnId(testVcn.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(dataSafePrivateEndpointDescription)
            .freeformTags(Map.of("Department", "Finance"))
            .nsgIds(dataSafePrivateEndpointNsgIds)
            .privateEndpointIp(dataSafePrivateEndpointPrivateEndpointIp)
            .build());

    }
}
Copy
resources:
  testDataSafePrivateEndpoint:
    type: oci:DataSafe:DataSafePrivateEndpoint
    name: test_data_safe_private_endpoint
    properties:
      compartmentId: ${compartmentId}
      displayName: ${dataSafePrivateEndpointDisplayName}
      subnetId: ${testSubnet.id}
      vcnId: ${testVcn.id}
      definedTags:
        Operations.CostCenter: '42'
      description: ${dataSafePrivateEndpointDescription}
      freeformTags:
        Department: Finance
      nsgIds: ${dataSafePrivateEndpointNsgIds}
      privateEndpointIp: ${dataSafePrivateEndpointPrivateEndpointIp}
Copy

Create DataSafePrivateEndpoint Resource

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

Constructor syntax

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

@overload
def DataSafePrivateEndpoint(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,
                            freeform_tags: Optional[Mapping[str, str]] = None,
                            nsg_ids: Optional[Sequence[str]] = None,
                            private_endpoint_ip: Optional[str] = None)
func NewDataSafePrivateEndpoint(ctx *Context, name string, args DataSafePrivateEndpointArgs, opts ...ResourceOption) (*DataSafePrivateEndpoint, error)
public DataSafePrivateEndpoint(string name, DataSafePrivateEndpointArgs args, CustomResourceOptions? opts = null)
public DataSafePrivateEndpoint(String name, DataSafePrivateEndpointArgs args)
public DataSafePrivateEndpoint(String name, DataSafePrivateEndpointArgs args, CustomResourceOptions options)
type: oci:DataSafe:DataSafePrivateEndpoint
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. DataSafePrivateEndpointArgs
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. DataSafePrivateEndpointArgs
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. DataSafePrivateEndpointArgs
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. DataSafePrivateEndpointArgs
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. DataSafePrivateEndpointArgs
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 dataSafePrivateEndpointResource = new Oci.DataSafe.DataSafePrivateEndpoint("dataSafePrivateEndpointResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    SubnetId = "string",
    VcnId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    NsgIds = new[]
    {
        "string",
    },
    PrivateEndpointIp = "string",
});
Copy
example, err := DataSafe.NewDataSafePrivateEndpoint(ctx, "dataSafePrivateEndpointResource", &DataSafe.DataSafePrivateEndpointArgs{
	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"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NsgIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrivateEndpointIp: pulumi.String("string"),
})
Copy
var dataSafePrivateEndpointResource = new DataSafePrivateEndpoint("dataSafePrivateEndpointResource", DataSafePrivateEndpointArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .subnetId("string")
    .vcnId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .nsgIds("string")
    .privateEndpointIp("string")
    .build());
Copy
data_safe_private_endpoint_resource = oci.data_safe.DataSafePrivateEndpoint("dataSafePrivateEndpointResource",
    compartment_id="string",
    display_name="string",
    subnet_id="string",
    vcn_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    freeform_tags={
        "string": "string",
    },
    nsg_ids=["string"],
    private_endpoint_ip="string")
Copy
const dataSafePrivateEndpointResource = new oci.datasafe.DataSafePrivateEndpoint("dataSafePrivateEndpointResource", {
    compartmentId: "string",
    displayName: "string",
    subnetId: "string",
    vcnId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    nsgIds: ["string"],
    privateEndpointIp: "string",
});
Copy
type: oci:DataSafe:DataSafePrivateEndpoint
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    nsgIds:
        - string
    privateEndpointIp: string
    subnetId: string
    vcnId: string
Copy

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

CompartmentId This property is required. string
(Updatable) The OCID of the compartment.
DisplayName This property is required. string
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the subnet.
VcnId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the 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

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) The description of the private endpoint.
FreeformTags Dictionary<string, string>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
NsgIds List<string>
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
PrivateEndpointIp Changes to this property will trigger replacement. string
The private IP address of the private endpoint.
CompartmentId This property is required. string
(Updatable) The OCID of the compartment.
DisplayName This property is required. string
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the subnet.
VcnId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the 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

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) The description of the private endpoint.
FreeformTags map[string]string
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
NsgIds []string
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
PrivateEndpointIp Changes to this property will trigger replacement. string
The private IP address of the private endpoint.
compartmentId This property is required. String
(Updatable) The OCID of the compartment.
displayName This property is required. String
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
subnetId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the subnet.
vcnId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the 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

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) The description of the private endpoint.
freeformTags Map<String,String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
nsgIds List<String>
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
privateEndpointIp Changes to this property will trigger replacement. String
The private IP address of the private endpoint.
compartmentId This property is required. string
(Updatable) The OCID of the compartment.
displayName This property is required. string
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
subnetId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the subnet.
vcnId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the 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

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) The description of the private endpoint.
freeformTags {[key: string]: string}
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
nsgIds string[]
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
privateEndpointIp Changes to this property will trigger replacement. string
The private IP address of the private endpoint.
compartment_id This property is required. str
(Updatable) The OCID of the compartment.
display_name This property is required. str
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
subnet_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the subnet.
vcn_id
This property is required.
Changes to this property will trigger replacement.
str

The OCID of the 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

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) The description of the private endpoint.
freeform_tags Mapping[str, str]
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
nsg_ids Sequence[str]
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
private_endpoint_ip Changes to this property will trigger replacement. str
The private IP address of the private endpoint.
compartmentId This property is required. String
(Updatable) The OCID of the compartment.
displayName This property is required. String
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
subnetId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the subnet.
vcnId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the 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

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) The description of the private endpoint.
freeformTags Map<String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
nsgIds List<String>
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
privateEndpointIp Changes to this property will trigger replacement. String
The private IP address of the private endpoint.

Outputs

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

EndpointFqdn string
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
Id string
The provider-assigned unique ID for this managed resource.
PrivateEndpointId string
The OCID of the underlying private endpoint.
State string
The current state of the private endpoint.
SystemTags Dictionary<string, string>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The date and time the private endpoint was created, in the format defined by RFC3339.
EndpointFqdn string
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
Id string
The provider-assigned unique ID for this managed resource.
PrivateEndpointId string
The OCID of the underlying private endpoint.
State string
The current state of the private endpoint.
SystemTags map[string]string
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The date and time the private endpoint was created, in the format defined by RFC3339.
endpointFqdn String
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
id String
The provider-assigned unique ID for this managed resource.
privateEndpointId String
The OCID of the underlying private endpoint.
state String
The current state of the private endpoint.
systemTags Map<String,String>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The date and time the private endpoint was created, in the format defined by RFC3339.
endpointFqdn string
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
id string
The provider-assigned unique ID for this managed resource.
privateEndpointId string
The OCID of the underlying private endpoint.
state string
The current state of the private endpoint.
systemTags {[key: string]: string}
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The date and time the private endpoint was created, in the format defined by RFC3339.
endpoint_fqdn str
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
id str
The provider-assigned unique ID for this managed resource.
private_endpoint_id str
The OCID of the underlying private endpoint.
state str
The current state of the private endpoint.
system_tags Mapping[str, str]
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
The date and time the private endpoint was created, in the format defined by RFC3339.
endpointFqdn String
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
id String
The provider-assigned unique ID for this managed resource.
privateEndpointId String
The OCID of the underlying private endpoint.
state String
The current state of the private endpoint.
systemTags Map<String>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The date and time the private endpoint was created, in the format defined by RFC3339.

Look up Existing DataSafePrivateEndpoint Resource

Get an existing DataSafePrivateEndpoint 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?: DataSafePrivateEndpointState, opts?: CustomResourceOptions): DataSafePrivateEndpoint
@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,
        endpoint_fqdn: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        nsg_ids: Optional[Sequence[str]] = None,
        private_endpoint_id: Optional[str] = None,
        private_endpoint_ip: Optional[str] = None,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        vcn_id: Optional[str] = None) -> DataSafePrivateEndpoint
func GetDataSafePrivateEndpoint(ctx *Context, name string, id IDInput, state *DataSafePrivateEndpointState, opts ...ResourceOption) (*DataSafePrivateEndpoint, error)
public static DataSafePrivateEndpoint Get(string name, Input<string> id, DataSafePrivateEndpointState? state, CustomResourceOptions? opts = null)
public static DataSafePrivateEndpoint get(String name, Output<String> id, DataSafePrivateEndpointState state, CustomResourceOptions options)
resources:  _:    type: oci:DataSafe:DataSafePrivateEndpoint    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 string
(Updatable) The OCID of the compartment.
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) The description of the private endpoint.
DisplayName string
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
EndpointFqdn string
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
FreeformTags Dictionary<string, string>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
NsgIds List<string>
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
PrivateEndpointId string
The OCID of the underlying private endpoint.
PrivateEndpointIp Changes to this property will trigger replacement. string
The private IP address of the private endpoint.
State string
The current state of the private endpoint.
SubnetId Changes to this property will trigger replacement. string
The OCID of the subnet.
SystemTags Dictionary<string, string>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The date and time the private endpoint was created, in the format defined by RFC3339.
VcnId Changes to this property will trigger replacement. string

The OCID of the 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 string
(Updatable) The OCID of the compartment.
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) The description of the private endpoint.
DisplayName string
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
EndpointFqdn string
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
FreeformTags map[string]string
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
NsgIds []string
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
PrivateEndpointId string
The OCID of the underlying private endpoint.
PrivateEndpointIp Changes to this property will trigger replacement. string
The private IP address of the private endpoint.
State string
The current state of the private endpoint.
SubnetId Changes to this property will trigger replacement. string
The OCID of the subnet.
SystemTags map[string]string
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The date and time the private endpoint was created, in the format defined by RFC3339.
VcnId Changes to this property will trigger replacement. string

The OCID of the 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 String
(Updatable) The OCID of the compartment.
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) The description of the private endpoint.
displayName String
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
endpointFqdn String
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
freeformTags Map<String,String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
nsgIds List<String>
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
privateEndpointId String
The OCID of the underlying private endpoint.
privateEndpointIp Changes to this property will trigger replacement. String
The private IP address of the private endpoint.
state String
The current state of the private endpoint.
subnetId Changes to this property will trigger replacement. String
The OCID of the subnet.
systemTags Map<String,String>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The date and time the private endpoint was created, in the format defined by RFC3339.
vcnId Changes to this property will trigger replacement. String

The OCID of the 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 string
(Updatable) The OCID of the compartment.
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) The description of the private endpoint.
displayName string
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
endpointFqdn string
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
freeformTags {[key: string]: string}
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
nsgIds string[]
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
privateEndpointId string
The OCID of the underlying private endpoint.
privateEndpointIp Changes to this property will trigger replacement. string
The private IP address of the private endpoint.
state string
The current state of the private endpoint.
subnetId Changes to this property will trigger replacement. string
The OCID of the subnet.
systemTags {[key: string]: string}
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The date and time the private endpoint was created, in the format defined by RFC3339.
vcnId Changes to this property will trigger replacement. string

The OCID of the 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 str
(Updatable) The OCID of the compartment.
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) The description of the private endpoint.
display_name str
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
endpoint_fqdn str
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
freeform_tags Mapping[str, str]
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
nsg_ids Sequence[str]
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
private_endpoint_id str
The OCID of the underlying private endpoint.
private_endpoint_ip Changes to this property will trigger replacement. str
The private IP address of the private endpoint.
state str
The current state of the private endpoint.
subnet_id Changes to this property will trigger replacement. str
The OCID of the subnet.
system_tags Mapping[str, str]
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
The date and time the private endpoint was created, in the format defined by RFC3339.
vcn_id Changes to this property will trigger replacement. str

The OCID of the 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 String
(Updatable) The OCID of the compartment.
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) The description of the private endpoint.
displayName String
(Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
endpointFqdn String
The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
freeformTags Map<String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
nsgIds List<String>
(Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
privateEndpointId String
The OCID of the underlying private endpoint.
privateEndpointIp Changes to this property will trigger replacement. String
The private IP address of the private endpoint.
state String
The current state of the private endpoint.
subnetId Changes to this property will trigger replacement. String
The OCID of the subnet.
systemTags Map<String>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The date and time the private endpoint was created, in the format defined by RFC3339.
vcnId Changes to this property will trigger replacement. String

The OCID of the 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

Import

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

$ pulumi import oci:DataSafe/dataSafePrivateEndpoint:DataSafePrivateEndpoint test_data_safe_private_endpoint "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.