oci_database_tools_database_tools_private_endpoint

This resource provides the Database Tools Private Endpoint resource in Oracle Cloud Infrastructure Database Tools service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/database-tools/latest/DatabaseToolsPrivateEndpoint

Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/databaseTools

Creates a new Database Tools private endpoint.

Example Usage

resource "oci_database_tools_database_tools_private_endpoint" "test_database_tools_private_endpoint" {
	#Required
	compartment_id = var.compartment_id
	display_name = var.database_tools_private_endpoint_display_name
	endpoint_service_id = oci_core_service.test_service.id
	subnet_id = oci_core_subnet.test_subnet.id

	#Optional
	defined_tags = {"foo-namespace.bar-key"= "value"}
	description = var.database_tools_private_endpoint_description
	freeform_tags = {"bar-key"= "value"}
	locks {
		#Required
		type = var.database_tools_private_endpoint_locks_type

		#Optional
		message = var.database_tools_private_endpoint_locks_message
		related_resource_id = oci_usage_proxy_resource.test_resource.id
		time_created = var.database_tools_private_endpoint_locks_time_created
	}
	nsg_ids = var.database_tools_private_endpoint_nsg_ids
	private_endpoint_ip = var.database_tools_private_endpoint_private_endpoint_ip
	security_attributes = var.database_tools_private_endpoint_security_attributes
}

Argument Reference

The following arguments are supported:

• compartment_id - (Required) (Updatable) The OCID of the compartment containing the Database Tools private endpoint.
• defined_tags - (Optional) (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
• description - (Optional) (Updatable) A description of the Database Tools private endpoint.
• display_name - (Required) (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
• endpoint_service_id - (Required) The OCID of the DatabaseToolsEndpointService.
• freeform_tags - (Optional) (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
• locks - (Optional) Locks associated with this resource.
  • message - (Optional) A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
  • related_resource_id - (Optional) The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
  • time_created - (Optional) When the lock was created.
  • type - (Required) Type of the lock.
• nsg_ids - (Optional) (Updatable) The OCID of the network security groups that the private endpoint’s VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
• private_endpoint_ip - (Optional) The private IP address that represents the access point for the associated endpoint service.
• security_attributes - (Optional) (Updatable) Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see ZPR Artifacts. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
• subnet_id - (Required) The OCID of the subnet that the private endpoint belongs to.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Attributes Reference

The following attributes are exported:

• additional_fqdns - A list of additional FQDNs that can be also be used for the private endpoint.
• compartment_id - The OCID of the compartment containing the Database Tools private endpoint.
• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
• description - A description of the Database Tools private endpoint.
• display_name - A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
• endpoint_fqdn - Then FQDN to use for the private endpoint.
• endpoint_service_id - The OCID of the Database Tools Endpoint Service.
• freeform_tags - Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
• id - The OCID of the Database Tools private endpoint.
• lifecycle_details - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
• locks - Locks associated with this resource.
  • message - A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
  • related_resource_id - The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
  • time_created - When the lock was created.
  • type - Type of the lock.
• nsg_ids - The OCID of the network security groups that the private endpoint’s VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.
• private_endpoint_ip - The private IP address that represents the access point for the associated endpoint service.
• private_endpoint_vnic_id - The OCID of the private endpoint’s VNIC.
• reverse_connection_configuration - Reverse connection configuration details of the private endpoint.
  • reverse_connections_source_ips - A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service’s VCN to the customer’s VCN.
    • source_ip - The IP address in the customer’s VCN to be used as the source IP for reverse connection packets traveling from the customer’s VCN to the service’s VCN.
• security_attributes - Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see ZPR Artifacts. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
• state - The current state of the Database Tools private endpoint.
• subnet_id - The OCID of the subnet that the private endpoint belongs to.
• system_tags - Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
• time_created - The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string
• time_updated - The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
• vcn_id - The OCID of the VCN that the private endpoint belongs to.

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 20 minutes), when creating the Database Tools Private Endpoint * update - (Defaults to 20 minutes), when updating the Database Tools Private Endpoint * delete - (Defaults to 20 minutes), when destroying the Database Tools Private Endpoint

Import

DatabaseToolsPrivateEndpoints can be imported using the id, e.g.

$ terraform import oci_database_tools_database_tools_private_endpoint.test_database_tools_private_endpoint "id"