PrivateEndpoint¶

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

Bases: object

A private endpoint makes your service accessible through a private IP in the customer’s private network. A private endpoint has a name and is associated with a namespace and a single compartment.

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.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
`access_targets`	[Required] Gets the access_targets of this PrivateEndpoint.
`additional_prefixes`	Gets the additional_prefixes of this PrivateEndpoint.
`compartment_id`	[Required] Gets the compartment_id of this PrivateEndpoint.
`created_by`	[Required] Gets the created_by of this PrivateEndpoint.
`defined_tags`	Gets the defined_tags of this PrivateEndpoint.
`etag`	[Required] Gets the etag of this PrivateEndpoint.
`fqdns`	[Required] Gets the fqdns of this PrivateEndpoint.
`freeform_tags`	Gets the freeform_tags of this PrivateEndpoint.
`id`	Gets the id of this PrivateEndpoint.
`lifecycle_state`	Gets the lifecycle_state of this PrivateEndpoint.
`name`	[Required] Gets the name of this PrivateEndpoint. This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. Example: my-new-private-endpoint1.
`namespace`	[Required] Gets the namespace of this PrivateEndpoint.
`nsg_ids`	Gets the nsg_ids of this PrivateEndpoint.
`prefix`	[Required] Gets the prefix of this PrivateEndpoint.
`private_endpoint_ip`	[Required] Gets the private_endpoint_ip of this PrivateEndpoint.
`security_attributes`	Gets the security_attributes of this PrivateEndpoint.
`subnet_id`	[Required] Gets the subnet_id of this PrivateEndpoint.
`time_created`	[Required] Gets the time_created of this PrivateEndpoint.
`time_modified`	[Required] Gets the time_modified 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”

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

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

__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

name (str) – The value to assign to the name property of this PrivateEndpoint.
namespace (str) – The value to assign to the namespace property of this PrivateEndpoint.
compartment_id (str) – The value to assign to the compartment_id property of this PrivateEndpoint.
created_by (str) – The value to assign to the created_by property of this PrivateEndpoint.
time_created (datetime) – The value to assign to the time_created property of this PrivateEndpoint.
time_modified (datetime) – The value to assign to the time_modified property of this PrivateEndpoint.
subnet_id (str) – The value to assign to the subnet_id property of this PrivateEndpoint.
private_endpoint_ip (str) – The value to assign to the private_endpoint_ip property of this PrivateEndpoint.
prefix (str) – The value to assign to the prefix property of this PrivateEndpoint.
additional_prefixes (list[str]) – The value to assign to the additional_prefixes property of this PrivateEndpoint.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this PrivateEndpoint.
fqdns (oci.object_storage.models.Fqdns) – The value to assign to the fqdns property of this PrivateEndpoint.
etag (str) – The value to assign to the etag 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: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
access_targets (list[oci.object_storage.models.AccessTargetDetails]) – The value to assign to the access_targets property of this PrivateEndpoint.
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.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this PrivateEndpoint.
id (str) – The value to assign to the id property of this PrivateEndpoint.

property access_targets¶

[Required] Gets the access_targets of this PrivateEndpoint. A list of targets that can be accessed by the private endpoint. At least one or more access targets is required for a private endpoint.

Returns: The access_targets of this PrivateEndpoint.
Return type: list[oci.object_storage.models.AccessTargetDetails]

property additional_prefixes¶

Gets the additional_prefixes of this PrivateEndpoint. A list of additional prefix that you can provide along with any other prefix. These resulting endpointFqdn’s are added to the customer VCN’s DNS record.

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

property compartment_id¶

[Required] Gets the compartment_id of this PrivateEndpoint. The compartment which is associated with the Private Endpoint.

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

property created_by¶

[Required] Gets the created_by of this PrivateEndpoint. The OCID of the user who created the Private Endpoint.

Returns: The created_by 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 etag¶

[Required] Gets the etag of this PrivateEndpoint. The entity tag (ETag) for the Private Endpoint.

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

property fqdns¶

[Required] Gets the fqdns of this PrivateEndpoint.

Returns: The fqdns of this PrivateEndpoint.
Return type: oci.object_storage.models.Fqdns

property freeform_tags¶

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

property id¶

Gets the id of this PrivateEndpoint. The OCID of the PrivateEndpoint.

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

property lifecycle_state¶

Gets the lifecycle_state of this PrivateEndpoint. The Private Endpoint’s lifecycle state.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “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 name¶

[Required] Gets the name of this PrivateEndpoint. This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens,

underscores, and periods.

Example: my-new-private-endpoint1

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

property namespace¶

[Required] Gets the namespace of this PrivateEndpoint. The Object Storage namespace associated with the private enpoint.

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

property nsg_ids¶

Gets the nsg_ids of this PrivateEndpoint. A list of the OCIDs of the network security groups (NSGs) to add the private endpoint’s VNIC to. For more information about NSGs, see NetworkSecurityGroup.

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

property prefix¶

[Required] Gets the prefix of this PrivateEndpoint. A prefix to use for the private endpoint. The customer VCN’s DNS records are updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn. Example: If the prefix chosen is “abc”, then the endpointFqdn will be ‘abc.private.objectstorage.<region>.oraclecloud.com’

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

property private_endpoint_ip¶

[Required] Gets the private_endpoint_ip of this PrivateEndpoint. The private IP address to assign to this private endpoint. If you provide a value, it must be an available IP address in the customer’s subnet. If it’s not available, an error is returned.

If you do not provide a value, an available IP address in the subnet is automatically chosen.

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

property security_attributes¶

Gets the security_attributes of this PrivateEndpoint. Security attributes for Private Endpoint 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 PrivateEndpoint.
Return type: dict(str, dict(str, object))

property subnet_id¶

[Required] Gets the subnet_id of this PrivateEndpoint. The OCID of the customer’s subnet where the private endpoint VNIC will reside.

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

property time_created¶

[Required] Gets the time_created of this PrivateEndpoint. The date and time the Private Endpoint was created, as described in RFC 2616.

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

property time_modified¶

[Required] Gets the time_modified of this PrivateEndpoint. The date and time the Private Endpoint was updated, as described in RFC 2616.

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