OperationsInsightsPrivateEndpoint¶

class oci.opsi.models.OperationsInsightsPrivateEndpoint(**kwargs)¶

Bases: object

A private endpoint that allows Operation Insights services 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 OperationsInsightsPrivateEndpoint.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OperationsInsightsPrivateEndpoint.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OperationsInsightsPrivateEndpoint.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OperationsInsightsPrivateEndpoint.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OperationsInsightsPrivateEndpoint.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a OperationsInsightsPrivateEndpoint.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OperationsInsightsPrivateEndpoint.
`compartment_id`	[Required] Gets the compartment_id of this OperationsInsightsPrivateEndpoint.
`defined_tags`	Gets the defined_tags of this OperationsInsightsPrivateEndpoint.
`description`	Gets the description of this OperationsInsightsPrivateEndpoint.
`display_name`	[Required] Gets the display_name of this OperationsInsightsPrivateEndpoint.
`freeform_tags`	Gets the freeform_tags of this OperationsInsightsPrivateEndpoint.
`id`	[Required] Gets the id of this OperationsInsightsPrivateEndpoint.
`is_used_for_rac_dbs`	Gets the is_used_for_rac_dbs of this OperationsInsightsPrivateEndpoint.
`lifecycle_details`	Gets the lifecycle_details of this OperationsInsightsPrivateEndpoint.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OperationsInsightsPrivateEndpoint.
`nsg_ids`	Gets the nsg_ids of this OperationsInsightsPrivateEndpoint.
`private_endpoint_status_details`	Gets the private_endpoint_status_details of this OperationsInsightsPrivateEndpoint.
`private_ip`	Gets the private_ip of this OperationsInsightsPrivateEndpoint.
`subnet_id`	[Required] Gets the subnet_id of this OperationsInsightsPrivateEndpoint.
`system_tags`	Gets the system_tags of this OperationsInsightsPrivateEndpoint.
`time_created`	Gets the time_created of this OperationsInsightsPrivateEndpoint.
`vcn_id`	[Required] Gets the vcn_id of this OperationsInsightsPrivateEndpoint.

Methods

__init__(**kwargs) Initializes a new OperationsInsightsPrivateEndpoint object with values from keyword arguments.

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

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

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

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

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a OperationsInsightsPrivateEndpoint. This constant has a value of “NEEDS_ATTENTION”

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

__init__(**kwargs)¶

Initializes a new OperationsInsightsPrivateEndpoint 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 OperationsInsightsPrivateEndpoint.
display_name (str) – The value to assign to the display_name property of this OperationsInsightsPrivateEndpoint.
compartment_id (str) – The value to assign to the compartment_id property of this OperationsInsightsPrivateEndpoint.
vcn_id (str) – The value to assign to the vcn_id property of this OperationsInsightsPrivateEndpoint.
subnet_id (str) – The value to assign to the subnet_id property of this OperationsInsightsPrivateEndpoint.
private_ip (str) – The value to assign to the private_ip property of this OperationsInsightsPrivateEndpoint.
description (str) – The value to assign to the description property of this OperationsInsightsPrivateEndpoint.
time_created (datetime) – The value to assign to the time_created property of this OperationsInsightsPrivateEndpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OperationsInsightsPrivateEndpoint. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘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 OperationsInsightsPrivateEndpoint.
private_endpoint_status_details (str) – The value to assign to the private_endpoint_status_details property of this OperationsInsightsPrivateEndpoint.
is_used_for_rac_dbs (bool) – The value to assign to the is_used_for_rac_dbs property of this OperationsInsightsPrivateEndpoint.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this OperationsInsightsPrivateEndpoint.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OperationsInsightsPrivateEndpoint.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OperationsInsightsPrivateEndpoint.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OperationsInsightsPrivateEndpoint.

compartment_id¶

[Required] Gets the compartment_id of this OperationsInsightsPrivateEndpoint. The compartment OCID of the Private service accessed database.

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

defined_tags¶

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

description¶

Gets the description of this OperationsInsightsPrivateEndpoint. The description of the private endpoint.

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

display_name¶

[Required] Gets the display_name of this OperationsInsightsPrivateEndpoint. The display name of the private endpoint.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this OperationsInsightsPrivateEndpoint. The OCID of the Private service accessed database.

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

is_used_for_rac_dbs¶

Gets the is_used_for_rac_dbs of this OperationsInsightsPrivateEndpoint. The flag is to identify if private endpoint is used for rac database or not. This flag is deprecated and no longer is used.

Returns:	The is_used_for_rac_dbs of this OperationsInsightsPrivateEndpoint.
Return type:	bool

lifecycle_details¶

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this OperationsInsightsPrivateEndpoint. The current state of the private endpoint.

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

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

nsg_ids¶

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

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

private_endpoint_status_details¶

Gets the private_endpoint_status_details of this OperationsInsightsPrivateEndpoint. A message describing the status of the private endpoint connection of this resource. For example, it can be used to provide actionable information about the validity of the private endpoint connection.

Returns:	The private_endpoint_status_details of this OperationsInsightsPrivateEndpoint.
Return type:	str

private_ip¶

Gets the private_ip of this OperationsInsightsPrivateEndpoint. The private IP addresses assigned to the private endpoint. All IP addresses will be concatenated if it is RAC DBs.

Returns:	The private_ip of this OperationsInsightsPrivateEndpoint.
Return type:	str

subnet_id¶

[Required] Gets the subnet_id of this OperationsInsightsPrivateEndpoint. The OCID of the subnet.

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

system_tags¶

Gets the system_tags of this OperationsInsightsPrivateEndpoint. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

time_created¶

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

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

vcn_id¶

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

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