CreateDistributedDatabasePrivateEndpointDetails¶
- class oci.distributed_database.models.CreateDistributedDatabasePrivateEndpointDetails(**kwargs)¶
Bases:
objectDetails required for private endpoint creation.
Methods:
__init__(**kwargs)Initializes a new CreateDistributedDatabasePrivateEndpointDetails object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this CreateDistributedDatabasePrivateEndpointDetails.
Gets the defined_tags of this CreateDistributedDatabasePrivateEndpointDetails.
Gets the description of this CreateDistributedDatabasePrivateEndpointDetails.
[Required] Gets the display_name of this CreateDistributedDatabasePrivateEndpointDetails.
Gets the freeform_tags of this CreateDistributedDatabasePrivateEndpointDetails.
[Required] Gets the subnet_id of this CreateDistributedDatabasePrivateEndpointDetails.
Gets the vcn_nsg_ids of this CreateDistributedDatabasePrivateEndpointDetails.
- __init__(**kwargs)¶
Initializes a new CreateDistributedDatabasePrivateEndpointDetails 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 CreateDistributedDatabasePrivateEndpointDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateDistributedDatabasePrivateEndpointDetails.
display_name (str) – The value to assign to the display_name property of this CreateDistributedDatabasePrivateEndpointDetails.
description (str) – The value to assign to the description property of this CreateDistributedDatabasePrivateEndpointDetails.
vcn_nsg_ids (list[oci.distributed_database.models.VcnNsgIdsDetails]) – The value to assign to the vcn_nsg_ids property of this CreateDistributedDatabasePrivateEndpointDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDistributedDatabasePrivateEndpointDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDistributedDatabasePrivateEndpointDetails.
- property compartment_id¶
[Required] Gets the compartment_id of this CreateDistributedDatabasePrivateEndpointDetails. Identifier of the compartment where private endpoint is to be created.
- Returns
The compartment_id of this CreateDistributedDatabasePrivateEndpointDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateDistributedDatabasePrivateEndpointDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this CreateDistributedDatabasePrivateEndpointDetails.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CreateDistributedDatabasePrivateEndpointDetails. DistributedDatabasePrivateEndpoint description.
- Returns
The description of this CreateDistributedDatabasePrivateEndpointDetails.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this CreateDistributedDatabasePrivateEndpointDetails. Private endpoint display name.
- Returns
The display_name of this CreateDistributedDatabasePrivateEndpointDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateDistributedDatabasePrivateEndpointDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this CreateDistributedDatabasePrivateEndpointDetails.
- Return type
dict(str, str)
- property subnet_id¶
[Required] Gets the subnet_id of this CreateDistributedDatabasePrivateEndpointDetails. Identifier of the customer subnet against which private endpoint is to be created.
- Returns
The subnet_id of this CreateDistributedDatabasePrivateEndpointDetails.
- Return type
str
- property vcn_nsg_ids¶
Gets the vcn_nsg_ids of this CreateDistributedDatabasePrivateEndpointDetails. The list of network security group (NSG) details to be associated with the private endpoint.
- Returns
The vcn_nsg_ids of this CreateDistributedDatabasePrivateEndpointDetails.
- Return type