pulumi-oci 2.16.0a1731393786__py3-none-any.whl → 2.16.0a1731504509__py3-none-any.whl

pulumi_oci/globallydistributeddatabase/private_endpoint.py

@@ -0,0 +1,822 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+
+__all__ = ['PrivateEndpointArgs', 'PrivateEndpoint']
+
+@pulumi.input_type
+class PrivateEndpointArgs:
+    def __init__(__self__, *,
+                 compartment_id: pulumi.Input[str],
+                 display_name: pulumi.Input[str],
+                 subnet_id: pulumi.Input[str],
+                 defined_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 description: Optional[pulumi.Input[str]] = None,
+                 freeform_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 nsg_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 reinstate_proxy_instance_trigger: Optional[pulumi.Input[int]] = None):
+        """
+        The set of arguments for constructing a PrivateEndpoint resource.
+        :param pulumi.Input[str] compartment_id: (Updatable) Identifier of the compartment where private endpoint is to be created.
+        :param pulumi.Input[str] display_name: (Updatable) Private endpoint display name.
+        :param pulumi.Input[str] subnet_id: Identifier of the customer subnet against which private endpoint is to be created.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] defined_tags: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
+        :param pulumi.Input[str] description: (Updatable) PrivateEndpoint description.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] freeform_tags: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] nsg_ids: (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
+        :param pulumi.Input[int] reinstate_proxy_instance_trigger: (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.
+               
+               
+               ** 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
+        """
+        pulumi.set(__self__, "compartment_id", compartment_id)
+        pulumi.set(__self__, "display_name", display_name)
+        pulumi.set(__self__, "subnet_id", subnet_id)
+        if defined_tags is not None:
+            pulumi.set(__self__, "defined_tags", defined_tags)
+        if description is not None:
+            pulumi.set(__self__, "description", description)
+        if freeform_tags is not None:
+            pulumi.set(__self__, "freeform_tags", freeform_tags)
+        if nsg_ids is not None:
+            pulumi.set(__self__, "nsg_ids", nsg_ids)
+        if reinstate_proxy_instance_trigger is not None:
+            pulumi.set(__self__, "reinstate_proxy_instance_trigger", reinstate_proxy_instance_trigger)
+
+    @property
+    @pulumi.getter(name="compartmentId")
+    def compartment_id(self) -> pulumi.Input[str]:
+        """
+        (Updatable) Identifier of the compartment where private endpoint is to be created.
+        """
+        return pulumi.get(self, "compartment_id")
+
+    @compartment_id.setter
+    def compartment_id(self, value: pulumi.Input[str]):
+        pulumi.set(self, "compartment_id", value)
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> pulumi.Input[str]:
+        """
+        (Updatable) Private endpoint display name.
+        """
+        return pulumi.get(self, "display_name")
+
+    @display_name.setter
+    def display_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "display_name", value)
+
+    @property
+    @pulumi.getter(name="subnetId")
+    def subnet_id(self) -> pulumi.Input[str]:
+        """
+        Identifier of the customer subnet against which private endpoint is to be created.
+        """
+        return pulumi.get(self, "subnet_id")
+
+    @subnet_id.setter
+    def subnet_id(self, value: pulumi.Input[str]):
+        pulumi.set(self, "subnet_id", value)
+
+    @property
+    @pulumi.getter(name="definedTags")
+    def defined_tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
+        """
+        (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
+        """
+        return pulumi.get(self, "defined_tags")
+
+    @defined_tags.setter
+    def defined_tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
+        pulumi.set(self, "defined_tags", value)
+
+    @property
+    @pulumi.getter
+    def description(self) -> Optional[pulumi.Input[str]]:
+        """
+        (Updatable) PrivateEndpoint description.
+        """
+        return pulumi.get(self, "description")
+
+    @description.setter
+    def description(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "description", value)
+
+    @property
+    @pulumi.getter(name="freeformTags")
+    def freeform_tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
+        """
+        (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
+        """
+        return pulumi.get(self, "freeform_tags")
+
+    @freeform_tags.setter
+    def freeform_tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
+        pulumi.set(self, "freeform_tags", value)
+
+    @property
+    @pulumi.getter(name="nsgIds")
+    def nsg_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
+        """
+        (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
+        """
+        return pulumi.get(self, "nsg_ids")
+
+    @nsg_ids.setter
+    def nsg_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
+        pulumi.set(self, "nsg_ids", value)
+
+    @property
+    @pulumi.getter(name="reinstateProxyInstanceTrigger")
+    def reinstate_proxy_instance_trigger(self) -> Optional[pulumi.Input[int]]:
+        """
+        (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.
+
+
+        ** 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
+        """
+        return pulumi.get(self, "reinstate_proxy_instance_trigger")
+
+    @reinstate_proxy_instance_trigger.setter
+    def reinstate_proxy_instance_trigger(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "reinstate_proxy_instance_trigger", value)
+
+
+@pulumi.input_type
+class _PrivateEndpointState:
+    def __init__(__self__, *,
+                 compartment_id: Optional[pulumi.Input[str]] = None,
+                 defined_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 description: Optional[pulumi.Input[str]] = None,
+                 display_name: Optional[pulumi.Input[str]] = None,
+                 freeform_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 lifecycle_state_details: Optional[pulumi.Input[str]] = None,
+                 nsg_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 private_ip: Optional[pulumi.Input[str]] = None,
+                 proxy_compute_instance_id: Optional[pulumi.Input[str]] = None,
+                 reinstate_proxy_instance_trigger: Optional[pulumi.Input[int]] = None,
+                 sharded_databases: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 state: Optional[pulumi.Input[str]] = None,
+                 subnet_id: Optional[pulumi.Input[str]] = None,
+                 system_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 time_created: Optional[pulumi.Input[str]] = None,
+                 time_updated: Optional[pulumi.Input[str]] = None,
+                 vcn_id: Optional[pulumi.Input[str]] = None):
+        """
+        Input properties used for looking up and filtering PrivateEndpoint resources.
+        :param pulumi.Input[str] compartment_id: (Updatable) Identifier of the compartment where private endpoint is to be created.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] defined_tags: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
+        :param pulumi.Input[str] description: (Updatable) PrivateEndpoint description.
+        :param pulumi.Input[str] display_name: (Updatable) Private endpoint display name.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] freeform_tags: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
+        :param pulumi.Input[str] lifecycle_state_details: Detailed message for the lifecycle state.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] nsg_ids: (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
+        :param pulumi.Input[str] private_ip: IP address of the Private Endpoint.
+        :param pulumi.Input[str] proxy_compute_instance_id: The identifier of the proxy compute instance.
+        :param pulumi.Input[int] reinstate_proxy_instance_trigger: (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.
+               
+               
+               ** 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
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] sharded_databases: The OCIDs of sharded databases that consumes the given private endpoint.
+        :param pulumi.Input[str] state: Lifecycle states for private endpoint.
+        :param pulumi.Input[str] subnet_id: Identifier of the customer subnet against which private endpoint is to be created.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] system_tags: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`
+        :param pulumi.Input[str] time_created: The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
+        :param pulumi.Input[str] time_updated: The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
+        :param pulumi.Input[str] vcn_id: Identifier of the VCN in which subnet exists.
+        """
+        if compartment_id is not None:
+            pulumi.set(__self__, "compartment_id", compartment_id)
+        if defined_tags is not None:
+            pulumi.set(__self__, "defined_tags", defined_tags)
+        if description is not None:
+            pulumi.set(__self__, "description", description)
+        if display_name is not None:
+            pulumi.set(__self__, "display_name", display_name)
+        if freeform_tags is not None:
+            pulumi.set(__self__, "freeform_tags", freeform_tags)
+        if lifecycle_state_details is not None:
+            pulumi.set(__self__, "lifecycle_state_details", lifecycle_state_details)
+        if nsg_ids is not None:
+            pulumi.set(__self__, "nsg_ids", nsg_ids)
+        if private_ip is not None:
+            pulumi.set(__self__, "private_ip", private_ip)
+        if proxy_compute_instance_id is not None:
+            pulumi.set(__self__, "proxy_compute_instance_id", proxy_compute_instance_id)
+        if reinstate_proxy_instance_trigger is not None:
+            pulumi.set(__self__, "reinstate_proxy_instance_trigger", reinstate_proxy_instance_trigger)
+        if sharded_databases is not None:
+            pulumi.set(__self__, "sharded_databases", sharded_databases)
+        if state is not None:
+            pulumi.set(__self__, "state", state)
+        if subnet_id is not None:
+            pulumi.set(__self__, "subnet_id", subnet_id)
+        if system_tags is not None:
+            pulumi.set(__self__, "system_tags", system_tags)
+        if time_created is not None:
+            pulumi.set(__self__, "time_created", time_created)
+        if time_updated is not None:
+            pulumi.set(__self__, "time_updated", time_updated)
+        if vcn_id is not None:
+            pulumi.set(__self__, "vcn_id", vcn_id)
+
+    @property
+    @pulumi.getter(name="compartmentId")
+    def compartment_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        (Updatable) Identifier of the compartment where private endpoint is to be created.
+        """
+        return pulumi.get(self, "compartment_id")
+
+    @compartment_id.setter
+    def compartment_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "compartment_id", value)
+
+    @property
+    @pulumi.getter(name="definedTags")
+    def defined_tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
+        """
+        (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
+        """
+        return pulumi.get(self, "defined_tags")
+
+    @defined_tags.setter
+    def defined_tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
+        pulumi.set(self, "defined_tags", value)
+
+    @property
+    @pulumi.getter
+    def description(self) -> Optional[pulumi.Input[str]]:
+        """
+        (Updatable) PrivateEndpoint description.
+        """
+        return pulumi.get(self, "description")
+
+    @description.setter
+    def description(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "description", value)
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> Optional[pulumi.Input[str]]:
+        """
+        (Updatable) Private endpoint display name.
+        """
+        return pulumi.get(self, "display_name")
+
+    @display_name.setter
+    def display_name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "display_name", value)
+
+    @property
+    @pulumi.getter(name="freeformTags")
+    def freeform_tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
+        """
+        (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
+        """
+        return pulumi.get(self, "freeform_tags")
+
+    @freeform_tags.setter
+    def freeform_tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
+        pulumi.set(self, "freeform_tags", value)
+
+    @property
+    @pulumi.getter(name="lifecycleStateDetails")
+    def lifecycle_state_details(self) -> Optional[pulumi.Input[str]]:
+        """
+        Detailed message for the lifecycle state.
+        """
+        return pulumi.get(self, "lifecycle_state_details")
+
+    @lifecycle_state_details.setter
+    def lifecycle_state_details(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "lifecycle_state_details", value)
+
+    @property
+    @pulumi.getter(name="nsgIds")
+    def nsg_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
+        """
+        (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
+        """
+        return pulumi.get(self, "nsg_ids")
+
+    @nsg_ids.setter
+    def nsg_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
+        pulumi.set(self, "nsg_ids", value)
+
+    @property
+    @pulumi.getter(name="privateIp")
+    def private_ip(self) -> Optional[pulumi.Input[str]]:
+        """
+        IP address of the Private Endpoint.
+        """
+        return pulumi.get(self, "private_ip")
+
+    @private_ip.setter
+    def private_ip(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "private_ip", value)
+
+    @property
+    @pulumi.getter(name="proxyComputeInstanceId")
+    def proxy_compute_instance_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The identifier of the proxy compute instance.
+        """
+        return pulumi.get(self, "proxy_compute_instance_id")
+
+    @proxy_compute_instance_id.setter
+    def proxy_compute_instance_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "proxy_compute_instance_id", value)
+
+    @property
+    @pulumi.getter(name="reinstateProxyInstanceTrigger")
+    def reinstate_proxy_instance_trigger(self) -> Optional[pulumi.Input[int]]:
+        """
+        (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.
+
+
+        ** 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
+        """
+        return pulumi.get(self, "reinstate_proxy_instance_trigger")
+
+    @reinstate_proxy_instance_trigger.setter
+    def reinstate_proxy_instance_trigger(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "reinstate_proxy_instance_trigger", value)
+
+    @property
+    @pulumi.getter(name="shardedDatabases")
+    def sharded_databases(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
+        """
+        The OCIDs of sharded databases that consumes the given private endpoint.
+        """
+        return pulumi.get(self, "sharded_databases")
+
+    @sharded_databases.setter
+    def sharded_databases(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
+        pulumi.set(self, "sharded_databases", value)
+
+    @property
+    @pulumi.getter
+    def state(self) -> Optional[pulumi.Input[str]]:
+        """
+        Lifecycle states for private endpoint.
+        """
+        return pulumi.get(self, "state")
+
+    @state.setter
+    def state(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "state", value)
+
+    @property
+    @pulumi.getter(name="subnetId")
+    def subnet_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        Identifier of the customer subnet against which private endpoint is to be created.
+        """
+        return pulumi.get(self, "subnet_id")
+
+    @subnet_id.setter
+    def subnet_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "subnet_id", value)
+
+    @property
+    @pulumi.getter(name="systemTags")
+    def system_tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
+        """
+        Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`
+        """
+        return pulumi.get(self, "system_tags")
+
+    @system_tags.setter
+    def system_tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
+        pulumi.set(self, "system_tags", value)
+
+    @property
+    @pulumi.getter(name="timeCreated")
+    def time_created(self) -> Optional[pulumi.Input[str]]:
+        """
+        The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
+        """
+        return pulumi.get(self, "time_created")
+
+    @time_created.setter
+    def time_created(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "time_created", value)
+
+    @property
+    @pulumi.getter(name="timeUpdated")
+    def time_updated(self) -> Optional[pulumi.Input[str]]:
+        """
+        The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
+        """
+        return pulumi.get(self, "time_updated")
+
+    @time_updated.setter
+    def time_updated(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "time_updated", value)
+
+    @property
+    @pulumi.getter(name="vcnId")
+    def vcn_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        Identifier of the VCN in which subnet exists.
+        """
+        return pulumi.get(self, "vcn_id")
+
+    @vcn_id.setter
+    def vcn_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "vcn_id", value)
+
+
+class PrivateEndpoint(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 compartment_id: Optional[pulumi.Input[str]] = None,
+                 defined_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 description: Optional[pulumi.Input[str]] = None,
+                 display_name: Optional[pulumi.Input[str]] = None,
+                 freeform_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 nsg_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 reinstate_proxy_instance_trigger: Optional[pulumi.Input[int]] = None,
+                 subnet_id: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        """
+        This resource provides the Private Endpoint resource in Oracle Cloud Infrastructure Globally Distributed Database service.
+
+        Creates a PrivateEndpoint.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_oci as oci
+
+        test_private_endpoint = oci.globally_distributed_database.PrivateEndpoint("test_private_endpoint",
+            compartment_id=compartment_id,
+            display_name=private_endpoint_display_name,
+            subnet_id=test_subnet["id"],
+            defined_tags={
+                "foo-namespace.bar-key": "value",
+            },
+            description=private_endpoint_description,
+            freeform_tags={
+                "bar-key": "value",
+            },
+            nsg_ids=private_endpoint_nsg_ids)
+        ```
+
+        ## Import
+
+        PrivateEndpoints can be imported using the `id`, e.g.
+
+        ```sh
+        $ pulumi import oci:GloballyDistributedDatabase/privateEndpoint:PrivateEndpoint test_private_endpoint "id"
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] compartment_id: (Updatable) Identifier of the compartment where private endpoint is to be created.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] defined_tags: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
+        :param pulumi.Input[str] description: (Updatable) PrivateEndpoint description.
+        :param pulumi.Input[str] display_name: (Updatable) Private endpoint display name.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] freeform_tags: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] nsg_ids: (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
+        :param pulumi.Input[int] reinstate_proxy_instance_trigger: (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.
+               
+               
+               ** 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
+        :param pulumi.Input[str] subnet_id: Identifier of the customer subnet against which private endpoint is to be created.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: PrivateEndpointArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        This resource provides the Private Endpoint resource in Oracle Cloud Infrastructure Globally Distributed Database service.
+
+        Creates a PrivateEndpoint.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_oci as oci
+
+        test_private_endpoint = oci.globally_distributed_database.PrivateEndpoint("test_private_endpoint",
+            compartment_id=compartment_id,
+            display_name=private_endpoint_display_name,
+            subnet_id=test_subnet["id"],
+            defined_tags={
+                "foo-namespace.bar-key": "value",
+            },
+            description=private_endpoint_description,
+            freeform_tags={
+                "bar-key": "value",
+            },
+            nsg_ids=private_endpoint_nsg_ids)
+        ```
+
+        ## Import
+
+        PrivateEndpoints can be imported using the `id`, e.g.
+
+        ```sh
+        $ pulumi import oci:GloballyDistributedDatabase/privateEndpoint:PrivateEndpoint test_private_endpoint "id"
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param PrivateEndpointArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(PrivateEndpointArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 compartment_id: Optional[pulumi.Input[str]] = None,
+                 defined_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 description: Optional[pulumi.Input[str]] = None,
+                 display_name: Optional[pulumi.Input[str]] = None,
+                 freeform_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 nsg_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+                 reinstate_proxy_instance_trigger: Optional[pulumi.Input[int]] = None,
+                 subnet_id: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = PrivateEndpointArgs.__new__(PrivateEndpointArgs)
+
+            if compartment_id is None and not opts.urn:
+                raise TypeError("Missing required property 'compartment_id'")
+            __props__.__dict__["compartment_id"] = compartment_id
+            __props__.__dict__["defined_tags"] = defined_tags
+            __props__.__dict__["description"] = description
+            if display_name is None and not opts.urn:
+                raise TypeError("Missing required property 'display_name'")
+            __props__.__dict__["display_name"] = display_name
+            __props__.__dict__["freeform_tags"] = freeform_tags
+            __props__.__dict__["nsg_ids"] = nsg_ids
+            __props__.__dict__["reinstate_proxy_instance_trigger"] = reinstate_proxy_instance_trigger
+            if subnet_id is None and not opts.urn:
+                raise TypeError("Missing required property 'subnet_id'")
+            __props__.__dict__["subnet_id"] = subnet_id
+            __props__.__dict__["lifecycle_state_details"] = None
+            __props__.__dict__["private_ip"] = None
+            __props__.__dict__["proxy_compute_instance_id"] = None
+            __props__.__dict__["sharded_databases"] = None
+            __props__.__dict__["state"] = None
+            __props__.__dict__["system_tags"] = None
+            __props__.__dict__["time_created"] = None
+            __props__.__dict__["time_updated"] = None
+            __props__.__dict__["vcn_id"] = None
+        super(PrivateEndpoint, __self__).__init__(
+            'oci:GloballyDistributedDatabase/privateEndpoint:PrivateEndpoint',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            compartment_id: Optional[pulumi.Input[str]] = None,
+            defined_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+            description: Optional[pulumi.Input[str]] = None,
+            display_name: Optional[pulumi.Input[str]] = None,
+            freeform_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+            lifecycle_state_details: Optional[pulumi.Input[str]] = None,
+            nsg_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+            private_ip: Optional[pulumi.Input[str]] = None,
+            proxy_compute_instance_id: Optional[pulumi.Input[str]] = None,
+            reinstate_proxy_instance_trigger: Optional[pulumi.Input[int]] = None,
+            sharded_databases: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
+            state: Optional[pulumi.Input[str]] = None,
+            subnet_id: Optional[pulumi.Input[str]] = None,
+            system_tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+            time_created: Optional[pulumi.Input[str]] = None,
+            time_updated: Optional[pulumi.Input[str]] = None,
+            vcn_id: Optional[pulumi.Input[str]] = None) -> 'PrivateEndpoint':
+        """
+        Get an existing PrivateEndpoint resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] compartment_id: (Updatable) Identifier of the compartment where private endpoint is to be created.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] defined_tags: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
+        :param pulumi.Input[str] description: (Updatable) PrivateEndpoint description.
+        :param pulumi.Input[str] display_name: (Updatable) Private endpoint display name.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] freeform_tags: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
+        :param pulumi.Input[str] lifecycle_state_details: Detailed message for the lifecycle state.
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] nsg_ids: (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
+        :param pulumi.Input[str] private_ip: IP address of the Private Endpoint.
+        :param pulumi.Input[str] proxy_compute_instance_id: The identifier of the proxy compute instance.
+        :param pulumi.Input[int] reinstate_proxy_instance_trigger: (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.
+               
+               
+               ** 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
+        :param pulumi.Input[Sequence[pulumi.Input[str]]] sharded_databases: The OCIDs of sharded databases that consumes the given private endpoint.
+        :param pulumi.Input[str] state: Lifecycle states for private endpoint.
+        :param pulumi.Input[str] subnet_id: Identifier of the customer subnet against which private endpoint is to be created.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] system_tags: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`
+        :param pulumi.Input[str] time_created: The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
+        :param pulumi.Input[str] time_updated: The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
+        :param pulumi.Input[str] vcn_id: Identifier of the VCN in which subnet exists.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _PrivateEndpointState.__new__(_PrivateEndpointState)
+
+        __props__.__dict__["compartment_id"] = compartment_id
+        __props__.__dict__["defined_tags"] = defined_tags
+        __props__.__dict__["description"] = description
+        __props__.__dict__["display_name"] = display_name
+        __props__.__dict__["freeform_tags"] = freeform_tags
+        __props__.__dict__["lifecycle_state_details"] = lifecycle_state_details
+        __props__.__dict__["nsg_ids"] = nsg_ids
+        __props__.__dict__["private_ip"] = private_ip
+        __props__.__dict__["proxy_compute_instance_id"] = proxy_compute_instance_id
+        __props__.__dict__["reinstate_proxy_instance_trigger"] = reinstate_proxy_instance_trigger
+        __props__.__dict__["sharded_databases"] = sharded_databases
+        __props__.__dict__["state"] = state
+        __props__.__dict__["subnet_id"] = subnet_id
+        __props__.__dict__["system_tags"] = system_tags
+        __props__.__dict__["time_created"] = time_created
+        __props__.__dict__["time_updated"] = time_updated
+        __props__.__dict__["vcn_id"] = vcn_id
+        return PrivateEndpoint(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="compartmentId")
+    def compartment_id(self) -> pulumi.Output[str]:
+        """
+        (Updatable) Identifier of the compartment where private endpoint is to be created.
+        """
+        return pulumi.get(self, "compartment_id")
+
+    @property
+    @pulumi.getter(name="definedTags")
+    def defined_tags(self) -> pulumi.Output[Mapping[str, str]]:
+        """
+        (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
+        """
+        return pulumi.get(self, "defined_tags")
+
+    @property
+    @pulumi.getter
+    def description(self) -> pulumi.Output[str]:
+        """
+        (Updatable) PrivateEndpoint description.
+        """
+        return pulumi.get(self, "description")
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> pulumi.Output[str]:
+        """
+        (Updatable) Private endpoint display name.
+        """
+        return pulumi.get(self, "display_name")
+
+    @property
+    @pulumi.getter(name="freeformTags")
+    def freeform_tags(self) -> pulumi.Output[Mapping[str, str]]:
+        """
+        (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
+        """
+        return pulumi.get(self, "freeform_tags")
+
+    @property
+    @pulumi.getter(name="lifecycleStateDetails")
+    def lifecycle_state_details(self) -> pulumi.Output[str]:
+        """
+        Detailed message for the lifecycle state.
+        """
+        return pulumi.get(self, "lifecycle_state_details")
+
+    @property
+    @pulumi.getter(name="nsgIds")
+    def nsg_ids(self) -> pulumi.Output[Sequence[str]]:
+        """
+        (Updatable) The OCIDs of the network security groups that the private endpoint belongs to.
+        """
+        return pulumi.get(self, "nsg_ids")
+
+    @property
+    @pulumi.getter(name="privateIp")
+    def private_ip(self) -> pulumi.Output[str]:
+        """
+        IP address of the Private Endpoint.
+        """
+        return pulumi.get(self, "private_ip")
+
+    @property
+    @pulumi.getter(name="proxyComputeInstanceId")
+    def proxy_compute_instance_id(self) -> pulumi.Output[str]:
+        """
+        The identifier of the proxy compute instance.
+        """
+        return pulumi.get(self, "proxy_compute_instance_id")
+
+    @property
+    @pulumi.getter(name="reinstateProxyInstanceTrigger")
+    def reinstate_proxy_instance_trigger(self) -> pulumi.Output[Optional[int]]:
+        """
+        (Updatable) An optional property when incremented triggers Reinstate Proxy Instance. Could be set to any integer value.
+
+
+        ** 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
+        """
+        return pulumi.get(self, "reinstate_proxy_instance_trigger")
+
+    @property
+    @pulumi.getter(name="shardedDatabases")
+    def sharded_databases(self) -> pulumi.Output[Sequence[str]]:
+        """
+        The OCIDs of sharded databases that consumes the given private endpoint.
+        """
+        return pulumi.get(self, "sharded_databases")
+
+    @property
+    @pulumi.getter
+    def state(self) -> pulumi.Output[str]:
+        """
+        Lifecycle states for private endpoint.
+        """
+        return pulumi.get(self, "state")
+
+    @property
+    @pulumi.getter(name="subnetId")
+    def subnet_id(self) -> pulumi.Output[str]:
+        """
+        Identifier of the customer subnet against which private endpoint is to be created.
+        """
+        return pulumi.get(self, "subnet_id")
+
+    @property
+    @pulumi.getter(name="systemTags")
+    def system_tags(self) -> pulumi.Output[Mapping[str, str]]:
+        """
+        Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`
+        """
+        return pulumi.get(self, "system_tags")
+
+    @property
+    @pulumi.getter(name="timeCreated")
+    def time_created(self) -> pulumi.Output[str]:
+        """
+        The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
+        """
+        return pulumi.get(self, "time_created")
+
+    @property
+    @pulumi.getter(name="timeUpdated")
+    def time_updated(self) -> pulumi.Output[str]:
+        """
+        The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
+        """
+        return pulumi.get(self, "time_updated")
+
+    @property
+    @pulumi.getter(name="vcnId")
+    def vcn_id(self) -> pulumi.Output[str]:
+        """
+        Identifier of the VCN in which subnet exists.
+        """
+        return pulumi.get(self, "vcn_id")
+