Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PrivateEndpoint

A private endpoint makes your service accessible through a private IP in the customer's private network. A private endpoint has a name and is associated with a namespace and a single compartment.

Properties

accessTargets

accessTargets: Array<AccessTargetDetails>

A list of targets that can be accessed by the private endpoint. At least one or more access targets is required for a private endpoint.

Optional additionalPrefixes

additionalPrefixes: Array<string>

A list of additional prefix that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.

compartmentId

compartmentId: string

The compartment which is associated with the Private Endpoint.

createdBy

createdBy: string

The OCID of the user who created the Private Endpoint.

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"}}}

etag

etag: string

The entity tag (ETag) for the Private Endpoint.

fqdns

fqdns: Fqdns

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"}}

Optional id

id: undefined | string

The OCID of the PrivateEndpoint.

Optional lifecycleState

lifecycleState: LifecycleState

The Private Endpoint's lifecycle state.

name

name: string

This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. Example: my-new-private-endpoint1

namespace

namespace: string

The Object Storage namespace associated with the private enpoint.

Optional nsgIds

nsgIds: Array<string>

A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see NetworkSecurityGroup.

prefix

prefix: string

A prefix to use for the private endpoint. The customer VCN's DNS records are updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn. Example: If the prefix chosen is "abc", then the endpointFqdn will be 'abc.private.objectstorage..oraclecloud.com'

privateEndpointIp

privateEndpointIp: string

The private IP address to assign to this private endpoint. If you provide a value, it must be an available IP address in the customer's subnet. If it's not available, an error is returned.

If you do not provide a value, an available IP address in the subnet is automatically chosen.

subnetId

subnetId: string

The OCID of the customer's subnet where the private endpoint VNIC will reside.

timeCreated

timeCreated: Date

The date and time the Private Endpoint was created, as described in RFC 2616.

timeModified

timeModified: Date

The date and time the Private Endpoint was updated, as described in RFC 2616.

Functions

getDeserializedJsonObj

getJsonObj