DatabaseToolsPrivateEndpointSummary

class oci.database_tools.models.DatabaseToolsPrivateEndpointSummary(**kwargs)

Bases: object

Summary of the DatabaseToolsPrivateEndpoint.

Attributes

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

Methods

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

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new DatabaseToolsPrivateEndpointSummary 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 DatabaseToolsPrivateEndpointSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsPrivateEndpointSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsPrivateEndpointSummary.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsPrivateEndpointSummary.
  • display_name (str) – The value to assign to the display_name property of this DatabaseToolsPrivateEndpointSummary.
  • description (str) – The value to assign to the description property of this DatabaseToolsPrivateEndpointSummary.
  • id (str) – The value to assign to the id property of this DatabaseToolsPrivateEndpointSummary.
  • endpoint_service_id (str) – The value to assign to the endpoint_service_id property of this DatabaseToolsPrivateEndpointSummary.
  • time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsPrivateEndpointSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsPrivateEndpointSummary.
  • vcn_id (str) – The value to assign to the vcn_id property of this DatabaseToolsPrivateEndpointSummary.
  • subnet_id (str) – The value to assign to the subnet_id property of this DatabaseToolsPrivateEndpointSummary.
  • private_endpoint_vnic_id (str) – The value to assign to the private_endpoint_vnic_id property of this DatabaseToolsPrivateEndpointSummary.
  • private_endpoint_ip (str) – The value to assign to the private_endpoint_ip property of this DatabaseToolsPrivateEndpointSummary.
  • endpoint_fqdn (str) – The value to assign to the endpoint_fqdn property of this DatabaseToolsPrivateEndpointSummary.
  • additional_fqdns (list[str]) – The value to assign to the additional_fqdns property of this DatabaseToolsPrivateEndpointSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsPrivateEndpointSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘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 DatabaseToolsPrivateEndpointSummary.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this DatabaseToolsPrivateEndpointSummary.
  • reverse_connection_configuration (oci.database_tools.models.DatabaseToolsPrivateEndpointReverseConnectionConfiguration) – The value to assign to the reverse_connection_configuration property of this DatabaseToolsPrivateEndpointSummary.
additional_fqdns

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

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

[Required] Gets the compartment_id of this DatabaseToolsPrivateEndpointSummary. The OCID of the containing Compartment.

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

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

Gets the description of this DatabaseToolsPrivateEndpointSummary. A description of the DatabaseToolsPrivateEndpoint.

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

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

Returns:The display_name of this DatabaseToolsPrivateEndpointSummary.
Return type:str
endpoint_fqdn

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

Returns:The endpoint_fqdn of this DatabaseToolsPrivateEndpointSummary.
Return type:str
endpoint_service_id

[Required] Gets the endpoint_service_id of this DatabaseToolsPrivateEndpointSummary. The OCID of the DatabaseToolsEndpointService.

Returns:The endpoint_service_id of this DatabaseToolsPrivateEndpointSummary.
Return type:str
freeform_tags

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

[Required] Gets the id of this DatabaseToolsPrivateEndpointSummary. The OCID of the DatabaseToolsPrivateEndpoint.

Returns:The id of this DatabaseToolsPrivateEndpointSummary.
Return type:str
lifecycle_details

Gets the lifecycle_details of this DatabaseToolsPrivateEndpointSummary. 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 DatabaseToolsPrivateEndpointSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this DatabaseToolsPrivateEndpointSummary. The current state of the DatabaseToolsPrivateEndpoint.

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

Returns:The lifecycle_state of this DatabaseToolsPrivateEndpointSummary.
Return type:str
nsg_ids

Gets the nsg_ids of this DatabaseToolsPrivateEndpointSummary. 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 DatabaseToolsPrivateEndpointSummary.
Return type:list[str]
private_endpoint_ip

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

Returns:The private_endpoint_ip of this DatabaseToolsPrivateEndpointSummary.
Return type:str
private_endpoint_vnic_id

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

Returns:The private_endpoint_vnic_id of this DatabaseToolsPrivateEndpointSummary.
Return type:str
reverse_connection_configuration

Gets the reverse_connection_configuration of this DatabaseToolsPrivateEndpointSummary.

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

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

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

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

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

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

[Required] Gets the time_updated of this DatabaseToolsPrivateEndpointSummary. The time the DatabaseToolsPrivateEndpoint was updated. An RFC3339 formatted datetime string

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

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

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