CreatePrivateEndpointDetails¶

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

Bases: object

Creation details for 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`	[Required] Gets the display_name of this CreatePrivateEndpointDetails.
`dns_zones`	Gets the dns_zones of this CreatePrivateEndpointDetails.
`freeform_tags`	Gets the freeform_tags of this CreatePrivateEndpointDetails.
`is_used_with_configuration_source_provider`	Gets the is_used_with_configuration_source_provider of this CreatePrivateEndpointDetails.
`nsg_id_list`	Gets the nsg_id_list of this CreatePrivateEndpointDetails.
`subnet_id`	[Required] Gets the subnet_id of this CreatePrivateEndpointDetails.
`vcn_id`	[Required] Gets the vcn_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.
display_name (str) – The value to assign to the display_name property of this CreatePrivateEndpointDetails.
description (str) – The value to assign to the description property of this CreatePrivateEndpointDetails.
vcn_id (str) – The value to assign to the vcn_id property of this CreatePrivateEndpointDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreatePrivateEndpointDetails.
dns_zones (list[str]) – The value to assign to the dns_zones property of this CreatePrivateEndpointDetails.
nsg_id_list (list[str]) – The value to assign to the nsg_id_list property of this CreatePrivateEndpointDetails.
is_used_with_configuration_source_provider (bool) – The value to assign to the is_used_with_configuration_source_provider 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.

compartment_id¶

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

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. Description of the private endpoint. Avoid entering confidential information.

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

display_name¶

[Required] Gets the display_name of this CreatePrivateEndpointDetails. The private endpoint display name. Avoid entering confidential information.

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

dns_zones¶

Gets the dns_zones of this CreatePrivateEndpointDetails. DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.

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

freeform_tags¶

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

is_used_with_configuration_source_provider¶

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

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

nsg_id_list¶

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

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

subnet_id¶

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

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

vcn_id¶

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

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