CreatePrivateEndpointDetails

class oci.data_flow.models.CreatePrivateEndpointDetails(**kwargs)

Bases: object

The details required to create a private endpoint.

Methods

__init__(**kwargs) Initializes a new CreatePrivateEndpointDetails object with values from keyword arguments.

Attributes

compartment_id [Required] Gets the compartment_id of this CreatePrivateEndpointDetails.
defined_tags Gets the defined_tags of this CreatePrivateEndpointDetails.
description Gets the description of this CreatePrivateEndpointDetails.
display_name Gets the display_name of this CreatePrivateEndpointDetails.
dns_zones [Required] Gets the dns_zones of this CreatePrivateEndpointDetails.
freeform_tags Gets the freeform_tags of this CreatePrivateEndpointDetails.
max_host_count Gets the max_host_count of this CreatePrivateEndpointDetails.
nsg_ids Gets the nsg_ids 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:
  • compartment_id (str) – The value to assign to the compartment_id property of this CreatePrivateEndpointDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreatePrivateEndpointDetails.
  • description (str) – The value to assign to the description property of this CreatePrivateEndpointDetails.
  • display_name (str) – The value to assign to the display_name property of this CreatePrivateEndpointDetails.
  • dns_zones (list[str]) – The value to assign to the dns_zones property of this CreatePrivateEndpointDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreatePrivateEndpointDetails.
  • max_host_count (int) – The value to assign to the max_host_count property of this CreatePrivateEndpointDetails.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreatePrivateEndpointDetails.
  • subnet_id (str) – The value to assign to the subnet_id property of this CreatePrivateEndpointDetails.
compartment_id

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

Returns:The compartment_id of this CreatePrivateEndpointDetails.
Return type:str
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))
description

Gets the description of this CreatePrivateEndpointDetails. A user-friendly description. Avoid entering confidential information.

Returns:The description of this CreatePrivateEndpointDetails.
Return type:str
display_name

Gets the display_name of this CreatePrivateEndpointDetails. A user-friendly name. It does not have to be unique. Avoid entering confidential information.

Returns:The display_name of this CreatePrivateEndpointDetails.
Return type:str
dns_zones

[Required] Gets the dns_zones of this CreatePrivateEndpointDetails. An array of DNS zone names. Example: [ “app.examplecorp.com”, “app.examplecorp2.com” ]

Returns:The dns_zones of this CreatePrivateEndpointDetails.
Return type:list[str]
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)
max_host_count

Gets the max_host_count of this CreatePrivateEndpointDetails. The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

Returns:The max_host_count of this CreatePrivateEndpointDetails.
Return type:int
nsg_ids

Gets the nsg_ids of this CreatePrivateEndpointDetails. An array of network security group OCIDs.

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

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

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