1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. DataSafePrivateEndpoint
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.DataSafe.DataSafePrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    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("testDataSafePrivateEndpoint", {
        compartmentId: _var.compartment_id,
        displayName: _var.data_safe_private_endpoint_display_name,
        subnetId: oci_core_subnet.test_subnet.id,
        vcnId: oci_core_vcn.test_vcn.id,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        description: _var.data_safe_private_endpoint_description,
        freeformTags: {
            Department: "Finance",
        },
        nsgIds: _var.data_safe_private_endpoint_nsg_ids,
        privateEndpointIp: _var.data_safe_private_endpoint_private_endpoint_ip,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_data_safe_private_endpoint = oci.data_safe.DataSafePrivateEndpoint("testDataSafePrivateEndpoint",
        compartment_id=var["compartment_id"],
        display_name=var["data_safe_private_endpoint_display_name"],
        subnet_id=oci_core_subnet["test_subnet"]["id"],
        vcn_id=oci_core_vcn["test_vcn"]["id"],
        defined_tags={
            "Operations.CostCenter": "42",
        },
        description=var["data_safe_private_endpoint_description"],
        freeform_tags={
            "Department": "Finance",
        },
        nsg_ids=var["data_safe_private_endpoint_nsg_ids"],
        private_endpoint_ip=var["data_safe_private_endpoint_private_endpoint_ip"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataSafe"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := DataSafe.NewDataSafePrivateEndpoint(ctx, "testDataSafePrivateEndpoint", &DataSafe.DataSafePrivateEndpointArgs{
    			CompartmentId: pulumi.Any(_var.Compartment_id),
    			DisplayName:   pulumi.Any(_var.Data_safe_private_endpoint_display_name),
    			SubnetId:      pulumi.Any(oci_core_subnet.Test_subnet.Id),
    			VcnId:         pulumi.Any(oci_core_vcn.Test_vcn.Id),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			Description: pulumi.Any(_var.Data_safe_private_endpoint_description),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    			NsgIds:            pulumi.Any(_var.Data_safe_private_endpoint_nsg_ids),
    			PrivateEndpointIp: pulumi.Any(_var.Data_safe_private_endpoint_private_endpoint_ip),
    		})
    		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 testDataSafePrivateEndpoint = new Oci.DataSafe.DataSafePrivateEndpoint("testDataSafePrivateEndpoint", new()
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Data_safe_private_endpoint_display_name,
            SubnetId = oci_core_subnet.Test_subnet.Id,
            VcnId = oci_core_vcn.Test_vcn.Id,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            Description = @var.Data_safe_private_endpoint_description,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            NsgIds = @var.Data_safe_private_endpoint_nsg_ids,
            PrivateEndpointIp = @var.Data_safe_private_endpoint_private_endpoint_ip,
        });
    
    });
    
    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(var_.compartment_id())
                .displayName(var_.data_safe_private_endpoint_display_name())
                .subnetId(oci_core_subnet.test_subnet().id())
                .vcnId(oci_core_vcn.test_vcn().id())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .description(var_.data_safe_private_endpoint_description())
                .freeformTags(Map.of("Department", "Finance"))
                .nsgIds(var_.data_safe_private_endpoint_nsg_ids())
                .privateEndpointIp(var_.data_safe_private_endpoint_private_endpoint_ip())
                .build());
    
        }
    }
    
    resources:
      testDataSafePrivateEndpoint:
        type: oci:DataSafe:DataSafePrivateEndpoint
        properties:
          #Required
          compartmentId: ${var.compartment_id}
          displayName: ${var.data_safe_private_endpoint_display_name}
          subnetId: ${oci_core_subnet.test_subnet.id}
          vcnId: ${oci_core_vcn.test_vcn.id}
          #Optional
          definedTags:
            Operations.CostCenter: '42'
          description: ${var.data_safe_private_endpoint_description}
          freeformTags:
            Department: Finance
          nsgIds: ${var.data_safe_private_endpoint_nsg_ids}
          privateEndpointIp: ${var.data_safe_private_endpoint_private_endpoint_ip}
    

    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, Any]] = None,
                                description: Optional[str] = None,
                                freeform_tags: Optional[Mapping[str, Any]] = 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 string
    The unique name of the resource.
    args DataSafePrivateEndpointArgs
    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 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 string
    The unique name of the resource.
    args DataSafePrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataSafePrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataSafePrivateEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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", "any" },
        },
        Description = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
        NsgIds = new[]
        {
            "string",
        },
        PrivateEndpointIp = "string",
    });
    
    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.Map{
    		"string": pulumi.Any("any"),
    	},
    	Description: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	NsgIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	PrivateEndpointIp: pulumi.String("string"),
    })
    
    var dataSafePrivateEndpointResource = new DataSafePrivateEndpoint("dataSafePrivateEndpointResource", DataSafePrivateEndpointArgs.builder()        
        .compartmentId("string")
        .displayName("string")
        .subnetId("string")
        .vcnId("string")
        .definedTags(Map.of("string", "any"))
        .description("string")
        .freeformTags(Map.of("string", "any"))
        .nsgIds("string")
        .privateEndpointIp("string")
        .build());
    
    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": "any",
        },
        description="string",
        freeform_tags={
            "string": "any",
        },
        nsg_ids=["string"],
        private_endpoint_ip="string")
    
    const dataSafePrivateEndpointResource = new oci.datasafe.DataSafePrivateEndpoint("dataSafePrivateEndpointResource", {
        compartmentId: "string",
        displayName: "string",
        subnetId: "string",
        vcnId: "string",
        definedTags: {
            string: "any",
        },
        description: "string",
        freeformTags: {
            string: "any",
        },
        nsgIds: ["string"],
        privateEndpointIp: "string",
    });
    
    type: oci:DataSafe:DataSafePrivateEndpoint
    properties:
        compartmentId: string
        definedTags:
            string: any
        description: string
        displayName: string
        freeformTags:
            string: any
        nsgIds:
            - string
        privateEndpointIp: string
        subnetId: string
        vcnId: string
    

    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

    The DataSafePrivateEndpoint resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment.
    DisplayName string
    (Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
    SubnetId string
    The OCID of the subnet.
    VcnId 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, object>
    (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, object>
    (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 string
    The private IP address of the private endpoint.
    CompartmentId string
    (Updatable) The OCID of the compartment.
    DisplayName string
    (Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
    SubnetId string
    The OCID of the subnet.
    VcnId 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]interface{}
    (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]interface{}
    (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 string
    The private IP address of the private endpoint.
    compartmentId String
    (Updatable) The OCID of the compartment.
    displayName String
    (Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
    subnetId String
    The OCID of the subnet.
    vcnId 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,Object>
    (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,Object>
    (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 String
    The private IP address of the private endpoint.
    compartmentId string
    (Updatable) The OCID of the compartment.
    displayName string
    (Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
    subnetId string
    The OCID of the subnet.
    vcnId 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]: any}
    (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]: any}
    (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 string
    The private IP address of the private endpoint.
    compartment_id str
    (Updatable) The OCID of the compartment.
    display_name str
    (Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
    subnet_id str
    The OCID of the subnet.
    vcn_id 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, Any]
    (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, Any]
    (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 str
    The private IP address of the private endpoint.
    compartmentId String
    (Updatable) The OCID of the compartment.
    displayName String
    (Updatable) The display name for the private endpoint. The name does not have to be unique, and it's changeable.
    subnetId String
    The OCID of the subnet.
    vcnId 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<Any>
    (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<Any>
    (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 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, object>
    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]interface{}
    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,Object>
    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]: any}
    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, Any]
    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<Any>
    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, Any]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            endpoint_fqdn: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = 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, Any]] = 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)
    Resource lookup is not supported in YAML
    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.
    DefinedTags Dictionary<string, object>
    (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, object>
    (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 string
    The private IP address of the private endpoint.
    State string
    The current state of the private endpoint.
    SubnetId string
    The OCID of the subnet.
    SystemTags Dictionary<string, object>
    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 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]interface{}
    (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]interface{}
    (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 string
    The private IP address of the private endpoint.
    State string
    The current state of the private endpoint.
    SubnetId string
    The OCID of the subnet.
    SystemTags map[string]interface{}
    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 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,Object>
    (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,Object>
    (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 String
    The private IP address of the private endpoint.
    state String
    The current state of the private endpoint.
    subnetId String
    The OCID of the subnet.
    systemTags Map<String,Object>
    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 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]: any}
    (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]: any}
    (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 string
    The private IP address of the private endpoint.
    state string
    The current state of the private endpoint.
    subnetId string
    The OCID of the subnet.
    systemTags {[key: string]: any}
    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 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, Any]
    (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, Any]
    (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 str
    The private IP address of the private endpoint.
    state str
    The current state of the private endpoint.
    subnet_id str
    The OCID of the subnet.
    system_tags Mapping[str, Any]
    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 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<Any>
    (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<Any>
    (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 String
    The private IP address of the private endpoint.
    state String
    The current state of the private endpoint.
    subnetId String
    The OCID of the subnet.
    systemTags Map<Any>
    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 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"
    

    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 v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi