Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DatabaseToolsPrivateEndpointSummary

Summary of the Database Tools private endpoint.

Properties

Optional additionalFqdns

additionalFqdns: Array<string>

A list of additional FQDNs that can be also be used for the private endpoint.

compartmentId

compartmentId: string

The OCID of the compartment containing the private endpoint.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

A description of the Database Tools private endpoint.

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional endpointFqdn

endpointFqdn: undefined | string

Then FQDN to use for the private endpoint.

endpointServiceId

endpointServiceId: string

The OCID of the Database Tools Endpoint Service.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

The OCID of the Database Tools private endpoint.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

lifecycleState

lifecycleState: LifecycleState

The current state of the Database Tools private endpoint.

Optional locks

Locks associated with this resource.

Optional nsgIds

nsgIds: Array<string>

The OCID of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.

Optional privateEndpointIp

privateEndpointIp: undefined | string

The private IP address that represents the access point for the associated endpoint service.

Optional privateEndpointVnicId

privateEndpointVnicId: undefined | string

The OCID of the private endpoint's VNIC.

Optional reverseConnectionConfiguration

reverseConnectionConfiguration: model.DatabaseToolsPrivateEndpointReverseConnectionConfiguration

subnetId

subnetId: string

The OCID of the subnet that the private endpoint belongs to.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string.

timeUpdated

timeUpdated: Date

The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string.

Optional vcnId

vcnId: undefined | string

The OCID of the VCN that the private endpoint belongs to.

Functions

getDeserializedJsonObj

getJsonObj