Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DataSafePrivateEndpoint

A Data Safe private endpoint that allows Data Safe to connect to databases in a customer's virtual cloud network (VCN).

Properties

compartmentId

compartmentId: string

The OCID of the compartment.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

The description of the private endpoint.

displayName

displayName: string

The display name of the private endpoint.

Optional endpointFqdn

endpointFqdn: undefined | string

The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the Data Safe private endpoint.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the private endpoint.

Optional nsgIds

nsgIds: Array<string>

The OCIDs of the network security groups that the private endpoint belongs to.

privateEndpointId

privateEndpointId: string

The OCID of the underlying private endpoint.

Optional privateEndpointIp

privateEndpointIp: undefined | string

The private IP address of the private endpoint.

subnetId

subnetId: string

The OCID of the subnet.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Optional timeCreated

timeCreated: Date

The date and time the private endpoint was created, in the format defined by RFC3339.

vcnId

vcnId: string

The OCID of the VCN.

Functions

getDeserializedJsonObj

getJsonObj