CreatePrivateEndpointDetails¶

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

Bases: object

Details to create a private endpoint

Methods:

__init__(**kwargs)

Initializes a new CreatePrivateEndpointDetails object with values from keyword arguments.

Attributes:

`access_targets`	[Required] Gets the access_targets of this CreatePrivateEndpointDetails.
`additional_prefixes`	Gets the additional_prefixes of this CreatePrivateEndpointDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreatePrivateEndpointDetails.
`defined_tags`	Gets the defined_tags of this CreatePrivateEndpointDetails.
`freeform_tags`	Gets the freeform_tags of this CreatePrivateEndpointDetails.
`name`	[Required] Gets the name of this CreatePrivateEndpointDetails. This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. Example: my-new-private-endpoint1.
`nsg_ids`	Gets the nsg_ids of this CreatePrivateEndpointDetails.
`prefix`	[Required] Gets the prefix of this CreatePrivateEndpointDetails.
`private_endpoint_ip`	Gets the private_endpoint_ip of this CreatePrivateEndpointDetails.
`security_attributes`	Gets the security_attributes of this CreatePrivateEndpointDetails.
`subnet_id`	[Required] Gets the subnet_id of this CreatePrivateEndpointDetails.

__init__(**kwargs)¶

Initializes a new CreatePrivateEndpointDetails 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 CreatePrivateEndpointDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreatePrivateEndpointDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreatePrivateEndpointDetails.
prefix (str) – The value to assign to the prefix property of this CreatePrivateEndpointDetails.
additional_prefixes (list[str]) – The value to assign to the additional_prefixes property of this CreatePrivateEndpointDetails.
private_endpoint_ip (str) – The value to assign to the private_endpoint_ip property of this CreatePrivateEndpointDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreatePrivateEndpointDetails.
access_targets (list[oci.object_storage.models.AccessTargetDetails]) – The value to assign to the access_targets property of this CreatePrivateEndpointDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreatePrivateEndpointDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreatePrivateEndpointDetails.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreatePrivateEndpointDetails.

property access_targets¶

[Required] Gets the access_targets of this CreatePrivateEndpointDetails. A list of targets that can be accessed by the private endpoint.

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

property additional_prefixes¶

Gets the additional_prefixes of this CreatePrivateEndpointDetails. 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 CreatePrivateEndpointDetails.
Return type: list[str]

property compartment_id¶

[Required] Gets the compartment_id of this CreatePrivateEndpointDetails. The ID of the compartment in which to create the Private Endpoint.

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

property defined_tags¶

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

property freeform_tags¶

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

property name¶

[Required] Gets the name of this CreatePrivateEndpointDetails. 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 CreatePrivateEndpointDetails.
Return type: str

property nsg_ids¶

Gets the nsg_ids of this CreatePrivateEndpointDetails. 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 CreatePrivateEndpointDetails.
Return type: list[str]

property prefix¶

[Required] Gets the prefix of this CreatePrivateEndpointDetails. 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 CreatePrivateEndpointDetails.
Return type: str

property private_endpoint_ip¶

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

property security_attributes¶

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

property subnet_id¶

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

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