DatabaseToolsPrivateEndpoint¶

class oci.database_tools.models.DatabaseToolsPrivateEndpoint(**kwargs)¶

Bases: object

Allows the Database Tools service to connect to databases in a customer’s virtual cloud network (VCN).

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint.
`additional_fqdns`	Gets the additional_fqdns of this DatabaseToolsPrivateEndpoint.
`compartment_id`	[Required] Gets the compartment_id of this DatabaseToolsPrivateEndpoint.
`defined_tags`	Gets the defined_tags of this DatabaseToolsPrivateEndpoint.
`description`	Gets the description of this DatabaseToolsPrivateEndpoint.
`display_name`	Gets the display_name of this DatabaseToolsPrivateEndpoint.
`endpoint_fqdn`	Gets the endpoint_fqdn of this DatabaseToolsPrivateEndpoint.
`endpoint_service_id`	[Required] Gets the endpoint_service_id of this DatabaseToolsPrivateEndpoint.
`freeform_tags`	Gets the freeform_tags of this DatabaseToolsPrivateEndpoint.
`id`	[Required] Gets the id of this DatabaseToolsPrivateEndpoint.
`lifecycle_details`	Gets the lifecycle_details of this DatabaseToolsPrivateEndpoint.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DatabaseToolsPrivateEndpoint.
`locks`	Gets the locks of this DatabaseToolsPrivateEndpoint.
`nsg_ids`	Gets the nsg_ids of this DatabaseToolsPrivateEndpoint.
`private_endpoint_ip`	Gets the private_endpoint_ip of this DatabaseToolsPrivateEndpoint.
`private_endpoint_vnic_id`	Gets the private_endpoint_vnic_id of this DatabaseToolsPrivateEndpoint.
`reverse_connection_configuration`	Gets the reverse_connection_configuration of this DatabaseToolsPrivateEndpoint.
`security_attributes`	Gets the security_attributes of this DatabaseToolsPrivateEndpoint.
`subnet_id`	[Required] Gets the subnet_id of this DatabaseToolsPrivateEndpoint.
`system_tags`	Gets the system_tags of this DatabaseToolsPrivateEndpoint.
`time_created`	[Required] Gets the time_created of this DatabaseToolsPrivateEndpoint.
`time_updated`	[Required] Gets the time_updated of this DatabaseToolsPrivateEndpoint.
`vcn_id`	Gets the vcn_id of this DatabaseToolsPrivateEndpoint.

Methods:

__init__(**kwargs)

Initializes a new DatabaseToolsPrivateEndpoint object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsPrivateEndpoint. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new DatabaseToolsPrivateEndpoint 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 DatabaseToolsPrivateEndpoint.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsPrivateEndpoint.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsPrivateEndpoint.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsPrivateEndpoint.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this DatabaseToolsPrivateEndpoint.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this DatabaseToolsPrivateEndpoint.
display_name (str) – The value to assign to the display_name property of this DatabaseToolsPrivateEndpoint.
description (str) – The value to assign to the description property of this DatabaseToolsPrivateEndpoint.
id (str) – The value to assign to the id property of this DatabaseToolsPrivateEndpoint.
endpoint_service_id (str) – The value to assign to the endpoint_service_id property of this DatabaseToolsPrivateEndpoint.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsPrivateEndpoint.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsPrivateEndpoint.
vcn_id (str) – The value to assign to the vcn_id property of this DatabaseToolsPrivateEndpoint.
subnet_id (str) – The value to assign to the subnet_id property of this DatabaseToolsPrivateEndpoint.
private_endpoint_vnic_id (str) – The value to assign to the private_endpoint_vnic_id property of this DatabaseToolsPrivateEndpoint.
private_endpoint_ip (str) – The value to assign to the private_endpoint_ip property of this DatabaseToolsPrivateEndpoint.
endpoint_fqdn (str) – The value to assign to the endpoint_fqdn property of this DatabaseToolsPrivateEndpoint.
additional_fqdns (list[str]) – The value to assign to the additional_fqdns property of this DatabaseToolsPrivateEndpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsPrivateEndpoint. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseToolsPrivateEndpoint.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this DatabaseToolsPrivateEndpoint.
reverse_connection_configuration (oci.database_tools.models.DatabaseToolsPrivateEndpointReverseConnectionConfiguration) – The value to assign to the reverse_connection_configuration property of this DatabaseToolsPrivateEndpoint.

