PrivateEndpoint¶

class oci.resource_manager.models.PrivateEndpoint(**kwargs)¶

Bases: object

A private endpoint allowing Resource Manager to access nonpublic cloud resources. For more information about private endpoints, see Managing Private Endpoints.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
`compartment_id`	[Required] Gets the compartment_id of this PrivateEndpoint.
`defined_tags`	Gets the defined_tags of this PrivateEndpoint.
`description`	Gets the description of this PrivateEndpoint.
`display_name`	Gets the display_name of this PrivateEndpoint.
`dns_zones`	Gets the dns_zones of this PrivateEndpoint.
`freeform_tags`	Gets the freeform_tags of this PrivateEndpoint.
`id`	[Required] Gets the id of this PrivateEndpoint.
`is_used_with_configuration_source_provider`	Gets the is_used_with_configuration_source_provider of this PrivateEndpoint.
`lifecycle_state`	Gets the lifecycle_state of this PrivateEndpoint.
`nsg_id_list`	Gets the nsg_id_list of this PrivateEndpoint.
`security_attributes`	Gets the security_attributes of this PrivateEndpoint.
`source_ips`	Gets the source_ips of this PrivateEndpoint.
`subnet_id`	[Required] Gets the subnet_id of this PrivateEndpoint.
`system_tags`	Gets the system_tags of this PrivateEndpoint.
`time_created`	Gets the time_created of this PrivateEndpoint.
`vcn_id`	[Required] Gets the vcn_id of this PrivateEndpoint.

Methods:

__init__(**kwargs)

Initializes a new PrivateEndpoint object with values from keyword arguments.

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new PrivateEndpoint 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 PrivateEndpoint.
compartment_id (str) – The value to assign to the compartment_id property of this PrivateEndpoint.
display_name (str) – The value to assign to the display_name property of this PrivateEndpoint.
description (str) – The value to assign to the description property of this PrivateEndpoint.
vcn_id (str) – The value to assign to the vcn_id property of this PrivateEndpoint.
subnet_id (str) – The value to assign to the subnet_id property of this PrivateEndpoint.
source_ips (list[str]) – The value to assign to the source_ips property of this PrivateEndpoint.
nsg_id_list (list[str]) – The value to assign to the nsg_id_list property of this PrivateEndpoint.
is_used_with_configuration_source_provider (bool) – The value to assign to the is_used_with_configuration_source_provider property of this PrivateEndpoint.
dns_zones (list[str]) – The value to assign to the dns_zones property of this PrivateEndpoint.
time_created (datetime) – The value to assign to the time_created property of this PrivateEndpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PrivateEndpoint. Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PrivateEndpoint.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PrivateEndpoint.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PrivateEndpoint.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this PrivateEndpoint.

property compartment_id¶

[Required] Gets the compartment_id of this PrivateEndpoint. The OCID of the compartment containing this private endpoint.

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

property defined_tags¶

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

property description¶

Gets the description of this PrivateEndpoint. Description of the private endpoint. Avoid entering confidential information.

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

property display_name¶

Gets the display_name of this PrivateEndpoint. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

property dns_zones¶

Gets the dns_zones of this PrivateEndpoint. DNS zones to use for accessing private Git servers. For private Git server instructions, see Private Git Server. Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: abc.oraclevcn.com

Returns: The dns_zones of this PrivateEndpoint.
Return type: list[str]

property freeform_tags¶

Gets the freeform_tags of this PrivateEndpoint. Free-form tags associated with the resource. Each tag is a 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 PrivateEndpoint.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this PrivateEndpoint. The OCID of the private endpoint.

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

property is_used_with_configuration_source_provider¶

Gets the is_used_with_configuration_source_provider of this PrivateEndpoint. When true, allows the private endpoint to be used with a configuration source provider.

Returns: The is_used_with_configuration_source_provider of this PrivateEndpoint.
Return type: bool

property lifecycle_state¶

Gets the lifecycle_state of this PrivateEndpoint. The current lifecycle state of the private endpoint.

Allowed values for this property are: “ACTIVE”, “CREATING”, “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 PrivateEndpoint.
Return type: str

property nsg_id_list¶

Gets the nsg_id_list of this PrivateEndpoint. The OCIDs of network security groups (NSGs) for the private endpoint. Order does not matter.

Returns: The nsg_id_list of this PrivateEndpoint.
Return type: list[str]

property security_attributes¶

Gets the security_attributes of this PrivateEndpoint. Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}

Returns: The security_attributes of this PrivateEndpoint.
Return type: dict(str, dict(str, object))

property source_ips¶

Gets the source_ips of this PrivateEndpoint. The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager.

Returns: The source_ips of this PrivateEndpoint.
Return type: list[str]

property subnet_id¶

[Required] Gets the subnet_id of this PrivateEndpoint. The OCID of the subnet within the VCN for the private endpoint.

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

property system_tags¶

Gets the system_tags of this PrivateEndpoint. The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

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

property time_created¶

Gets the time_created of this PrivateEndpoint. The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z

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

property vcn_id¶

[Required] Gets the vcn_id of this PrivateEndpoint. The OCID of the VCN for the private endpoint.

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