DataSafePrivateEndpoint

class oci.data_safe.models.DataSafePrivateEndpoint(**kwargs)

Bases: object

A Data Safe private endpoint that allows Data Safe 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 DataSafePrivateEndpoint.

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_NA

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

LIFECYCLE_STATE_UPDATING

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

compartment_id

[Required] Gets the compartment_id of this DataSafePrivateEndpoint.

defined_tags

Gets the defined_tags of this DataSafePrivateEndpoint.

description

Gets the description of this DataSafePrivateEndpoint.

display_name

[Required] Gets the display_name of this DataSafePrivateEndpoint.

endpoint_fqdn

Gets the endpoint_fqdn of this DataSafePrivateEndpoint.

freeform_tags

Gets the freeform_tags of this DataSafePrivateEndpoint.

id

[Required] Gets the id of this DataSafePrivateEndpoint.

lifecycle_state

Gets the lifecycle_state of this DataSafePrivateEndpoint.

nsg_ids

Gets the nsg_ids of this DataSafePrivateEndpoint.

private_endpoint_id

[Required] Gets the private_endpoint_id of this DataSafePrivateEndpoint.

private_endpoint_ip

Gets the private_endpoint_ip of this DataSafePrivateEndpoint.

security_attributes

Gets the security_attributes of this DataSafePrivateEndpoint.

subnet_id

[Required] Gets the subnet_id of this DataSafePrivateEndpoint.

system_tags

Gets the system_tags of this DataSafePrivateEndpoint.

time_created

Gets the time_created of this DataSafePrivateEndpoint.

vcn_id

[Required] Gets the vcn_id of this DataSafePrivateEndpoint.

Methods:

__init__(**kwargs)

Initializes a new DataSafePrivateEndpoint object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_NA = 'NA'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

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

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

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

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

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

  • private_endpoint_id (str) – The value to assign to the private_endpoint_id property of this DataSafePrivateEndpoint.

  • private_endpoint_ip (str) – The value to assign to the private_endpoint_ip property of this DataSafePrivateEndpoint.

  • endpoint_fqdn (str) – The value to assign to the endpoint_fqdn property of this DataSafePrivateEndpoint.

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

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

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

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

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

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

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

property compartment_id

[Required] Gets the compartment_id of this DataSafePrivateEndpoint. The OCID of the compartment.

Returns

The compartment_id of this DataSafePrivateEndpoint.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this DataSafePrivateEndpoint.

Return type

str

property display_name

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

Returns

The display_name of this DataSafePrivateEndpoint.

Return type

str

property endpoint_fqdn

Gets the endpoint_fqdn of this DataSafePrivateEndpoint. The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN’s DNS records are updated with this FQDN.

Returns

The endpoint_fqdn of this DataSafePrivateEndpoint.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this DataSafePrivateEndpoint. The OCID of the Data Safe private endpoint.

Returns

The id of this DataSafePrivateEndpoint.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this DataSafePrivateEndpoint. The current state of the private endpoint.

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

Returns

The lifecycle_state of this DataSafePrivateEndpoint.

Return type

str

property nsg_ids

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

Returns

The nsg_ids of this DataSafePrivateEndpoint.

Return type

list[str]

property private_endpoint_id

[Required] Gets the private_endpoint_id of this DataSafePrivateEndpoint. The OCID of the underlying private endpoint.

Returns

The private_endpoint_id of this DataSafePrivateEndpoint.

Return type

str

property private_endpoint_ip

Gets the private_endpoint_ip of this DataSafePrivateEndpoint. The private IP address of the private endpoint.

Returns

The private_endpoint_ip of this DataSafePrivateEndpoint.

Return type

str

property security_attributes

Gets the security_attributes of this DataSafePrivateEndpoint. 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 DataSafePrivateEndpoint.

Return type

dict(str, dict(str, object))

property subnet_id

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

Returns

The subnet_id of this DataSafePrivateEndpoint.

Return type

str

property system_tags

Gets the system_tags of this DataSafePrivateEndpoint. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this DataSafePrivateEndpoint.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this DataSafePrivateEndpoint.

Return type

datetime

property vcn_id

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

Returns

The vcn_id of this DataSafePrivateEndpoint.

Return type

str