Data Source: oci_data_safe_target_databases

This data source provides the list of Target Databases in Oracle Cloud Infrastructure Data Safe service.

Returns the list of registered target databases in Data Safe.

Example Usage

data "oci_data_safe_target_databases" "test_target_databases" {
	#Required
	compartment_id = var.compartment_id

	#Optional
	access_level = var.target_database_access_level
	associated_resource_id = oci_data_safe_associated_resource.test_associated_resource.id
	compartment_id_in_subtree = var.target_database_compartment_id_in_subtree
	database_type = var.target_database_database_type
	display_name = var.target_database_display_name
	infrastructure_type = var.target_database_infrastructure_type
	state = var.target_database_state
	target_database_id = oci_data_safe_target_database.test_target_database.id
}

Argument Reference

The following arguments are supported:

• access_level - (Optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
• associated_resource_id - (Optional) A filter to return the target databases that are associated to the resource id passed in as a parameter value.
• compartment_id - (Required) A filter to return only resources that match the specified compartment OCID.
• compartment_id_in_subtree - (Optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.
• database_type - (Optional) A filter to return only target databases that match the specified database type.
• display_name - (Optional) A filter to return only resources that match the specified display name.
• infrastructure_type - (Optional) A filter to return only target databases that match the specified infrastructure type.
• state - (Optional) A filter to return only target databases that match the specified lifecycle state.
• target_database_id - (Optional) A filter to return the target database that matches the specified OCID.

Attributes Reference

The following attributes are exported:

• target_databases - The list of target_databases.

TargetDatabase Reference

The following attributes are exported:

• associated_resource_ids - The OCIDs of associated resources like database, Data Safe private endpoint etc.
• compartment_id - The OCID of the compartment which contains the Data Safe target database.
• connection_option - Types of connection supported by Data Safe.
  • connection_type - The connection type used to connect to the database. Allowed values:
    • PRIVATE_ENDPOINT - Represents connection through private endpoint in Data Safe.
    • ONPREM_CONNECTOR - Represents connection through on-premises connector in Data Safe.
  • datasafe_private_endpoint_id - The OCID of the Data Safe private endpoint.
  • on_prem_connector_id - The OCID of the on-premises connector.
• credentials - The database credentials required for Data Safe to connect to the database.
  • password - The password of the database user.
  • user_name - The database user name.
• database_details - Details of the database for the registration in Data Safe.
  • autonomous_database_id - The OCID of the Autonomous Database registered as a target database in Data Safe.
  • database_type - The database type.
  • db_system_id - The OCID of the cloud database registered as a target database in Data Safe.
  • infrastructure_type - The infrastructure type the database is running on.
  • instance_id - The OCID of the compute instance on which the database is running.
  • ip_addresses - The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is ‘ONPREM_CONNECTOR’.
  • listener_port - The port number of the database listener.
  • service_name - The service name of the database registered as target database.
  • vm_cluster_id - The OCID of the VM cluster in which the database is running.
• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
• description - The description of the target database in Data Safe.
• display_name - The display name of the target database in Data Safe.
• freeform_tags - 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"}
• id - The OCID of the Data Safe target database.
• lifecycle_details - Details about the current state of the target database in Data Safe.
• peer_target_databases - The OCIDs of associated resources like Database, Data Safe private endpoint etc.
  • database_details - Details of the database for the registration in Data Safe.
    • autonomous_database_id - The OCID of the Autonomous Database registered as a target database in Data Safe.
    • database_type - The database type.
    • db_system_id - The OCID of the cloud database registered as a target database in Data Safe.
    • infrastructure_type - The infrastructure type the database is running on.
    • instance_id - The OCID of the compute instance on which the database is running.
    • ip_addresses - The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is ‘ONPREM_CONNECTOR’.
    • listener_port - The port number of the database listener.
    • service_name - The service name of the database registered as target database.
    • vm_cluster_id - The OCID of the VM cluster in which the database is running.
  • database_unique_name - Unique name of the database associated to the peer target database.
  • dataguard_association_id - The OCID of the Data Guard Association resource in which the database associated to the peer target database is considered as peer database to the primary database.
  • description - The description of the peer target database in Data Safe.
  • display_name - The display name of the peer target database in Data Safe.
  • key - The secondary key assigned for the peer target database in Data Safe.
  • lifecycle_details - Details about the current state of the peer target database in Data Safe.
  • role - Role of the database associated to the peer target database.
  • state - The current state of the peer target database in Data Safe.
  • time_created - The date and time of the peer target database registration in Data Safe.
  • tls_config - The details required to establish a TLS enabled connection.
    • certificate_store_type - The format of the certificate store.
    • key_store_content - Base64 encoded string of key store file content.
    • status - Status to represent whether the database connection is TLS enabled or not.
    • store_password - The password to read the trust store and key store files, if they are password protected.
    • trust_store_content - Base64 encoded string of trust store file content.
• state - The current state of the target database in Data Safe.
• system_tags - System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
• time_created - The date and time the database was registered in Data Safe and created as a target database in Data Safe.
• time_updated - The date and time of the target database update in Data Safe.
• tls_config - The details required to establish a TLS enabled connection.
  • certificate_store_type - The format of the certificate store.
  • key_store_content - Base64 encoded string of key store file content.
  • status - Status to represent whether the database connection is TLS enabled or not.
  • store_password - The password to read the trust store and key store files, if they are password protected.
  • trust_store_content - Base64 encoded string of trust store file content.