Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreatePrivateEndpointDetails

Details to create a private endpoint

Properties

accessTargets

accessTargets: Array<AccessTargetDetails>

A list of targets that can be accessed by the 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 ID of the compartment in which to create 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"}}}

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

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

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'

Optional privateEndpointIp

privateEndpointIp: undefined | 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.

Functions

getDeserializedJsonObj

getJsonObj