PrivateEndpoint

class oci.globally_distributed_database.models.PrivateEndpoint(**kwargs)

Bases: object

PrivateEndpoint resource.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
compartment_id [Required] Gets the compartment_id of this PrivateEndpoint.
defined_tags Gets the defined_tags of this PrivateEndpoint.
description Gets the description of this PrivateEndpoint.
display_name [Required] Gets the display_name of this PrivateEndpoint.
freeform_tags Gets the freeform_tags of this PrivateEndpoint.
id [Required] Gets the id of this PrivateEndpoint.
lifecycle_state [Required] Gets the lifecycle_state of this PrivateEndpoint.
lifecycle_state_details Gets the lifecycle_state_details of this PrivateEndpoint.
nsg_ids Gets the nsg_ids of this PrivateEndpoint.
private_ip Gets the private_ip of this PrivateEndpoint.
proxy_compute_instance_id Gets the proxy_compute_instance_id of this PrivateEndpoint.
sharded_databases Gets the sharded_databases of this PrivateEndpoint.
subnet_id [Required] Gets the subnet_id of this PrivateEndpoint.
system_tags Gets the system_tags of this PrivateEndpoint.
time_created [Required] Gets the time_created of this PrivateEndpoint.
time_updated [Required] Gets the time_updated of this PrivateEndpoint.
vcn_id [Required] Gets the vcn_id of this PrivateEndpoint.

Methods

__init__(**kwargs) Initializes a new PrivateEndpoint object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “UPDATING”

__init__(**kwargs)

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

Parameters:
  • id (str) – The value to assign to the id property of this PrivateEndpoint.
  • compartment_id (str) – The value to assign to the compartment_id property of this PrivateEndpoint.
  • subnet_id (str) – The value to assign to the subnet_id property of this PrivateEndpoint.
  • vcn_id (str) – The value to assign to the vcn_id property of this PrivateEndpoint.
  • display_name (str) – The value to assign to the display_name property of this PrivateEndpoint.
  • description (str) – The value to assign to the description property of this PrivateEndpoint.
  • private_ip (str) – The value to assign to the private_ip property of this PrivateEndpoint.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this PrivateEndpoint.
  • sharded_databases (list[str]) – The value to assign to the sharded_databases property of this PrivateEndpoint.
  • time_created (datetime) – The value to assign to the time_created property of this PrivateEndpoint.
  • time_updated (datetime) – The value to assign to the time_updated property of this PrivateEndpoint.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this PrivateEndpoint. Allowed values for this property are: “ACTIVE”, “FAILED”, “INACTIVE”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this PrivateEndpoint.
  • proxy_compute_instance_id (str) – The value to assign to the proxy_compute_instance_id property of this PrivateEndpoint.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PrivateEndpoint.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PrivateEndpoint.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PrivateEndpoint.
compartment_id

[Required] Gets the compartment_id of this PrivateEndpoint. Identifier of the compartment in which private endpoint exists.

Returns:The compartment_id of this PrivateEndpoint.
Return type:str
defined_tags

Gets the defined_tags of this PrivateEndpoint. 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 PrivateEndpoint.
Return type:dict(str, dict(str, object))
description

Gets the description of this PrivateEndpoint. PrivateEndpoint description.

Returns:The description of this PrivateEndpoint.
Return type:str
display_name

[Required] Gets the display_name of this PrivateEndpoint. PrivateEndpoint display name.

Returns:The display_name of this PrivateEndpoint.
Return type:str
freeform_tags

Gets the freeform_tags of this PrivateEndpoint. 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 PrivateEndpoint.
Return type:dict(str, str)
id

[Required] Gets the id of this PrivateEndpoint. The identifier of the Private Endpoint.

Returns:The id of this PrivateEndpoint.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this PrivateEndpoint. Lifecycle states for private endpoint.

Allowed values for this property are: “ACTIVE”, “FAILED”, “INACTIVE”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this PrivateEndpoint.
Return type:str
lifecycle_state_details

Gets the lifecycle_state_details of this PrivateEndpoint. Detailed message for the lifecycle state.

Returns:The lifecycle_state_details of this PrivateEndpoint.
Return type:str
nsg_ids

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

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

Gets the private_ip of this PrivateEndpoint. IP address of the Private Endpoint.

Returns:The private_ip of this PrivateEndpoint.
Return type:str
proxy_compute_instance_id

Gets the proxy_compute_instance_id of this PrivateEndpoint. The identifier of the proxy compute instance.

Returns:The proxy_compute_instance_id of this PrivateEndpoint.
Return type:str
sharded_databases

Gets the sharded_databases of this PrivateEndpoint. The OCIDs of sharded databases that consumes the given private endpoint.

Returns:The sharded_databases of this PrivateEndpoint.
Return type:list[str]
subnet_id

[Required] Gets the subnet_id of this PrivateEndpoint. Identifier of the subnet in which private endpoint exists.

Returns:The subnet_id of this PrivateEndpoint.
Return type:str
system_tags

Gets the system_tags of this PrivateEndpoint. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:The system_tags of this PrivateEndpoint.
Return type:dict(str, dict(str, object))
time_created

[Required] Gets the time_created of this PrivateEndpoint. The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string

Returns:The time_created of this PrivateEndpoint.
Return type:datetime
time_updated

[Required] Gets the time_updated of this PrivateEndpoint. The time the Private Endpoint was last updated. An RFC3339 formatted datetime string

Returns:The time_updated of this PrivateEndpoint.
Return type:datetime
vcn_id

[Required] Gets the vcn_id of this PrivateEndpoint. Identifier of the VCN in which subnet exists.

Returns:The vcn_id of this PrivateEndpoint.
Return type:str