DistributedDatabasePrivateEndpoint

class oci.distributed_database.models.DistributedDatabasePrivateEndpoint(**kwargs)

Bases: object

DistributedDatabasePrivateEndpoint resource.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a DistributedDatabasePrivateEndpoint.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a DistributedDatabasePrivateEndpoint.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a DistributedDatabasePrivateEndpoint.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a DistributedDatabasePrivateEndpoint.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a DistributedDatabasePrivateEndpoint.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a DistributedDatabasePrivateEndpoint.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a DistributedDatabasePrivateEndpoint.

compartment_id

[Required] Gets the compartment_id of this DistributedDatabasePrivateEndpoint.

defined_tags

Gets the defined_tags of this DistributedDatabasePrivateEndpoint.

description

Gets the description of this DistributedDatabasePrivateEndpoint.

display_name

[Required] Gets the display_name of this DistributedDatabasePrivateEndpoint.

freeform_tags

Gets the freeform_tags of this DistributedDatabasePrivateEndpoint.

id

[Required] Gets the id of this DistributedDatabasePrivateEndpoint.

lifecycle_details

Gets the lifecycle_details of this DistributedDatabasePrivateEndpoint.

lifecycle_state

[Required] Gets the lifecycle_state of this DistributedDatabasePrivateEndpoint.

private_ip

Gets the private_ip of this DistributedDatabasePrivateEndpoint.

proxy_compute_instance_id

Gets the proxy_compute_instance_id of this DistributedDatabasePrivateEndpoint.

subnet_id

[Required] Gets the subnet_id of this DistributedDatabasePrivateEndpoint.

system_tags

Gets the system_tags of this DistributedDatabasePrivateEndpoint.

time_created

[Required] Gets the time_created of this DistributedDatabasePrivateEndpoint.

time_updated

[Required] Gets the time_updated of this DistributedDatabasePrivateEndpoint.

vcn_id

[Required] Gets the vcn_id of this DistributedDatabasePrivateEndpoint.

vcn_nsg_ids

Gets the vcn_nsg_ids of this DistributedDatabasePrivateEndpoint.

Methods:

__init__(**kwargs)

Initializes a new DistributedDatabasePrivateEndpoint object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new DistributedDatabasePrivateEndpoint 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 DistributedDatabasePrivateEndpoint.

  • compartment_id (str) – The value to assign to the compartment_id property of this DistributedDatabasePrivateEndpoint.

  • subnet_id (str) – The value to assign to the subnet_id property of this DistributedDatabasePrivateEndpoint.

  • vcn_id (str) – The value to assign to the vcn_id property of this DistributedDatabasePrivateEndpoint.

  • display_name (str) – The value to assign to the display_name property of this DistributedDatabasePrivateEndpoint.

  • description (str) – The value to assign to the description property of this DistributedDatabasePrivateEndpoint.

  • private_ip (str) – The value to assign to the private_ip property of this DistributedDatabasePrivateEndpoint.

  • vcn_nsg_ids (list[oci.distributed_database.models.VcnNsgIdsDetails]) – The value to assign to the vcn_nsg_ids property of this DistributedDatabasePrivateEndpoint.

  • time_created (datetime) – The value to assign to the time_created property of this DistributedDatabasePrivateEndpoint.

  • time_updated (datetime) – The value to assign to the time_updated property of this DistributedDatabasePrivateEndpoint.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DistributedDatabasePrivateEndpoint. Allowed values for this property are: “ACTIVE”, “FAILED”, “INACTIVE”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, ‘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 DistributedDatabasePrivateEndpoint.

  • proxy_compute_instance_id (str) – The value to assign to the proxy_compute_instance_id property of this DistributedDatabasePrivateEndpoint.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DistributedDatabasePrivateEndpoint.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DistributedDatabasePrivateEndpoint.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DistributedDatabasePrivateEndpoint.

property compartment_id

[Required] Gets the compartment_id of this DistributedDatabasePrivateEndpoint. Identifier of the compartment in which private endpoint exists.

Returns

The compartment_id of this DistributedDatabasePrivateEndpoint.

Return type

str

property defined_tags

Gets the defined_tags of this DistributedDatabasePrivateEndpoint. 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 DistributedDatabasePrivateEndpoint.

Return type

dict(str, dict(str, object))

property description

Gets the description of this DistributedDatabasePrivateEndpoint. DistributedDatabasePrivateEndpoint description.

Returns

The description of this DistributedDatabasePrivateEndpoint.

Return type

str

property display_name

[Required] Gets the display_name of this DistributedDatabasePrivateEndpoint. DistributedDatabasePrivateEndpoint display name.

Returns

The display_name of this DistributedDatabasePrivateEndpoint.

Return type

str

property freeform_tags

Gets the freeform_tags of this DistributedDatabasePrivateEndpoint. 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 DistributedDatabasePrivateEndpoint.

Return type

dict(str, str)

property id

[Required] Gets the id of this DistributedDatabasePrivateEndpoint. The identifier of the Private Endpoint.

Returns

The id of this DistributedDatabasePrivateEndpoint.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this DistributedDatabasePrivateEndpoint. Detailed message for the lifecycle state.

Returns

The lifecycle_details of this DistributedDatabasePrivateEndpoint.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this DistributedDatabasePrivateEndpoint. Lifecycle states for private endpoint.

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

Returns

The lifecycle_state of this DistributedDatabasePrivateEndpoint.

Return type

str

property private_ip

Gets the private_ip of this DistributedDatabasePrivateEndpoint. IP address of the Private Endpoint.

Returns

The private_ip of this DistributedDatabasePrivateEndpoint.

Return type

str

property proxy_compute_instance_id

Gets the proxy_compute_instance_id of this DistributedDatabasePrivateEndpoint. The identifier of the proxy compute instance.

Returns

The proxy_compute_instance_id of this DistributedDatabasePrivateEndpoint.

Return type

str

property subnet_id

[Required] Gets the subnet_id of this DistributedDatabasePrivateEndpoint. Identifier of the subnet in which private endpoint exists.

Returns

The subnet_id of this DistributedDatabasePrivateEndpoint.

Return type

str

property system_tags

Gets the system_tags of this DistributedDatabasePrivateEndpoint. 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 DistributedDatabasePrivateEndpoint.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this DistributedDatabasePrivateEndpoint.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this DistributedDatabasePrivateEndpoint. The time the Private Endpoint was last updated. An RFC3339 formatted datetime string

Returns

The time_updated of this DistributedDatabasePrivateEndpoint.

Return type

datetime

property vcn_id

[Required] Gets the vcn_id of this DistributedDatabasePrivateEndpoint. Identifier of the VCN in which subnet exists.

Returns

The vcn_id of this DistributedDatabasePrivateEndpoint.

Return type

str

property vcn_nsg_ids

Gets the vcn_nsg_ids of this DistributedDatabasePrivateEndpoint. The list of network security group (NSG) details associated with the private endpoint.

Returns

The vcn_nsg_ids of this DistributedDatabasePrivateEndpoint.

Return type

list[oci.distributed_database.models.VcnNsgIdsDetails]