DbManagementPrivateEndpoint¶
- class oci.database_management.models.DbManagementPrivateEndpoint(**kwargs)¶
Bases:
objectA Database Management private endpoint allows Database Management to connect to databases in a Virtual Cloud Network (VCN).
Attributes:
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
[Required] Gets the compartment_id of this DbManagementPrivateEndpoint.
Gets the defined_tags of this DbManagementPrivateEndpoint.
Gets the description of this DbManagementPrivateEndpoint.
Gets the freeform_tags of this DbManagementPrivateEndpoint.
[Required] Gets the id of this DbManagementPrivateEndpoint.
Gets the is_cluster of this DbManagementPrivateEndpoint.
Gets the is_dns_resolution_enabled of this DbManagementPrivateEndpoint.
Gets the lifecycle_state of this DbManagementPrivateEndpoint.
[Required] Gets the name of this DbManagementPrivateEndpoint.
Gets the nsg_ids of this DbManagementPrivateEndpoint.
Gets the private_ip of this DbManagementPrivateEndpoint.
Gets the security_attributes of this DbManagementPrivateEndpoint.
[Required] Gets the subnet_id of this DbManagementPrivateEndpoint.
Gets the system_tags of this DbManagementPrivateEndpoint.
Gets the time_created of this DbManagementPrivateEndpoint.
[Required] Gets the vcn_id of this DbManagementPrivateEndpoint.
Methods:
__init__(**kwargs)Initializes a new DbManagementPrivateEndpoint object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new DbManagementPrivateEndpoint 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 DbManagementPrivateEndpoint.
name (str) – The value to assign to the name property of this DbManagementPrivateEndpoint.
compartment_id (str) – The value to assign to the compartment_id property of this DbManagementPrivateEndpoint.
is_cluster (bool) – The value to assign to the is_cluster property of this DbManagementPrivateEndpoint.
is_dns_resolution_enabled (bool) – The value to assign to the is_dns_resolution_enabled property of this DbManagementPrivateEndpoint.
vcn_id (str) – The value to assign to the vcn_id property of this DbManagementPrivateEndpoint.
subnet_id (str) – The value to assign to the subnet_id property of this DbManagementPrivateEndpoint.
private_ip (str) – The value to assign to the private_ip property of this DbManagementPrivateEndpoint.
description (str) – The value to assign to the description property of this DbManagementPrivateEndpoint.
time_created (datetime) – The value to assign to the time_created property of this DbManagementPrivateEndpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DbManagementPrivateEndpoint. 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’.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this DbManagementPrivateEndpoint.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DbManagementPrivateEndpoint.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DbManagementPrivateEndpoint.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DbManagementPrivateEndpoint.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this DbManagementPrivateEndpoint.
- property compartment_id¶
[Required] Gets the compartment_id of this DbManagementPrivateEndpoint. The OCID of the compartment.
- Returns
The compartment_id of this DbManagementPrivateEndpoint.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this DbManagementPrivateEndpoint. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The defined_tags of this DbManagementPrivateEndpoint.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this DbManagementPrivateEndpoint. The description of the Database Management private endpoint.
- Returns
The description of this DbManagementPrivateEndpoint.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this DbManagementPrivateEndpoint. 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: {“Department”: “Finance”}
- Returns
The freeform_tags of this DbManagementPrivateEndpoint.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DbManagementPrivateEndpoint. The OCID of the Database Management private endpoint.
- Returns
The id of this DbManagementPrivateEndpoint.
- Return type
str
- property is_cluster¶
Gets the is_cluster of this DbManagementPrivateEndpoint. Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster.
- Returns
The is_cluster of this DbManagementPrivateEndpoint.
- Return type
bool
- property is_dns_resolution_enabled¶
Gets the is_dns_resolution_enabled of this DbManagementPrivateEndpoint. Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
- Returns
The is_dns_resolution_enabled of this DbManagementPrivateEndpoint.
- Return type
bool
- property lifecycle_state¶
Gets the lifecycle_state of this DbManagementPrivateEndpoint. The current lifecycle state of the Database Management private endpoint.
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 DbManagementPrivateEndpoint.
- Return type
str
- property name¶
[Required] Gets the name of this DbManagementPrivateEndpoint. The display name of the Database Management private endpoint.
- Returns
The name of this DbManagementPrivateEndpoint.
- Return type
str
- property nsg_ids¶
Gets the nsg_ids of this DbManagementPrivateEndpoint. The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
- Returns
The nsg_ids of this DbManagementPrivateEndpoint.
- Return type
list[str]
- property private_ip¶
Gets the private_ip of this DbManagementPrivateEndpoint. The IP addresses assigned to the Database Management private endpoint.
- Returns
The private_ip of this DbManagementPrivateEndpoint.
- Return type
str
- property security_attributes¶
Gets the security_attributes of this DbManagementPrivateEndpoint. Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}
- Returns
The security_attributes of this DbManagementPrivateEndpoint.
- Return type
dict(str, dict(str, object))
- property subnet_id¶
[Required] Gets the subnet_id of this DbManagementPrivateEndpoint. The OCID of the subnet.
- Returns
The subnet_id of this DbManagementPrivateEndpoint.
- Return type
str
- property system_tags¶
Gets the system_tags of this DbManagementPrivateEndpoint. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this DbManagementPrivateEndpoint.
- Return type
dict(str, dict(str, object))