Data Source: oci_psql_db_system

This data source provides details about a specific Db System resource in Oracle Cloud Infrastructure Psql service.

Gets a database system by identifier.

Example Usage

data "oci_psql_db_system" "test_db_system" {
	#Required
	db_system_id = oci_psql_db_system.test_db_system.id

	#Optional
	excluded_fields = var.db_system_excluded_fields
}

Argument Reference

The following arguments are supported:

• db_system_id - (Required) A unique identifier for the database system.
• excluded_fields - (Optional) A filter to exclude database configuration when this query parameter is set to OverrideDbConfig.

Attributes Reference

The following attributes are exported:

• admin_username - The database system administrator username.

• compartment_id - The OCID of the compartment that contains the database system.

• config_id - The OCID of the configuration associated with the database system.

• db_version - The major and minor versions of the database system software.

• 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 system.

• display_name - A user-friendly display name for the database system. Avoid entering confidential information.

• 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 - A unique identifier for the database system. Immutable on creation.

• instance_count - Count of instances, or nodes, in the database system.

• instance_memory_size_in_gbs - The total amount of memory available to each database instance node, in gigabytes.

• instance_ocpu_count - The total number of OCPUs available to each database instance node.

• instances - The list of instances, or nodes, in the database system.

  • availability_domain - The availability domain in which the database instance node is located.
  • description - Description of the database instance node.
  • display_name - A user-friendly display name for the database instance node. Avoid entering confidential information.
  • id - A unique identifier for the database instance node. Immutable on creation.
  • 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.
  • state - The current state of the database instance node.
  • time_created - The date and time that the database instance node was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
  • time_updated - The date and time that the database instance node was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

• kerberos_auth_details - Kerberos Authentication details for the database system.

  • backup_credentials - Optional. List of Kerberos Credentials previously configured for the dbsystem. Currently supports only one entry.
    • keytab_secret_id - The OCID of the secret where the Kerberos keytab file is stored as base64 text.
    • keytab_secret_version - The secret version of the stored Kerberos keytab file.
    • realm_name - Kerberos realm name. https://docs.oracle.com/cd/E36784_01/html/E37126/kplanning-27.html Realm names can consist of any ASCII string. Usually, the realm name is the same as your DNS domain name except that the realm name is in uppercase. This convention helps differentiate problems with the Kerberos service from problems with the DNS namespace, while keeping a name that is familiar. You can use any string, but configuration and maintenance might then require more work. Use realm names that follow the standard Internet naming structure.
  • credentials - List of Kerberos Credentials to be configured for the dbsystem. Currently supports only one entry.
    • keytab_secret_id - The OCID of the secret where the Kerberos keytab file is stored as base64 text.
    • keytab_secret_version - The secret version of the stored Kerberos keytab file.
    • realm_name - Kerberos realm name. https://docs.oracle.com/cd/E36784_01/html/E37126/kplanning-27.html Realm names can consist of any ASCII string. Usually, the realm name is the same as your DNS domain name except that the realm name is in uppercase. This convention helps differentiate problems with the Kerberos service from problems with the DNS namespace, while keeping a name that is familiar. You can use any string, but configuration and maintenance might then require more work. Use realm names that follow the standard Internet naming structure.
  • kind - Specifies the management of Kerberos Authentication for the dbSystem.

• 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.

• management_policy - PostgreSQL database system management policy.

  • backup_policy - PostgreSQL database system backup policy.
    • backup_start - Hour of the day when the backup starts.
    • copy_policy - Backup copy details
      • compartment_id - target compartment to place a new backup
      • regions - List of region names of the remote region
      • retention_period - Retention period in days of the backup copy.
    • days_of_the_month - Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day.
    • days_of_the_week - The day of the week that the backup starts.
    • kind - The kind of backup policy.
    • retention_days - How many days the data should be stored after the database system deletion.
  • maintenance_window_start - The start of the maintenance window.

• network_details - Network details for the database system.

  • is_reader_endpoint_enabled - Specifies if the reader endpoint is enabled on the dbSystem.
  • nsg_ids - List of customer Network Security Group OCIDs associated with the database system.
  • primary_db_endpoint_private_ip - Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.
  • subnet_id - The OCID of the customer subnet associated with the database system.

• odsp_insight_details - ODSP Insight details for the database system.

  • kind - Specifies the management of Insight for the dbSystem.
  • odsp_insight_list - List of ODSP Insight and their configurations.
    • insight_type - Type of Insight collected for the database system.
    • retention_period_in_days - Retention period for Insight data, in days. Current supported value is 7 days. the system default is 7 days.

• replication_config - Replication configuration that is applicable on database systems with the PRIMARY_DB_SYSTEM role.

  This configuration does not have any effect on database systems with other roles.

  • is_rpo_enforced - Specifies if Recovery point objective (RPO) enforcement is enabled on the database system.
  • rpo_in_seconds - Specifies the Recovery point objective (RPO) in seconds that will be enforced, if the isRpoEnforced flag is true.

• shape - The name of the shape for the database instance. Example: VM.Standard.E4.Flex

• source - The source of the database system.

  • backup_id - The OCID of the database system backup.
  • is_having_restore_config_overrides - Deprecated. Don’t use.
  • primary_db_system_id - The [OCID] of the primary database system.
  • source_type - The source descriminator.

• state - The current state of the database system.

• storage_details - Storage details of the database system.

  • availability_domain - Specifies the availability domain of AD-local storage. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
  • iops - Guaranteed input/output storage requests per second (IOPS) available to the database system.
  • is_regionally_durable - Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
  • system_type - Type of the database system.

• system_role - Type of the database system.

• system_tags - System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}

• system_type - Type of the database system.

• time_created - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

• time_updated - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z