property additional_fqdns¶

Gets the additional_fqdns of this DatabaseToolsPrivateEndpoint. A list of additional FQDNs that can be also be used for the private endpoint.

Returns: The additional_fqdns of this DatabaseToolsPrivateEndpoint.
Return type: list[str]

property compartment_id¶

[Required] Gets the compartment_id of this DatabaseToolsPrivateEndpoint. The OCID of the compartment containing the Database Tools private endpoint.

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

property defined_tags¶

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

property description¶

Gets the description of this DatabaseToolsPrivateEndpoint. A description of the Database Tools private endpoint.

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

property display_name¶

Gets the display_name of this DatabaseToolsPrivateEndpoint. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

property endpoint_fqdn¶

Gets the endpoint_fqdn of this DatabaseToolsPrivateEndpoint. Then FQDN to use for the private endpoint.

Returns: The endpoint_fqdn of this DatabaseToolsPrivateEndpoint.
Return type: str

property endpoint_service_id¶

[Required] Gets the endpoint_service_id of this DatabaseToolsPrivateEndpoint. The OCID of the Database Tools Endpoint Service.

Returns: The endpoint_service_id of this DatabaseToolsPrivateEndpoint.
Return type: str

property freeform_tags¶

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

property id¶

[Required] Gets the id of this DatabaseToolsPrivateEndpoint. The OCID of the Database Tools private endpoint.

Returns: The id of this DatabaseToolsPrivateEndpoint.
Return type: str

property lifecycle_details¶

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

Returns: The lifecycle_details of this DatabaseToolsPrivateEndpoint.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this DatabaseToolsPrivateEndpoint. The current state of the Database Tools private endpoint.

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

Returns: The lifecycle_state of this DatabaseToolsPrivateEndpoint.
Return type: str

property locks¶

Gets the locks of this DatabaseToolsPrivateEndpoint. Locks associated with this resource.

Returns: The locks of this DatabaseToolsPrivateEndpoint.
Return type: list[oci.database_tools.models.ResourceLock]

property nsg_ids¶

Gets the nsg_ids of this DatabaseToolsPrivateEndpoint. The OCID of the network security groups that the private endpoint’s VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.

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

property private_endpoint_ip¶

Gets the private_endpoint_ip of this DatabaseToolsPrivateEndpoint. The private IP address that represents the access point for the associated endpoint service.

Returns: The private_endpoint_ip of this DatabaseToolsPrivateEndpoint.
Return type: str

property private_endpoint_vnic_id¶

Gets the private_endpoint_vnic_id of this DatabaseToolsPrivateEndpoint. The OCID of the private endpoint’s VNIC.

Returns: The private_endpoint_vnic_id of this DatabaseToolsPrivateEndpoint.
Return type: str

property reverse_connection_configuration¶

Gets the reverse_connection_configuration of this DatabaseToolsPrivateEndpoint.

Returns: The reverse_connection_configuration of this DatabaseToolsPrivateEndpoint.
Return type: oci.database_tools.models.DatabaseToolsPrivateEndpointReverseConnectionConfiguration

property security_attributes¶

Gets the security_attributes of this DatabaseToolsPrivateEndpoint. Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see ZPR Artifacts. Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “audit”}}}

Returns: The security_attributes of this DatabaseToolsPrivateEndpoint.
Return type: dict(str, dict(str, object))

property subnet_id¶

[Required] Gets the subnet_id of this DatabaseToolsPrivateEndpoint. The OCID of the subnet that the private endpoint belongs to.

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

property system_tags¶

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

property time_created¶

[Required] Gets the time_created of this DatabaseToolsPrivateEndpoint. The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string

Returns: The time_created of this DatabaseToolsPrivateEndpoint.
Return type: datetime

property time_updated¶

[Required] Gets the time_updated of this DatabaseToolsPrivateEndpoint. The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string

Returns: The time_updated of this DatabaseToolsPrivateEndpoint.
Return type: datetime

property vcn_id¶

Gets the vcn_id of this DatabaseToolsPrivateEndpoint. The OCID of the VCN that the private endpoint belongs to.

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