DbManagementPrivateEndpoint

class oci.database_management.models.DbManagementPrivateEndpoint(**kwargs)

Bases: object

A Database Management private endpoint allows Database Management to connect to databases in a Virtual Cloud Network (VCN).

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a DbManagementPrivateEndpoint.
compartment_id [Required] Gets the compartment_id of this DbManagementPrivateEndpoint.
description Gets the description of this DbManagementPrivateEndpoint.
id [Required] Gets the id of this DbManagementPrivateEndpoint.
is_cluster Gets the is_cluster of this DbManagementPrivateEndpoint.
lifecycle_state Gets the lifecycle_state of this DbManagementPrivateEndpoint.
name [Required] Gets the name of this DbManagementPrivateEndpoint.
nsg_ids Gets the nsg_ids of this DbManagementPrivateEndpoint.
private_ip Gets the private_ip of this DbManagementPrivateEndpoint.
subnet_id [Required] Gets the subnet_id of this DbManagementPrivateEndpoint.
time_created Gets the time_created of this DbManagementPrivateEndpoint.
vcn_id [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.
  • 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.
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
description

Gets the description of this DbManagementPrivateEndpoint. The description of the Database Management private endpoint.

Returns:The description of this DbManagementPrivateEndpoint.
Return type:str
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
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
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
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
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]
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
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
time_created

Gets the time_created of this DbManagementPrivateEndpoint. The date and time the Database Managament private endpoint was created, in the format defined by RFC3339.

Returns:The time_created of this DbManagementPrivateEndpoint.
Return type:datetime
vcn_id

[Required] Gets the vcn_id of this DbManagementPrivateEndpoint. The OCID of the VCN.

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