Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Psql
  5. getDbSystem
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.Psql.getDbSystem

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    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

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDbSystem = oci.Psql.getDbSystem({
    dbSystemId: testDbSystemOciPsqlDbSystem.id,
    excludedFields: dbSystemExcludedFields,
});

    import pulumi
import pulumi_oci as oci

test_db_system = oci.Psql.get_db_system(db_system_id=test_db_system_oci_psql_db_system["id"],
    excluded_fields=db_system_excluded_fields)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/psql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := psql.GetDbSystem(ctx, &psql.GetDbSystemArgs{
			DbSystemId:     testDbSystemOciPsqlDbSystem.Id,
			ExcludedFields: pulumi.StringRef(dbSystemExcludedFields),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDbSystem = Oci.Psql.GetDbSystem.Invoke(new()
    {
        DbSystemId = testDbSystemOciPsqlDbSystem.Id,
        ExcludedFields = dbSystemExcludedFields,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Psql.PsqlFunctions;
import com.pulumi.oci.Psql.inputs.GetDbSystemArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testDbSystem = PsqlFunctions.getDbSystem(GetDbSystemArgs.builder()
            .dbSystemId(testDbSystemOciPsqlDbSystem.id())
            .excludedFields(dbSystemExcludedFields)
            .build());

    }
}

    variables:
  testDbSystem:
    fn::invoke:
      function: oci:Psql:getDbSystem
      arguments:
        dbSystemId: ${testDbSystemOciPsqlDbSystem.id}
        excludedFields: ${dbSystemExcludedFields}

    Using getDbSystem

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDbSystem(args: GetDbSystemArgs, opts?: InvokeOptions): Promise<GetDbSystemResult>
function getDbSystemOutput(args: GetDbSystemOutputArgs, opts?: InvokeOptions): Output<GetDbSystemResult>
    def get_db_system(db_system_id: Optional[str] = None,
                  excluded_fields: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDbSystemResult
def get_db_system_output(db_system_id: Optional[pulumi.Input[str]] = None,
                  excluded_fields: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDbSystemResult]
    func LookupDbSystem(ctx *Context, args *LookupDbSystemArgs, opts ...InvokeOption) (*LookupDbSystemResult, error)
func LookupDbSystemOutput(ctx *Context, args *LookupDbSystemOutputArgs, opts ...InvokeOption) LookupDbSystemResultOutput

    > Note: This function is named LookupDbSystem in the Go SDK.

    public static class GetDbSystem 
{
    public static Task<GetDbSystemResult> InvokeAsync(GetDbSystemArgs args, InvokeOptions? opts = null)
    public static Output<GetDbSystemResult> Invoke(GetDbSystemInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDbSystemResult> getDbSystem(GetDbSystemArgs args, InvokeOptions options)
public static Output<GetDbSystemResult> getDbSystem(GetDbSystemArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:Psql/getDbSystem:getDbSystem
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DbSystemId string
    A unique identifier for the database system.
    ExcludedFields string
    A filter to exclude database configuration when this query parameter is set to OverrideDbConfig.
    DbSystemId string
    A unique identifier for the database system.
    ExcludedFields string
    A filter to exclude database configuration when this query parameter is set to OverrideDbConfig.
    dbSystemId String
    A unique identifier for the database system.
    excludedFields String
    A filter to exclude database configuration when this query parameter is set to OverrideDbConfig.
    dbSystemId string
    A unique identifier for the database system.
    excludedFields string
    A filter to exclude database configuration when this query parameter is set to OverrideDbConfig.
    db_system_id str
    A unique identifier for the database system.
    excluded_fields str
    A filter to exclude database configuration when this query parameter is set to OverrideDbConfig.
    dbSystemId String
    A unique identifier for the database system.
    excludedFields String
    A filter to exclude database configuration when this query parameter is set to OverrideDbConfig.

    getDbSystem Result

    The following output properties are available:

    AdminUsername string
    The database system administrator username.
    ApplyConfig string
    CompartmentId string
    target compartment to place a new backup
    ConfigId string
    The OCID of the configuration associated with the database system.
    Credentials List<GetDbSystemCredential>
    DbSystemId string
    DbVersion string
    The major and minor versions of the database system software.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    Description of the database instance node.
    DisplayName string
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    A unique identifier for the database instance node. Immutable on creation.
    InstanceCount int
    Count of instances, or nodes, in the database system.
    InstanceMemorySizeInGbs int
    The total amount of memory available to each database instance node, in gigabytes.
    InstanceOcpuCount int
    The total number of OCPUs available to each database instance node.
    Instances List<GetDbSystemInstance>
    The list of instances, or nodes, in the database system.
    InstancesDetails List<GetDbSystemInstancesDetail>
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    ManagementPolicies List<GetDbSystemManagementPolicy>
    PostgreSQL database system management policy.
    NetworkDetails List<GetDbSystemNetworkDetail>
    Network details for the database system.
    PatchOperations List<GetDbSystemPatchOperation>
    Shape string
    The name of the shape for the database instance. Example: VM.Standard.E4.Flex
    Sources List<GetDbSystemSource>
    The source used to restore the database system.
    State string
    The current state of the database system.
    StorageDetails List<GetDbSystemStorageDetail>
    Storage details of the database system.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    SystemType string
    Type of the database system.
    TimeCreated string
    The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    ExcludedFields string
    AdminUsername string
    The database system administrator username.
    ApplyConfig string
    CompartmentId string
    target compartment to place a new backup
    ConfigId string
    The OCID of the configuration associated with the database system.
    Credentials []GetDbSystemCredential
    DbSystemId string
    DbVersion string
    The major and minor versions of the database system software.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    Description of the database instance node.
    DisplayName string
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    A unique identifier for the database instance node. Immutable on creation.
    InstanceCount int
    Count of instances, or nodes, in the database system.
    InstanceMemorySizeInGbs int
    The total amount of memory available to each database instance node, in gigabytes.
    InstanceOcpuCount int
    The total number of OCPUs available to each database instance node.
    Instances []GetDbSystemInstance
    The list of instances, or nodes, in the database system.
    InstancesDetails []GetDbSystemInstancesDetail
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    ManagementPolicies []GetDbSystemManagementPolicy
    PostgreSQL database system management policy.
    NetworkDetails []GetDbSystemNetworkDetail
    Network details for the database system.
    PatchOperations []GetDbSystemPatchOperation
    Shape string
    The name of the shape for the database instance. Example: VM.Standard.E4.Flex
    Sources []GetDbSystemSource
    The source used to restore the database system.
    State string
    The current state of the database system.
    StorageDetails []GetDbSystemStorageDetail
    Storage details of the database system.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    SystemType string
    Type of the database system.
    TimeCreated string
    The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    ExcludedFields string
    adminUsername String
    The database system administrator username.
    applyConfig String
    compartmentId String
    target compartment to place a new backup
    configId String
    The OCID of the configuration associated with the database system.
    credentials List<GetDbSystemCredential>
    dbSystemId String
    dbVersion String
    The major and minor versions of the database system software.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    Description of the database instance node.
    displayName String
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    A unique identifier for the database instance node. Immutable on creation.
    instanceCount Integer
    Count of instances, or nodes, in the database system.
    instanceMemorySizeInGbs Integer
    The total amount of memory available to each database instance node, in gigabytes.
    instanceOcpuCount Integer
    The total number of OCPUs available to each database instance node.
    instances List<GetDbSystemInstance>
    The list of instances, or nodes, in the database system.
    instancesDetails List<GetDbSystemInstancesDetail>
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    managementPolicies List<GetDbSystemManagementPolicy>
    PostgreSQL database system management policy.
    networkDetails List<GetDbSystemNetworkDetail>
    Network details for the database system.
    patchOperations List<GetDbSystemPatchOperation>
    shape String
    The name of the shape for the database instance. Example: VM.Standard.E4.Flex
    sources List<GetDbSystemSource>
    The source used to restore the database system.
    state String
    The current state of the database system.
    storageDetails List<GetDbSystemStorageDetail>
    Storage details of the database system.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    systemType String
    Type of the database system.
    timeCreated String
    The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    excludedFields String
    adminUsername string
    The database system administrator username.
    applyConfig string
    compartmentId string
    target compartment to place a new backup
    configId string
    The OCID of the configuration associated with the database system.
    credentials GetDbSystemCredential[]
    dbSystemId string
    dbVersion string
    The major and minor versions of the database system software.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    Description of the database instance node.
    displayName string
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    A unique identifier for the database instance node. Immutable on creation.
    instanceCount number
    Count of instances, or nodes, in the database system.
    instanceMemorySizeInGbs number
    The total amount of memory available to each database instance node, in gigabytes.
    instanceOcpuCount number
    The total number of OCPUs available to each database instance node.
    instances GetDbSystemInstance[]
    The list of instances, or nodes, in the database system.
    instancesDetails GetDbSystemInstancesDetail[]
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    managementPolicies GetDbSystemManagementPolicy[]
    PostgreSQL database system management policy.
    networkDetails GetDbSystemNetworkDetail[]
    Network details for the database system.
    patchOperations GetDbSystemPatchOperation[]
    shape string
    The name of the shape for the database instance. Example: VM.Standard.E4.Flex
    sources GetDbSystemSource[]
    The source used to restore the database system.
    state string
    The current state of the database system.
    storageDetails GetDbSystemStorageDetail[]
    Storage details of the database system.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    systemType string
    Type of the database system.
    timeCreated string
    The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    excludedFields string
    admin_username str
    The database system administrator username.
    apply_config str
    compartment_id str
    target compartment to place a new backup
    config_id str
    The OCID of the configuration associated with the database system.
    credentials Sequence[GetDbSystemCredential]
    db_system_id str
    db_version str
    The major and minor versions of the database system software.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    Description of the database instance node.
    display_name str
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    A unique identifier for the database instance node. Immutable on creation.
    instance_count int
    Count of instances, or nodes, in the database system.
    instance_memory_size_in_gbs int
    The total amount of memory available to each database instance node, in gigabytes.
    instance_ocpu_count int
    The total number of OCPUs available to each database instance node.
    instances Sequence[GetDbSystemInstance]
    The list of instances, or nodes, in the database system.
    instances_details Sequence[GetDbSystemInstancesDetail]
    lifecycle_details str
    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_policies Sequence[GetDbSystemManagementPolicy]
    PostgreSQL database system management policy.
    network_details Sequence[GetDbSystemNetworkDetail]
    Network details for the database system.
    patch_operations Sequence[GetDbSystemPatchOperation]
    shape str
    The name of the shape for the database instance. Example: VM.Standard.E4.Flex
    sources Sequence[GetDbSystemSource]
    The source used to restore the database system.
    state str
    The current state of the database system.
    storage_details Sequence[GetDbSystemStorageDetail]
    Storage details of the database system.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    system_type str
    Type of the database system.
    time_created str
    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 str
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    excluded_fields str
    adminUsername String
    The database system administrator username.
    applyConfig String
    compartmentId String
    target compartment to place a new backup
    configId String
    The OCID of the configuration associated with the database system.
    credentials List<Property Map>
    dbSystemId String
    dbVersion String
    The major and minor versions of the database system software.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    Description of the database instance node.
    displayName String
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    A unique identifier for the database instance node. Immutable on creation.
    instanceCount Number
    Count of instances, or nodes, in the database system.
    instanceMemorySizeInGbs Number
    The total amount of memory available to each database instance node, in gigabytes.
    instanceOcpuCount Number
    The total number of OCPUs available to each database instance node.
    instances List<Property Map>
    The list of instances, or nodes, in the database system.
    instancesDetails List<Property Map>
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    managementPolicies List<Property Map>
    PostgreSQL database system management policy.
    networkDetails List<Property Map>
    Network details for the database system.
    patchOperations List<Property Map>
    shape String
    The name of the shape for the database instance. Example: VM.Standard.E4.Flex
    sources List<Property Map>
    The source used to restore the database system.
    state String
    The current state of the database system.
    storageDetails List<Property Map>
    Storage details of the database system.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    systemType String
    Type of the database system.
    timeCreated String
    The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    excludedFields String

    Supporting Types

    GetDbSystemCredential

    GetDbSystemCredentialPasswordDetail

    Password string
    PasswordType string
    SecretId string
    SecretVersion string
    Password string
    PasswordType string
    SecretId string
    SecretVersion string
    password String
    passwordType String
    secretId String
    secretVersion String
    password string
    passwordType string
    secretId string
    secretVersion string
    password String
    passwordType String
    secretId String
    secretVersion String

    GetDbSystemInstance

    AvailabilityDomain string
    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.
    Description string
    Description of the database instance node.
    DisplayName string
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    Id string
    A unique identifier for the database instance node. Immutable on creation.
    LifecycleDetails string
    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 string
    The current state of the database system.
    TimeCreated string
    The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    AvailabilityDomain string
    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.
    Description string
    Description of the database instance node.
    DisplayName string
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    Id string
    A unique identifier for the database instance node. Immutable on creation.
    LifecycleDetails string
    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 string
    The current state of the database system.
    TimeCreated string
    The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain String
    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.
    description String
    Description of the database instance node.
    displayName String
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    id String
    A unique identifier for the database instance node. Immutable on creation.
    lifecycleDetails String
    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 String
    The current state of the database system.
    timeCreated String
    The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain string
    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.
    description string
    Description of the database instance node.
    displayName string
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    id string
    A unique identifier for the database instance node. Immutable on creation.
    lifecycleDetails string
    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 string
    The current state of the database system.
    timeCreated string
    The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availability_domain str
    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.
    description str
    Description of the database instance node.
    display_name str
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    id str
    A unique identifier for the database instance node. Immutable on creation.
    lifecycle_details str
    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 str
    The current state of the database system.
    time_created str
    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 str
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain String
    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.
    description String
    Description of the database instance node.
    displayName String
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    id String
    A unique identifier for the database instance node. Immutable on creation.
    lifecycleDetails String
    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 String
    The current state of the database system.
    timeCreated String
    The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

    GetDbSystemInstancesDetail

    Description string
    Description of the database instance node.
    DisplayName string
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    PrivateIp string
    Description string
    Description of the database instance node.
    DisplayName string
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    PrivateIp string
    description String
    Description of the database instance node.
    displayName String
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    privateIp String
    description string
    Description of the database instance node.
    displayName string
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    privateIp string
    description str
    Description of the database instance node.
    display_name str
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    private_ip str
    description String
    Description of the database instance node.
    displayName String
    A user-friendly display name for the database instance node. Avoid entering confidential information.
    privateIp String

    GetDbSystemManagementPolicy

    BackupPolicies List<GetDbSystemManagementPolicyBackupPolicy>
    PostgreSQL database system backup policy.
    MaintenanceWindowStart string
    The start of the maintenance window.
    BackupPolicies []GetDbSystemManagementPolicyBackupPolicy
    PostgreSQL database system backup policy.
    MaintenanceWindowStart string
    The start of the maintenance window.
    backupPolicies List<GetDbSystemManagementPolicyBackupPolicy>
    PostgreSQL database system backup policy.
    maintenanceWindowStart String
    The start of the maintenance window.
    backupPolicies GetDbSystemManagementPolicyBackupPolicy[]
    PostgreSQL database system backup policy.
    maintenanceWindowStart string
    The start of the maintenance window.
    backup_policies Sequence[GetDbSystemManagementPolicyBackupPolicy]
    PostgreSQL database system backup policy.
    maintenance_window_start str
    The start of the maintenance window.
    backupPolicies List<Property Map>
    PostgreSQL database system backup policy.
    maintenanceWindowStart String
    The start of the maintenance window.

    GetDbSystemManagementPolicyBackupPolicy

    BackupStart string
    Hour of the day when the backup starts.
    CopyPolicies List<GetDbSystemManagementPolicyBackupPolicyCopyPolicy>
    Backup copy details
    DaysOfTheMonths List<int>
    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.
    DaysOfTheWeeks List<string>
    The day of the week that the backup starts.
    Kind string
    The kind of backup policy.
    RetentionDays int
    How many days the data should be stored after the database system deletion.
    BackupStart string
    Hour of the day when the backup starts.
    CopyPolicies []GetDbSystemManagementPolicyBackupPolicyCopyPolicy
    Backup copy details
    DaysOfTheMonths []int
    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.
    DaysOfTheWeeks []string
    The day of the week that the backup starts.
    Kind string
    The kind of backup policy.
    RetentionDays int
    How many days the data should be stored after the database system deletion.
    backupStart String
    Hour of the day when the backup starts.
    copyPolicies List<GetDbSystemManagementPolicyBackupPolicyCopyPolicy>
    Backup copy details
    daysOfTheMonths List<Integer>
    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.
    daysOfTheWeeks List<String>
    The day of the week that the backup starts.
    kind String
    The kind of backup policy.
    retentionDays Integer
    How many days the data should be stored after the database system deletion.
    backupStart string
    Hour of the day when the backup starts.
    copyPolicies GetDbSystemManagementPolicyBackupPolicyCopyPolicy[]
    Backup copy details
    daysOfTheMonths number[]
    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.
    daysOfTheWeeks string[]
    The day of the week that the backup starts.
    kind string
    The kind of backup policy.
    retentionDays number
    How many days the data should be stored after the database system deletion.
    backup_start str
    Hour of the day when the backup starts.
    copy_policies Sequence[GetDbSystemManagementPolicyBackupPolicyCopyPolicy]
    Backup copy details
    days_of_the_months Sequence[int]
    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_weeks Sequence[str]
    The day of the week that the backup starts.
    kind str
    The kind of backup policy.
    retention_days int
    How many days the data should be stored after the database system deletion.
    backupStart String
    Hour of the day when the backup starts.
    copyPolicies List<Property Map>
    Backup copy details
    daysOfTheMonths List<Number>
    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.
    daysOfTheWeeks List<String>
    The day of the week that the backup starts.
    kind String
    The kind of backup policy.
    retentionDays Number
    How many days the data should be stored after the database system deletion.

    GetDbSystemManagementPolicyBackupPolicyCopyPolicy

    CompartmentId string
    target compartment to place a new backup
    Regions List<string>
    List of region names of the remote region
    RetentionPeriod int
    Retention period in days of the backup copy.
    CompartmentId string
    target compartment to place a new backup
    Regions []string
    List of region names of the remote region
    RetentionPeriod int
    Retention period in days of the backup copy.
    compartmentId String
    target compartment to place a new backup
    regions List<String>
    List of region names of the remote region
    retentionPeriod Integer
    Retention period in days of the backup copy.
    compartmentId string
    target compartment to place a new backup
    regions string[]
    List of region names of the remote region
    retentionPeriod number
    Retention period in days of the backup copy.
    compartment_id str
    target compartment to place a new backup
    regions Sequence[str]
    List of region names of the remote region
    retention_period int
    Retention period in days of the backup copy.
    compartmentId String
    target compartment to place a new backup
    regions List<String>
    List of region names of the remote region
    retentionPeriod Number
    Retention period in days of the backup copy.

    GetDbSystemNetworkDetail

    IsReaderEndpointEnabled bool
    Specifies if the reader endpoint is enabled on the dbSystem.
    NsgIds List<string>
    List of customer Network Security Group OCIDs associated with the database system.
    PrimaryDbEndpointPrivateIp string
    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.
    SubnetId string
    The OCID of the customer subnet associated with the database system.
    IsReaderEndpointEnabled bool
    Specifies if the reader endpoint is enabled on the dbSystem.
    NsgIds []string
    List of customer Network Security Group OCIDs associated with the database system.
    PrimaryDbEndpointPrivateIp string
    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.
    SubnetId string
    The OCID of the customer subnet associated with the database system.
    isReaderEndpointEnabled Boolean
    Specifies if the reader endpoint is enabled on the dbSystem.
    nsgIds List<String>
    List of customer Network Security Group OCIDs associated with the database system.
    primaryDbEndpointPrivateIp String
    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.
    subnetId String
    The OCID of the customer subnet associated with the database system.
    isReaderEndpointEnabled boolean
    Specifies if the reader endpoint is enabled on the dbSystem.
    nsgIds string[]
    List of customer Network Security Group OCIDs associated with the database system.
    primaryDbEndpointPrivateIp string
    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.
    subnetId string
    The OCID of the customer subnet associated with the database system.
    is_reader_endpoint_enabled bool
    Specifies if the reader endpoint is enabled on the dbSystem.
    nsg_ids Sequence[str]
    List of customer Network Security Group OCIDs associated with the database system.
    primary_db_endpoint_private_ip str
    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 str
    The OCID of the customer subnet associated with the database system.
    isReaderEndpointEnabled Boolean
    Specifies if the reader endpoint is enabled on the dbSystem.
    nsgIds List<String>
    List of customer Network Security Group OCIDs associated with the database system.
    primaryDbEndpointPrivateIp String
    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.
    subnetId String
    The OCID of the customer subnet associated with the database system.

    GetDbSystemPatchOperation

    From string
    Operation string
    Position string
    SelectedItem string
    Selection string
    Value Dictionary<string, string>
    From string
    Operation string
    Position string
    SelectedItem string
    Selection string
    Value map[string]string
    from String
    operation String
    position String
    selectedItem String
    selection String
    value Map<String,String>
    from string
    operation string
    position string
    selectedItem string
    selection string
    value {[key: string]: string}
    from_ str
    operation str
    position str
    selected_item str
    selection str
    value Mapping[str, str]
    from String
    operation String
    position String
    selectedItem String
    selection String
    value Map<String>

    GetDbSystemSource

    BackupId string
    The OCID of the database system backup.
    IsHavingRestoreConfigOverrides bool
    Deprecated. Don't use.
    SourceType string
    The source descriminator.
    BackupId string
    The OCID of the database system backup.
    IsHavingRestoreConfigOverrides bool
    Deprecated. Don't use.
    SourceType string
    The source descriminator.
    backupId String
    The OCID of the database system backup.
    isHavingRestoreConfigOverrides Boolean
    Deprecated. Don't use.
    sourceType String
    The source descriminator.
    backupId string
    The OCID of the database system backup.
    isHavingRestoreConfigOverrides boolean
    Deprecated. Don't use.
    sourceType string
    The source descriminator.
    backup_id str
    The OCID of the database system backup.
    is_having_restore_config_overrides bool
    Deprecated. Don't use.
    source_type str
    The source descriminator.
    backupId String
    The OCID of the database system backup.
    isHavingRestoreConfigOverrides Boolean
    Deprecated. Don't use.
    sourceType String
    The source descriminator.

    GetDbSystemStorageDetail

    AvailabilityDomain string
    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 string
    Guaranteed input/output storage requests per second (IOPS) available to the database system.
    IsRegionallyDurable bool
    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.
    SystemType string
    Type of the database system.
    AvailabilityDomain string
    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 string
    Guaranteed input/output storage requests per second (IOPS) available to the database system.
    IsRegionallyDurable bool
    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.
    SystemType string
    Type of the database system.
    availabilityDomain String
    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 String
    Guaranteed input/output storage requests per second (IOPS) available to the database system.
    isRegionallyDurable Boolean
    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.
    systemType String
    Type of the database system.
    availabilityDomain string
    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 string
    Guaranteed input/output storage requests per second (IOPS) available to the database system.
    isRegionallyDurable boolean
    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.
    systemType string
    Type of the database system.
    availability_domain str
    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 str
    Guaranteed input/output storage requests per second (IOPS) available to the database system.
    is_regionally_durable bool
    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 str
    Type of the database system.
    availabilityDomain String
    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 String
    Guaranteed input/output storage requests per second (IOPS) available to the database system.
    isRegionallyDurable Boolean
    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.
    systemType String
    Type of the database system.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci