CreatePrivateEndpointDetails¶

class oci.globally_distributed_database.models.CreatePrivateEndpointDetails(**kwargs)¶

Bases: object

Details required for private endpoint creation.

Methods

__init__(**kwargs) Initializes a new CreatePrivateEndpointDetails object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreatePrivateEndpointDetails.
`defined_tags`	Gets the defined_tags of this CreatePrivateEndpointDetails.
`description`	Gets the description of this CreatePrivateEndpointDetails.
`display_name`	[Required] Gets the display_name of this CreatePrivateEndpointDetails.
`freeform_tags`	Gets the freeform_tags of this CreatePrivateEndpointDetails.
`nsg_ids`	Gets the nsg_ids of this CreatePrivateEndpointDetails.
`subnet_id`	[Required] Gets the subnet_id of this CreatePrivateEndpointDetails.

__init__(**kwargs)¶

Initializes a new CreatePrivateEndpointDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CreatePrivateEndpointDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreatePrivateEndpointDetails.
display_name (str) – The value to assign to the display_name property of this CreatePrivateEndpointDetails.
description (str) – The value to assign to the description property of this CreatePrivateEndpointDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreatePrivateEndpointDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreatePrivateEndpointDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreatePrivateEndpointDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreatePrivateEndpointDetails. Identifier of the compartment where private endpoint is to be created.

Returns:	The compartment_id of this CreatePrivateEndpointDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreatePrivateEndpointDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreatePrivateEndpointDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreatePrivateEndpointDetails. PrivateEndpoint description.

Returns:	The description of this CreatePrivateEndpointDetails.
Return type:	str

display_name¶

[Required] Gets the display_name of this CreatePrivateEndpointDetails. Private endpoint display name.

Returns:	The display_name of this CreatePrivateEndpointDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreatePrivateEndpointDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreatePrivateEndpointDetails.
Return type:	dict(str, str)

nsg_ids¶

Gets the nsg_ids of this CreatePrivateEndpointDetails. The OCIDs of the network security groups that the private endpoint belongs to.

Returns:	The nsg_ids of this CreatePrivateEndpointDetails.
Return type:	list[str]

subnet_id¶

[Required] Gets the subnet_id of this CreatePrivateEndpointDetails. Identifier of the customer subnet against which private endpoint is to be created.

Returns:	The subnet_id of this CreatePrivateEndpointDetails.
Return type:	str