oci.Psql.DbSystem
Explore with Pulumi AI
This resource provides the Db System resource in Oracle Cloud Infrastructure Psql service.
Creates a new database system.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDbSystem = new oci.psql.DbSystem("test_db_system", {
    compartmentId: compartmentId,
    credentials: {
        passwordDetails: {
            passwordType: dbSystemCredentialsPasswordDetailsPasswordType,
            password: dbSystemCredentialsPasswordDetailsPassword,
            secretId: testSecret.id,
            secretVersion: dbSystemCredentialsPasswordDetailsSecretVersion,
        },
        username: dbSystemCredentialsUsername,
    },
    dbVersion: dbSystemDbVersion,
    displayName: dbSystemDisplayName,
    networkDetails: {
        subnetId: testSubnet.id,
        isReaderEndpointEnabled: dbSystemNetworkDetailsIsReaderEndpointEnabled,
        nsgIds: dbSystemNetworkDetailsNsgIds,
        primaryDbEndpointPrivateIp: dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp,
    },
    shape: dbSystemShape,
    storageDetails: {
        isRegionallyDurable: dbSystemStorageDetailsIsRegionallyDurable,
        systemType: dbSystemStorageDetailsSystemType,
        availabilityDomain: dbSystemStorageDetailsAvailabilityDomain,
        iops: dbSystemStorageDetailsIops,
    },
    configId: testConfig.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: dbSystemDescription,
    freeformTags: {
        "bar-key": "value",
    },
    instanceCount: dbSystemInstanceCount,
    instanceMemorySizeInGbs: dbSystemInstanceMemorySizeInGbs,
    instanceOcpuCount: dbSystemInstanceOcpuCount,
    instancesDetails: [{
        description: dbSystemInstancesDetailsDescription,
        displayName: dbSystemInstancesDetailsDisplayName,
        privateIp: dbSystemInstancesDetailsPrivateIp,
    }],
    managementPolicy: {
        backupPolicy: {
            backupStart: dbSystemManagementPolicyBackupPolicyBackupStart,
            copyPolicy: {
                compartmentId: compartmentId,
                regions: dbSystemManagementPolicyBackupPolicyCopyPolicyRegions,
                retentionPeriod: dbSystemManagementPolicyBackupPolicyCopyPolicyRetentionPeriod,
            },
            daysOfTheMonths: dbSystemManagementPolicyBackupPolicyDaysOfTheMonth,
            daysOfTheWeeks: dbSystemManagementPolicyBackupPolicyDaysOfTheWeek,
            kind: dbSystemManagementPolicyBackupPolicyKind,
            retentionDays: dbSystemManagementPolicyBackupPolicyRetentionDays,
        },
        maintenanceWindowStart: dbSystemManagementPolicyMaintenanceWindowStart,
    },
    source: {
        sourceType: dbSystemSourceSourceType,
        backupId: testBackup.id,
        isHavingRestoreConfigOverrides: dbSystemSourceIsHavingRestoreConfigOverrides,
    },
    systemType: dbSystemSystemType,
    patchOperations: [{
        operation: dbSystemPatchOperationsOperation,
        selection: dbSystemPatchOperationsSelection,
        value: dbSystemPatchOperationsValue,
    }],
});
import pulumi
import pulumi_oci as oci
test_db_system = oci.psql.DbSystem("test_db_system",
    compartment_id=compartment_id,
    credentials={
        "password_details": {
            "password_type": db_system_credentials_password_details_password_type,
            "password": db_system_credentials_password_details_password,
            "secret_id": test_secret["id"],
            "secret_version": db_system_credentials_password_details_secret_version,
        },
        "username": db_system_credentials_username,
    },
    db_version=db_system_db_version,
    display_name=db_system_display_name,
    network_details={
        "subnet_id": test_subnet["id"],
        "is_reader_endpoint_enabled": db_system_network_details_is_reader_endpoint_enabled,
        "nsg_ids": db_system_network_details_nsg_ids,
        "primary_db_endpoint_private_ip": db_system_network_details_primary_db_endpoint_private_ip,
    },
    shape=db_system_shape,
    storage_details={
        "is_regionally_durable": db_system_storage_details_is_regionally_durable,
        "system_type": db_system_storage_details_system_type,
        "availability_domain": db_system_storage_details_availability_domain,
        "iops": db_system_storage_details_iops,
    },
    config_id=test_config["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=db_system_description,
    freeform_tags={
        "bar-key": "value",
    },
    instance_count=db_system_instance_count,
    instance_memory_size_in_gbs=db_system_instance_memory_size_in_gbs,
    instance_ocpu_count=db_system_instance_ocpu_count,
    instances_details=[{
        "description": db_system_instances_details_description,
        "display_name": db_system_instances_details_display_name,
        "private_ip": db_system_instances_details_private_ip,
    }],
    management_policy={
        "backup_policy": {
            "backup_start": db_system_management_policy_backup_policy_backup_start,
            "copy_policy": {
                "compartment_id": compartment_id,
                "regions": db_system_management_policy_backup_policy_copy_policy_regions,
                "retention_period": db_system_management_policy_backup_policy_copy_policy_retention_period,
            },
            "days_of_the_months": db_system_management_policy_backup_policy_days_of_the_month,
            "days_of_the_weeks": db_system_management_policy_backup_policy_days_of_the_week,
            "kind": db_system_management_policy_backup_policy_kind,
            "retention_days": db_system_management_policy_backup_policy_retention_days,
        },
        "maintenance_window_start": db_system_management_policy_maintenance_window_start,
    },
    source={
        "source_type": db_system_source_source_type,
        "backup_id": test_backup["id"],
        "is_having_restore_config_overrides": db_system_source_is_having_restore_config_overrides,
    },
    system_type=db_system_system_type,
    patch_operations=[{
        "operation": db_system_patch_operations_operation,
        "selection": db_system_patch_operations_selection,
        "value": db_system_patch_operations_value,
    }])
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.NewDbSystem(ctx, "test_db_system", &psql.DbSystemArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Credentials: &psql.DbSystemCredentialsArgs{
				PasswordDetails: &psql.DbSystemCredentialsPasswordDetailsArgs{
					PasswordType:  pulumi.Any(dbSystemCredentialsPasswordDetailsPasswordType),
					Password:      pulumi.Any(dbSystemCredentialsPasswordDetailsPassword),
					SecretId:      pulumi.Any(testSecret.Id),
					SecretVersion: pulumi.Any(dbSystemCredentialsPasswordDetailsSecretVersion),
				},
				Username: pulumi.Any(dbSystemCredentialsUsername),
			},
			DbVersion:   pulumi.Any(dbSystemDbVersion),
			DisplayName: pulumi.Any(dbSystemDisplayName),
			NetworkDetails: &psql.DbSystemNetworkDetailsArgs{
				SubnetId:                   pulumi.Any(testSubnet.Id),
				IsReaderEndpointEnabled:    pulumi.Any(dbSystemNetworkDetailsIsReaderEndpointEnabled),
				NsgIds:                     pulumi.Any(dbSystemNetworkDetailsNsgIds),
				PrimaryDbEndpointPrivateIp: pulumi.Any(dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp),
			},
			Shape: pulumi.Any(dbSystemShape),
			StorageDetails: &psql.DbSystemStorageDetailsArgs{
				IsRegionallyDurable: pulumi.Any(dbSystemStorageDetailsIsRegionallyDurable),
				SystemType:          pulumi.Any(dbSystemStorageDetailsSystemType),
				AvailabilityDomain:  pulumi.Any(dbSystemStorageDetailsAvailabilityDomain),
				Iops:                pulumi.Any(dbSystemStorageDetailsIops),
			},
			ConfigId: pulumi.Any(testConfig.Id),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(dbSystemDescription),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			InstanceCount:           pulumi.Any(dbSystemInstanceCount),
			InstanceMemorySizeInGbs: pulumi.Any(dbSystemInstanceMemorySizeInGbs),
			InstanceOcpuCount:       pulumi.Any(dbSystemInstanceOcpuCount),
			InstancesDetails: psql.DbSystemInstancesDetailArray{
				&psql.DbSystemInstancesDetailArgs{
					Description: pulumi.Any(dbSystemInstancesDetailsDescription),
					DisplayName: pulumi.Any(dbSystemInstancesDetailsDisplayName),
					PrivateIp:   pulumi.Any(dbSystemInstancesDetailsPrivateIp),
				},
			},
			ManagementPolicy: &psql.DbSystemManagementPolicyArgs{
				BackupPolicy: &psql.DbSystemManagementPolicyBackupPolicyArgs{
					BackupStart: pulumi.Any(dbSystemManagementPolicyBackupPolicyBackupStart),
					CopyPolicy: &psql.DbSystemManagementPolicyBackupPolicyCopyPolicyArgs{
						CompartmentId:   pulumi.Any(compartmentId),
						Regions:         pulumi.Any(dbSystemManagementPolicyBackupPolicyCopyPolicyRegions),
						RetentionPeriod: pulumi.Any(dbSystemManagementPolicyBackupPolicyCopyPolicyRetentionPeriod),
					},
					DaysOfTheMonths: pulumi.Any(dbSystemManagementPolicyBackupPolicyDaysOfTheMonth),
					DaysOfTheWeeks:  pulumi.Any(dbSystemManagementPolicyBackupPolicyDaysOfTheWeek),
					Kind:            pulumi.Any(dbSystemManagementPolicyBackupPolicyKind),
					RetentionDays:   pulumi.Any(dbSystemManagementPolicyBackupPolicyRetentionDays),
				},
				MaintenanceWindowStart: pulumi.Any(dbSystemManagementPolicyMaintenanceWindowStart),
			},
			Source: &psql.DbSystemSourceArgs{
				SourceType:                     pulumi.Any(dbSystemSourceSourceType),
				BackupId:                       pulumi.Any(testBackup.Id),
				IsHavingRestoreConfigOverrides: pulumi.Any(dbSystemSourceIsHavingRestoreConfigOverrides),
			},
			SystemType: pulumi.Any(dbSystemSystemType),
			PatchOperations: psql.DbSystemPatchOperationArray{
				&psql.DbSystemPatchOperationArgs{
					Operation: pulumi.Any(dbSystemPatchOperationsOperation),
					Selection: pulumi.Any(dbSystemPatchOperationsSelection),
					Value:     pulumi.Any(dbSystemPatchOperationsValue),
				},
			},
		})
		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 = new Oci.Psql.DbSystem("test_db_system", new()
    {
        CompartmentId = compartmentId,
        Credentials = new Oci.Psql.Inputs.DbSystemCredentialsArgs
        {
            PasswordDetails = new Oci.Psql.Inputs.DbSystemCredentialsPasswordDetailsArgs
            {
                PasswordType = dbSystemCredentialsPasswordDetailsPasswordType,
                Password = dbSystemCredentialsPasswordDetailsPassword,
                SecretId = testSecret.Id,
                SecretVersion = dbSystemCredentialsPasswordDetailsSecretVersion,
            },
            Username = dbSystemCredentialsUsername,
        },
        DbVersion = dbSystemDbVersion,
        DisplayName = dbSystemDisplayName,
        NetworkDetails = new Oci.Psql.Inputs.DbSystemNetworkDetailsArgs
        {
            SubnetId = testSubnet.Id,
            IsReaderEndpointEnabled = dbSystemNetworkDetailsIsReaderEndpointEnabled,
            NsgIds = dbSystemNetworkDetailsNsgIds,
            PrimaryDbEndpointPrivateIp = dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp,
        },
        Shape = dbSystemShape,
        StorageDetails = new Oci.Psql.Inputs.DbSystemStorageDetailsArgs
        {
            IsRegionallyDurable = dbSystemStorageDetailsIsRegionallyDurable,
            SystemType = dbSystemStorageDetailsSystemType,
            AvailabilityDomain = dbSystemStorageDetailsAvailabilityDomain,
            Iops = dbSystemStorageDetailsIops,
        },
        ConfigId = testConfig.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = dbSystemDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        InstanceCount = dbSystemInstanceCount,
        InstanceMemorySizeInGbs = dbSystemInstanceMemorySizeInGbs,
        InstanceOcpuCount = dbSystemInstanceOcpuCount,
        InstancesDetails = new[]
        {
            new Oci.Psql.Inputs.DbSystemInstancesDetailArgs
            {
                Description = dbSystemInstancesDetailsDescription,
                DisplayName = dbSystemInstancesDetailsDisplayName,
                PrivateIp = dbSystemInstancesDetailsPrivateIp,
            },
        },
        ManagementPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyArgs
        {
            BackupPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyBackupPolicyArgs
            {
                BackupStart = dbSystemManagementPolicyBackupPolicyBackupStart,
                CopyPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyBackupPolicyCopyPolicyArgs
                {
                    CompartmentId = compartmentId,
                    Regions = dbSystemManagementPolicyBackupPolicyCopyPolicyRegions,
                    RetentionPeriod = dbSystemManagementPolicyBackupPolicyCopyPolicyRetentionPeriod,
                },
                DaysOfTheMonths = dbSystemManagementPolicyBackupPolicyDaysOfTheMonth,
                DaysOfTheWeeks = dbSystemManagementPolicyBackupPolicyDaysOfTheWeek,
                Kind = dbSystemManagementPolicyBackupPolicyKind,
                RetentionDays = dbSystemManagementPolicyBackupPolicyRetentionDays,
            },
            MaintenanceWindowStart = dbSystemManagementPolicyMaintenanceWindowStart,
        },
        Source = new Oci.Psql.Inputs.DbSystemSourceArgs
        {
            SourceType = dbSystemSourceSourceType,
            BackupId = testBackup.Id,
            IsHavingRestoreConfigOverrides = dbSystemSourceIsHavingRestoreConfigOverrides,
        },
        SystemType = dbSystemSystemType,
        PatchOperations = new[]
        {
            new Oci.Psql.Inputs.DbSystemPatchOperationArgs
            {
                Operation = dbSystemPatchOperationsOperation,
                Selection = dbSystemPatchOperationsSelection,
                Value = dbSystemPatchOperationsValue,
            },
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Psql.DbSystem;
import com.pulumi.oci.Psql.DbSystemArgs;
import com.pulumi.oci.Psql.inputs.DbSystemCredentialsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemCredentialsPasswordDetailsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemNetworkDetailsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemStorageDetailsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemInstancesDetailArgs;
import com.pulumi.oci.Psql.inputs.DbSystemManagementPolicyArgs;
import com.pulumi.oci.Psql.inputs.DbSystemManagementPolicyBackupPolicyArgs;
import com.pulumi.oci.Psql.inputs.DbSystemManagementPolicyBackupPolicyCopyPolicyArgs;
import com.pulumi.oci.Psql.inputs.DbSystemSourceArgs;
import com.pulumi.oci.Psql.inputs.DbSystemPatchOperationArgs;
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) {
        var testDbSystem = new DbSystem("testDbSystem", DbSystemArgs.builder()
            .compartmentId(compartmentId)
            .credentials(DbSystemCredentialsArgs.builder()
                .passwordDetails(DbSystemCredentialsPasswordDetailsArgs.builder()
                    .passwordType(dbSystemCredentialsPasswordDetailsPasswordType)
                    .password(dbSystemCredentialsPasswordDetailsPassword)
                    .secretId(testSecret.id())
                    .secretVersion(dbSystemCredentialsPasswordDetailsSecretVersion)
                    .build())
                .username(dbSystemCredentialsUsername)
                .build())
            .dbVersion(dbSystemDbVersion)
            .displayName(dbSystemDisplayName)
            .networkDetails(DbSystemNetworkDetailsArgs.builder()
                .subnetId(testSubnet.id())
                .isReaderEndpointEnabled(dbSystemNetworkDetailsIsReaderEndpointEnabled)
                .nsgIds(dbSystemNetworkDetailsNsgIds)
                .primaryDbEndpointPrivateIp(dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp)
                .build())
            .shape(dbSystemShape)
            .storageDetails(DbSystemStorageDetailsArgs.builder()
                .isRegionallyDurable(dbSystemStorageDetailsIsRegionallyDurable)
                .systemType(dbSystemStorageDetailsSystemType)
                .availabilityDomain(dbSystemStorageDetailsAvailabilityDomain)
                .iops(dbSystemStorageDetailsIops)
                .build())
            .configId(testConfig.id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(dbSystemDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .instanceCount(dbSystemInstanceCount)
            .instanceMemorySizeInGbs(dbSystemInstanceMemorySizeInGbs)
            .instanceOcpuCount(dbSystemInstanceOcpuCount)
            .instancesDetails(DbSystemInstancesDetailArgs.builder()
                .description(dbSystemInstancesDetailsDescription)
                .displayName(dbSystemInstancesDetailsDisplayName)
                .privateIp(dbSystemInstancesDetailsPrivateIp)
                .build())
            .managementPolicy(DbSystemManagementPolicyArgs.builder()
                .backupPolicy(DbSystemManagementPolicyBackupPolicyArgs.builder()
                    .backupStart(dbSystemManagementPolicyBackupPolicyBackupStart)
                    .copyPolicy(DbSystemManagementPolicyBackupPolicyCopyPolicyArgs.builder()
                        .compartmentId(compartmentId)
                        .regions(dbSystemManagementPolicyBackupPolicyCopyPolicyRegions)
                        .retentionPeriod(dbSystemManagementPolicyBackupPolicyCopyPolicyRetentionPeriod)
                        .build())
                    .daysOfTheMonths(dbSystemManagementPolicyBackupPolicyDaysOfTheMonth)
                    .daysOfTheWeeks(dbSystemManagementPolicyBackupPolicyDaysOfTheWeek)
                    .kind(dbSystemManagementPolicyBackupPolicyKind)
                    .retentionDays(dbSystemManagementPolicyBackupPolicyRetentionDays)
                    .build())
                .maintenanceWindowStart(dbSystemManagementPolicyMaintenanceWindowStart)
                .build())
            .source(DbSystemSourceArgs.builder()
                .sourceType(dbSystemSourceSourceType)
                .backupId(testBackup.id())
                .isHavingRestoreConfigOverrides(dbSystemSourceIsHavingRestoreConfigOverrides)
                .build())
            .systemType(dbSystemSystemType)
            .patchOperations(DbSystemPatchOperationArgs.builder()
                .operation(dbSystemPatchOperationsOperation)
                .selection(dbSystemPatchOperationsSelection)
                .value(dbSystemPatchOperationsValue)
                .build())
            .build());
    }
}
resources:
  testDbSystem:
    type: oci:Psql:DbSystem
    name: test_db_system
    properties:
      compartmentId: ${compartmentId}
      credentials:
        passwordDetails:
          passwordType: ${dbSystemCredentialsPasswordDetailsPasswordType}
          password: ${dbSystemCredentialsPasswordDetailsPassword}
          secretId: ${testSecret.id}
          secretVersion: ${dbSystemCredentialsPasswordDetailsSecretVersion}
        username: ${dbSystemCredentialsUsername}
      dbVersion: ${dbSystemDbVersion}
      displayName: ${dbSystemDisplayName}
      networkDetails:
        subnetId: ${testSubnet.id}
        isReaderEndpointEnabled: ${dbSystemNetworkDetailsIsReaderEndpointEnabled}
        nsgIds: ${dbSystemNetworkDetailsNsgIds}
        primaryDbEndpointPrivateIp: ${dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp}
      shape: ${dbSystemShape}
      storageDetails:
        isRegionallyDurable: ${dbSystemStorageDetailsIsRegionallyDurable}
        systemType: ${dbSystemStorageDetailsSystemType}
        availabilityDomain: ${dbSystemStorageDetailsAvailabilityDomain}
        iops: ${dbSystemStorageDetailsIops}
      configId: ${testConfig.id}
      definedTags:
        foo-namespace.bar-key: value
      description: ${dbSystemDescription}
      freeformTags:
        bar-key: value
      instanceCount: ${dbSystemInstanceCount}
      instanceMemorySizeInGbs: ${dbSystemInstanceMemorySizeInGbs}
      instanceOcpuCount: ${dbSystemInstanceOcpuCount}
      instancesDetails:
        - description: ${dbSystemInstancesDetailsDescription}
          displayName: ${dbSystemInstancesDetailsDisplayName}
          privateIp: ${dbSystemInstancesDetailsPrivateIp}
      managementPolicy:
        backupPolicy:
          backupStart: ${dbSystemManagementPolicyBackupPolicyBackupStart}
          copyPolicy:
            compartmentId: ${compartmentId}
            regions: ${dbSystemManagementPolicyBackupPolicyCopyPolicyRegions}
            retentionPeriod: ${dbSystemManagementPolicyBackupPolicyCopyPolicyRetentionPeriod}
          daysOfTheMonths: ${dbSystemManagementPolicyBackupPolicyDaysOfTheMonth}
          daysOfTheWeeks: ${dbSystemManagementPolicyBackupPolicyDaysOfTheWeek}
          kind: ${dbSystemManagementPolicyBackupPolicyKind}
          retentionDays: ${dbSystemManagementPolicyBackupPolicyRetentionDays}
        maintenanceWindowStart: ${dbSystemManagementPolicyMaintenanceWindowStart}
      source:
        sourceType: ${dbSystemSourceSourceType}
        backupId: ${testBackup.id}
        isHavingRestoreConfigOverrides: ${dbSystemSourceIsHavingRestoreConfigOverrides}
      systemType: ${dbSystemSystemType}
      patchOperations:
        - operation: ${dbSystemPatchOperationsOperation}
          selection: ${dbSystemPatchOperationsSelection}
          value: ${dbSystemPatchOperationsValue}
Create DbSystem Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DbSystem(name: string, args: DbSystemArgs, opts?: CustomResourceOptions);@overload
def DbSystem(resource_name: str,
             args: DbSystemArgs,
             opts: Optional[ResourceOptions] = None)
@overload
def DbSystem(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             display_name: Optional[str] = None,
             compartment_id: Optional[str] = None,
             storage_details: Optional[DbSystemStorageDetailsArgs] = None,
             shape: Optional[str] = None,
             db_version: Optional[str] = None,
             network_details: Optional[DbSystemNetworkDetailsArgs] = None,
             instance_memory_size_in_gbs: Optional[int] = None,
             management_policy: Optional[DbSystemManagementPolicyArgs] = None,
             freeform_tags: Optional[Mapping[str, str]] = None,
             instance_count: Optional[int] = None,
             apply_config: Optional[str] = None,
             instance_ocpu_count: Optional[int] = None,
             instances_details: Optional[Sequence[DbSystemInstancesDetailArgs]] = None,
             description: Optional[str] = None,
             defined_tags: Optional[Mapping[str, str]] = None,
             patch_operations: Optional[Sequence[DbSystemPatchOperationArgs]] = None,
             credentials: Optional[DbSystemCredentialsArgs] = None,
             source: Optional[DbSystemSourceArgs] = None,
             config_id: Optional[str] = None,
             system_type: Optional[str] = None)func NewDbSystem(ctx *Context, name string, args DbSystemArgs, opts ...ResourceOption) (*DbSystem, error)public DbSystem(string name, DbSystemArgs args, CustomResourceOptions? opts = null)
public DbSystem(String name, DbSystemArgs args)
public DbSystem(String name, DbSystemArgs args, CustomResourceOptions options)
type: oci:Psql:DbSystem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DbSystemArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DbSystemArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DbSystemArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DbSystemArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DbSystemArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var ociDbSystemResource = new Oci.Psql.DbSystem("ociDbSystemResource", new()
{
    DisplayName = "string",
    CompartmentId = "string",
    StorageDetails = new Oci.Psql.Inputs.DbSystemStorageDetailsArgs
    {
        IsRegionallyDurable = false,
        SystemType = "string",
        AvailabilityDomain = "string",
        Iops = "string",
    },
    Shape = "string",
    DbVersion = "string",
    NetworkDetails = new Oci.Psql.Inputs.DbSystemNetworkDetailsArgs
    {
        SubnetId = "string",
        IsReaderEndpointEnabled = false,
        NsgIds = new[]
        {
            "string",
        },
        PrimaryDbEndpointPrivateIp = "string",
    },
    InstanceMemorySizeInGbs = 0,
    ManagementPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyArgs
    {
        BackupPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyBackupPolicyArgs
        {
            BackupStart = "string",
            CopyPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyBackupPolicyCopyPolicyArgs
            {
                CompartmentId = "string",
                Regions = new[]
                {
                    "string",
                },
                RetentionPeriod = 0,
            },
            DaysOfTheMonths = new[]
            {
                0,
            },
            DaysOfTheWeeks = new[]
            {
                "string",
            },
            Kind = "string",
            RetentionDays = 0,
        },
        MaintenanceWindowStart = "string",
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    InstanceCount = 0,
    ApplyConfig = "string",
    InstanceOcpuCount = 0,
    InstancesDetails = new[]
    {
        new Oci.Psql.Inputs.DbSystemInstancesDetailArgs
        {
            Description = "string",
            DisplayName = "string",
            PrivateIp = "string",
        },
    },
    Description = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    PatchOperations = new[]
    {
        new Oci.Psql.Inputs.DbSystemPatchOperationArgs
        {
            Operation = "string",
            Selection = "string",
            From = "string",
            Position = "string",
            SelectedItem = "string",
            Value = 
            {
                { "string", "string" },
            },
        },
    },
    Credentials = new Oci.Psql.Inputs.DbSystemCredentialsArgs
    {
        PasswordDetails = new Oci.Psql.Inputs.DbSystemCredentialsPasswordDetailsArgs
        {
            PasswordType = "string",
            Password = "string",
            SecretId = "string",
            SecretVersion = "string",
        },
        Username = "string",
    },
    Source = new Oci.Psql.Inputs.DbSystemSourceArgs
    {
        SourceType = "string",
        BackupId = "string",
        IsHavingRestoreConfigOverrides = false,
    },
    ConfigId = "string",
    SystemType = "string",
});
example, err := psql.NewDbSystem(ctx, "ociDbSystemResource", &psql.DbSystemArgs{
	DisplayName:   pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	StorageDetails: &psql.DbSystemStorageDetailsArgs{
		IsRegionallyDurable: pulumi.Bool(false),
		SystemType:          pulumi.String("string"),
		AvailabilityDomain:  pulumi.String("string"),
		Iops:                pulumi.String("string"),
	},
	Shape:     pulumi.String("string"),
	DbVersion: pulumi.String("string"),
	NetworkDetails: &psql.DbSystemNetworkDetailsArgs{
		SubnetId:                pulumi.String("string"),
		IsReaderEndpointEnabled: pulumi.Bool(false),
		NsgIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrimaryDbEndpointPrivateIp: pulumi.String("string"),
	},
	InstanceMemorySizeInGbs: pulumi.Int(0),
	ManagementPolicy: &psql.DbSystemManagementPolicyArgs{
		BackupPolicy: &psql.DbSystemManagementPolicyBackupPolicyArgs{
			BackupStart: pulumi.String("string"),
			CopyPolicy: &psql.DbSystemManagementPolicyBackupPolicyCopyPolicyArgs{
				CompartmentId: pulumi.String("string"),
				Regions: pulumi.StringArray{
					pulumi.String("string"),
				},
				RetentionPeriod: pulumi.Int(0),
			},
			DaysOfTheMonths: pulumi.IntArray{
				pulumi.Int(0),
			},
			DaysOfTheWeeks: pulumi.StringArray{
				pulumi.String("string"),
			},
			Kind:          pulumi.String("string"),
			RetentionDays: pulumi.Int(0),
		},
		MaintenanceWindowStart: pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	InstanceCount:     pulumi.Int(0),
	ApplyConfig:       pulumi.String("string"),
	InstanceOcpuCount: pulumi.Int(0),
	InstancesDetails: psql.DbSystemInstancesDetailArray{
		&psql.DbSystemInstancesDetailArgs{
			Description: pulumi.String("string"),
			DisplayName: pulumi.String("string"),
			PrivateIp:   pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PatchOperations: psql.DbSystemPatchOperationArray{
		&psql.DbSystemPatchOperationArgs{
			Operation:    pulumi.String("string"),
			Selection:    pulumi.String("string"),
			From:         pulumi.String("string"),
			Position:     pulumi.String("string"),
			SelectedItem: pulumi.String("string"),
			Value: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	Credentials: &psql.DbSystemCredentialsArgs{
		PasswordDetails: &psql.DbSystemCredentialsPasswordDetailsArgs{
			PasswordType:  pulumi.String("string"),
			Password:      pulumi.String("string"),
			SecretId:      pulumi.String("string"),
			SecretVersion: pulumi.String("string"),
		},
		Username: pulumi.String("string"),
	},
	Source: &psql.DbSystemSourceArgs{
		SourceType:                     pulumi.String("string"),
		BackupId:                       pulumi.String("string"),
		IsHavingRestoreConfigOverrides: pulumi.Bool(false),
	},
	ConfigId:   pulumi.String("string"),
	SystemType: pulumi.String("string"),
})
var ociDbSystemResource = new com.pulumi.oci.Psql.DbSystem("ociDbSystemResource", com.pulumi.oci.Psql.DbSystemArgs.builder()
    .displayName("string")
    .compartmentId("string")
    .storageDetails(DbSystemStorageDetailsArgs.builder()
        .isRegionallyDurable(false)
        .systemType("string")
        .availabilityDomain("string")
        .iops("string")
        .build())
    .shape("string")
    .dbVersion("string")
    .networkDetails(DbSystemNetworkDetailsArgs.builder()
        .subnetId("string")
        .isReaderEndpointEnabled(false)
        .nsgIds("string")
        .primaryDbEndpointPrivateIp("string")
        .build())
    .instanceMemorySizeInGbs(0)
    .managementPolicy(DbSystemManagementPolicyArgs.builder()
        .backupPolicy(DbSystemManagementPolicyBackupPolicyArgs.builder()
            .backupStart("string")
            .copyPolicy(DbSystemManagementPolicyBackupPolicyCopyPolicyArgs.builder()
                .compartmentId("string")
                .regions("string")
                .retentionPeriod(0)
                .build())
            .daysOfTheMonths(0)
            .daysOfTheWeeks("string")
            .kind("string")
            .retentionDays(0)
            .build())
        .maintenanceWindowStart("string")
        .build())
    .freeformTags(Map.of("string", "string"))
    .instanceCount(0)
    .applyConfig("string")
    .instanceOcpuCount(0)
    .instancesDetails(DbSystemInstancesDetailArgs.builder()
        .description("string")
        .displayName("string")
        .privateIp("string")
        .build())
    .description("string")
    .definedTags(Map.of("string", "string"))
    .patchOperations(DbSystemPatchOperationArgs.builder()
        .operation("string")
        .selection("string")
        .from("string")
        .position("string")
        .selectedItem("string")
        .value(Map.of("string", "string"))
        .build())
    .credentials(DbSystemCredentialsArgs.builder()
        .passwordDetails(DbSystemCredentialsPasswordDetailsArgs.builder()
            .passwordType("string")
            .password("string")
            .secretId("string")
            .secretVersion("string")
            .build())
        .username("string")
        .build())
    .source(DbSystemSourceArgs.builder()
        .sourceType("string")
        .backupId("string")
        .isHavingRestoreConfigOverrides(false)
        .build())
    .configId("string")
    .systemType("string")
    .build());
oci_db_system_resource = oci.psql.DbSystem("ociDbSystemResource",
    display_name="string",
    compartment_id="string",
    storage_details={
        "is_regionally_durable": False,
        "system_type": "string",
        "availability_domain": "string",
        "iops": "string",
    },
    shape="string",
    db_version="string",
    network_details={
        "subnet_id": "string",
        "is_reader_endpoint_enabled": False,
        "nsg_ids": ["string"],
        "primary_db_endpoint_private_ip": "string",
    },
    instance_memory_size_in_gbs=0,
    management_policy={
        "backup_policy": {
            "backup_start": "string",
            "copy_policy": {
                "compartment_id": "string",
                "regions": ["string"],
                "retention_period": 0,
            },
            "days_of_the_months": [0],
            "days_of_the_weeks": ["string"],
            "kind": "string",
            "retention_days": 0,
        },
        "maintenance_window_start": "string",
    },
    freeform_tags={
        "string": "string",
    },
    instance_count=0,
    apply_config="string",
    instance_ocpu_count=0,
    instances_details=[{
        "description": "string",
        "display_name": "string",
        "private_ip": "string",
    }],
    description="string",
    defined_tags={
        "string": "string",
    },
    patch_operations=[{
        "operation": "string",
        "selection": "string",
        "from_": "string",
        "position": "string",
        "selected_item": "string",
        "value": {
            "string": "string",
        },
    }],
    credentials={
        "password_details": {
            "password_type": "string",
            "password": "string",
            "secret_id": "string",
            "secret_version": "string",
        },
        "username": "string",
    },
    source={
        "source_type": "string",
        "backup_id": "string",
        "is_having_restore_config_overrides": False,
    },
    config_id="string",
    system_type="string")
const ociDbSystemResource = new oci.psql.DbSystem("ociDbSystemResource", {
    displayName: "string",
    compartmentId: "string",
    storageDetails: {
        isRegionallyDurable: false,
        systemType: "string",
        availabilityDomain: "string",
        iops: "string",
    },
    shape: "string",
    dbVersion: "string",
    networkDetails: {
        subnetId: "string",
        isReaderEndpointEnabled: false,
        nsgIds: ["string"],
        primaryDbEndpointPrivateIp: "string",
    },
    instanceMemorySizeInGbs: 0,
    managementPolicy: {
        backupPolicy: {
            backupStart: "string",
            copyPolicy: {
                compartmentId: "string",
                regions: ["string"],
                retentionPeriod: 0,
            },
            daysOfTheMonths: [0],
            daysOfTheWeeks: ["string"],
            kind: "string",
            retentionDays: 0,
        },
        maintenanceWindowStart: "string",
    },
    freeformTags: {
        string: "string",
    },
    instanceCount: 0,
    applyConfig: "string",
    instanceOcpuCount: 0,
    instancesDetails: [{
        description: "string",
        displayName: "string",
        privateIp: "string",
    }],
    description: "string",
    definedTags: {
        string: "string",
    },
    patchOperations: [{
        operation: "string",
        selection: "string",
        from: "string",
        position: "string",
        selectedItem: "string",
        value: {
            string: "string",
        },
    }],
    credentials: {
        passwordDetails: {
            passwordType: "string",
            password: "string",
            secretId: "string",
            secretVersion: "string",
        },
        username: "string",
    },
    source: {
        sourceType: "string",
        backupId: "string",
        isHavingRestoreConfigOverrides: false,
    },
    configId: "string",
    systemType: "string",
});
type: oci:Psql:DbSystem
properties:
    applyConfig: string
    compartmentId: string
    configId: string
    credentials:
        passwordDetails:
            password: string
            passwordType: string
            secretId: string
            secretVersion: string
        username: string
    dbVersion: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    instanceCount: 0
    instanceMemorySizeInGbs: 0
    instanceOcpuCount: 0
    instancesDetails:
        - description: string
          displayName: string
          privateIp: string
    managementPolicy:
        backupPolicy:
            backupStart: string
            copyPolicy:
                compartmentId: string
                regions:
                    - string
                retentionPeriod: 0
            daysOfTheMonths:
                - 0
            daysOfTheWeeks:
                - string
            kind: string
            retentionDays: 0
        maintenanceWindowStart: string
    networkDetails:
        isReaderEndpointEnabled: false
        nsgIds:
            - string
        primaryDbEndpointPrivateIp: string
        subnetId: string
    patchOperations:
        - from: string
          operation: string
          position: string
          selectedItem: string
          selection: string
          value:
            string: string
    shape: string
    source:
        backupId: string
        isHavingRestoreConfigOverrides: false
        sourceType: string
    storageDetails:
        availabilityDomain: string
        iops: string
        isRegionallyDurable: false
        systemType: string
    systemType: string
DbSystem Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DbSystem resource accepts the following input properties:
- CompartmentId string
- (Updatable) The OCID of the compartment that contains the database system.
- DbVersion string
- Version of database system software.
- DisplayName string
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- NetworkDetails DbSystem Network Details 
- (Updatable) Network details for the database system.
- Shape string
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- StorageDetails DbSystem Storage Details 
- (Updatable) Storage details of the database system.
- ApplyConfig string
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- ConfigId string
- The OCID of the configuration associated with the database system.
- Credentials
DbSystem Credentials 
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A user-provided description of a database system.
- Dictionary<string, string>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- InstanceCount int
- Count of database instances nodes to be created in the database system.
- InstanceMemory intSize In Gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- InstanceOcpu intCount 
- (Updatable) The total number of OCPUs available to each database instance node.
- InstancesDetails List<DbSystem Instances Detail> 
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- ManagementPolicy DbSystem Management Policy 
- (Updatable) PostgreSQL database system management policy update details.
- PatchOperations List<DbSystem Patch Operation> 
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- Source
DbSystem Source 
- The source used to restore the database system.
- SystemType string
- Type of the database system. - ** 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 
- CompartmentId string
- (Updatable) The OCID of the compartment that contains the database system.
- DbVersion string
- Version of database system software.
- DisplayName string
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- NetworkDetails DbSystem Network Details Args 
- (Updatable) Network details for the database system.
- Shape string
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- StorageDetails DbSystem Storage Details Args 
- (Updatable) Storage details of the database system.
- ApplyConfig string
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- ConfigId string
- The OCID of the configuration associated with the database system.
- Credentials
DbSystem Credentials Args 
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A user-provided description of a database system.
- map[string]string
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- InstanceCount int
- Count of database instances nodes to be created in the database system.
- InstanceMemory intSize In Gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- InstanceOcpu intCount 
- (Updatable) The total number of OCPUs available to each database instance node.
- InstancesDetails []DbSystem Instances Detail Args 
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- ManagementPolicy DbSystem Management Policy Args 
- (Updatable) PostgreSQL database system management policy update details.
- PatchOperations []DbSystem Patch Operation Args 
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- Source
DbSystem Source Args 
- The source used to restore the database system.
- SystemType string
- Type of the database system. - ** 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 
- compartmentId String
- (Updatable) The OCID of the compartment that contains the database system.
- dbVersion String
- Version of database system software.
- displayName String
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- networkDetails DbSystem Network Details 
- (Updatable) Network details for the database system.
- shape String
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- storageDetails DbSystem Storage Details 
- (Updatable) Storage details of the database system.
- applyConfig String
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- configId String
- The OCID of the configuration associated with the database system.
- credentials
DbSystem Credentials 
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A user-provided description of a database system.
- Map<String,String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- instanceCount Integer
- Count of database instances nodes to be created in the database system.
- instanceMemory IntegerSize In Gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- instanceOcpu IntegerCount 
- (Updatable) The total number of OCPUs available to each database instance node.
- instancesDetails List<DbSystem Instances Detail> 
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- managementPolicy DbSystem Management Policy 
- (Updatable) PostgreSQL database system management policy update details.
- patchOperations List<DbSystem Patch Operation> 
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- source
DbSystem Source 
- The source used to restore the database system.
- systemType String
- Type of the database system. - ** 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 
- compartmentId string
- (Updatable) The OCID of the compartment that contains the database system.
- dbVersion string
- Version of database system software.
- displayName string
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- networkDetails DbSystem Network Details 
- (Updatable) Network details for the database system.
- shape string
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- storageDetails DbSystem Storage Details 
- (Updatable) Storage details of the database system.
- applyConfig string
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- configId string
- The OCID of the configuration associated with the database system.
- credentials
DbSystem Credentials 
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description string
- (Updatable) A user-provided description of a database system.
- {[key: string]: string}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- instanceCount number
- Count of database instances nodes to be created in the database system.
- instanceMemory numberSize In Gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- instanceOcpu numberCount 
- (Updatable) The total number of OCPUs available to each database instance node.
- instancesDetails DbSystem Instances Detail[] 
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- managementPolicy DbSystem Management Policy 
- (Updatable) PostgreSQL database system management policy update details.
- patchOperations DbSystem Patch Operation[] 
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- source
DbSystem Source 
- The source used to restore the database system.
- systemType string
- Type of the database system. - ** 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 
- compartment_id str
- (Updatable) The OCID of the compartment that contains the database system.
- db_version str
- Version of database system software.
- display_name str
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- network_details DbSystem Network Details Args 
- (Updatable) Network details for the database system.
- shape str
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- storage_details DbSystem Storage Details Args 
- (Updatable) Storage details of the database system.
- apply_config str
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- config_id str
- The OCID of the configuration associated with the database system.
- credentials
DbSystem Credentials Args 
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description str
- (Updatable) A user-provided description of a database system.
- Mapping[str, str]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- instance_count int
- Count of database instances nodes to be created in the database system.
- instance_memory_ intsize_ in_ gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- instance_ocpu_ intcount 
- (Updatable) The total number of OCPUs available to each database instance node.
- instances_details Sequence[DbSystem Instances Detail Args] 
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- management_policy DbSystem Management Policy Args 
- (Updatable) PostgreSQL database system management policy update details.
- patch_operations Sequence[DbSystem Patch Operation Args] 
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- source
DbSystem Source Args 
- The source used to restore the database system.
- system_type str
- Type of the database system. - ** 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 
- compartmentId String
- (Updatable) The OCID of the compartment that contains the database system.
- dbVersion String
- Version of database system software.
- displayName String
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- networkDetails Property Map
- (Updatable) Network details for the database system.
- shape String
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- storageDetails Property Map
- (Updatable) Storage details of the database system.
- applyConfig String
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- configId String
- The OCID of the configuration associated with the database system.
- credentials Property Map
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A user-provided description of a database system.
- Map<String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- instanceCount Number
- Count of database instances nodes to be created in the database system.
- instanceMemory NumberSize In Gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- instanceOcpu NumberCount 
- (Updatable) The total number of OCPUs available to each database instance node.
- instancesDetails List<Property Map>
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- managementPolicy Property Map
- (Updatable) PostgreSQL database system management policy update details.
- patchOperations List<Property Map>
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- source Property Map
- The source used to restore the database system.
- systemType String
- Type of the database system. - ** 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 
Outputs
All input properties are implicitly available as output properties. Additionally, the DbSystem resource produces the following output properties:
- AdminUsername string
- The database system administrator username.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instances
List<DbSystem Instance> 
- The list of instances, or nodes, in the database system.
- 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.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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
- AdminUsername string
- The database system administrator username.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instances
[]DbSystem Instance 
- The list of instances, or nodes, in the database system.
- 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.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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
- adminUsername String
- The database system administrator username.
- id String
- The provider-assigned unique ID for this managed resource.
- instances
List<DbSystem Instance> 
- The list of instances, or nodes, in the database system.
- 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.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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
- adminUsername string
- The database system administrator username.
- id string
- The provider-assigned unique ID for this managed resource.
- instances
DbSystem Instance[] 
- The list of instances, or nodes, in the database system.
- 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.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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
- admin_username str
- The database system administrator username.
- id str
- The provider-assigned unique ID for this managed resource.
- instances
Sequence[DbSystem Instance] 
- The list of instances, or nodes, in the database system.
- 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.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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
- adminUsername String
- The database system administrator username.
- id String
- The provider-assigned unique ID for this managed resource.
- instances List<Property Map>
- The list of instances, or nodes, in the database system.
- 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.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- 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
Look up Existing DbSystem Resource
Get an existing DbSystem resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DbSystemState, opts?: CustomResourceOptions): DbSystem@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_username: Optional[str] = None,
        apply_config: Optional[str] = None,
        compartment_id: Optional[str] = None,
        config_id: Optional[str] = None,
        credentials: Optional[DbSystemCredentialsArgs] = None,
        db_version: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        instance_count: Optional[int] = None,
        instance_memory_size_in_gbs: Optional[int] = None,
        instance_ocpu_count: Optional[int] = None,
        instances: Optional[Sequence[DbSystemInstanceArgs]] = None,
        instances_details: Optional[Sequence[DbSystemInstancesDetailArgs]] = None,
        lifecycle_details: Optional[str] = None,
        management_policy: Optional[DbSystemManagementPolicyArgs] = None,
        network_details: Optional[DbSystemNetworkDetailsArgs] = None,
        patch_operations: Optional[Sequence[DbSystemPatchOperationArgs]] = None,
        shape: Optional[str] = None,
        source: Optional[DbSystemSourceArgs] = None,
        state: Optional[str] = None,
        storage_details: Optional[DbSystemStorageDetailsArgs] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        system_type: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> DbSystemfunc GetDbSystem(ctx *Context, name string, id IDInput, state *DbSystemState, opts ...ResourceOption) (*DbSystem, error)public static DbSystem Get(string name, Input<string> id, DbSystemState? state, CustomResourceOptions? opts = null)public static DbSystem get(String name, Output<String> id, DbSystemState state, CustomResourceOptions options)resources:  _:    type: oci:Psql:DbSystem    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- AdminUsername string
- The database system administrator username.
- ApplyConfig string
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- CompartmentId string
- (Updatable) The OCID of the compartment that contains the database system.
- ConfigId string
- The OCID of the configuration associated with the database system.
- Credentials
DbSystem Credentials 
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- DbVersion string
- Version of database system software.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A user-provided description of a database system.
- DisplayName string
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- InstanceCount int
- Count of database instances nodes to be created in the database system.
- InstanceMemory intSize In Gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- InstanceOcpu intCount 
- (Updatable) The total number of OCPUs available to each database instance node.
- Instances
List<DbSystem Instance> 
- The list of instances, or nodes, in the database system.
- InstancesDetails List<DbSystem Instances Detail> 
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- 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.
- ManagementPolicy DbSystem Management Policy 
- (Updatable) PostgreSQL database system management policy update details.
- NetworkDetails DbSystem Network Details 
- (Updatable) Network details for the database system.
- PatchOperations List<DbSystem Patch Operation> 
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- Shape string
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- Source
DbSystem Source 
- The source used to restore the database system.
- State string
- The current state of the database system.
- StorageDetails DbSystem Storage Details 
- (Updatable) Storage details of the database system.
- 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. - ** 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 
- 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
- AdminUsername string
- The database system administrator username.
- ApplyConfig string
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- CompartmentId string
- (Updatable) The OCID of the compartment that contains the database system.
- ConfigId string
- The OCID of the configuration associated with the database system.
- Credentials
DbSystem Credentials Args 
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- DbVersion string
- Version of database system software.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A user-provided description of a database system.
- DisplayName string
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- map[string]string
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- InstanceCount int
- Count of database instances nodes to be created in the database system.
- InstanceMemory intSize In Gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- InstanceOcpu intCount 
- (Updatable) The total number of OCPUs available to each database instance node.
- Instances
[]DbSystem Instance Args 
- The list of instances, or nodes, in the database system.
- InstancesDetails []DbSystem Instances Detail Args 
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- 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.
- ManagementPolicy DbSystem Management Policy Args 
- (Updatable) PostgreSQL database system management policy update details.
- NetworkDetails DbSystem Network Details Args 
- (Updatable) Network details for the database system.
- PatchOperations []DbSystem Patch Operation Args 
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- Shape string
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- Source
DbSystem Source Args 
- The source used to restore the database system.
- State string
- The current state of the database system.
- StorageDetails DbSystem Storage Details Args 
- (Updatable) Storage details of the database system.
- 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. - ** 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 
- 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
- adminUsername String
- The database system administrator username.
- applyConfig String
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- compartmentId String
- (Updatable) The OCID of the compartment that contains the database system.
- configId String
- The OCID of the configuration associated with the database system.
- credentials
DbSystem Credentials 
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- dbVersion String
- Version of database system software.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A user-provided description of a database system.
- displayName String
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Map<String,String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- instanceCount Integer
- Count of database instances nodes to be created in the database system.
- instanceMemory IntegerSize In Gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- instanceOcpu IntegerCount 
- (Updatable) The total number of OCPUs available to each database instance node.
- instances
List<DbSystem Instance> 
- The list of instances, or nodes, in the database system.
- instancesDetails List<DbSystem Instances Detail> 
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- 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.
- managementPolicy DbSystem Management Policy 
- (Updatable) PostgreSQL database system management policy update details.
- networkDetails DbSystem Network Details 
- (Updatable) Network details for the database system.
- patchOperations List<DbSystem Patch Operation> 
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- shape String
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- source
DbSystem Source 
- The source used to restore the database system.
- state String
- The current state of the database system.
- storageDetails DbSystem Storage Details 
- (Updatable) Storage details of the database system.
- 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. - ** 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 
- 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
- adminUsername string
- The database system administrator username.
- applyConfig string
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- compartmentId string
- (Updatable) The OCID of the compartment that contains the database system.
- configId string
- The OCID of the configuration associated with the database system.
- credentials
DbSystem Credentials 
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- dbVersion string
- Version of database system software.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description string
- (Updatable) A user-provided description of a database system.
- displayName string
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- instanceCount number
- Count of database instances nodes to be created in the database system.
- instanceMemory numberSize In Gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- instanceOcpu numberCount 
- (Updatable) The total number of OCPUs available to each database instance node.
- instances
DbSystem Instance[] 
- The list of instances, or nodes, in the database system.
- instancesDetails DbSystem Instances Detail[] 
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- 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.
- managementPolicy DbSystem Management Policy 
- (Updatable) PostgreSQL database system management policy update details.
- networkDetails DbSystem Network Details 
- (Updatable) Network details for the database system.
- patchOperations DbSystem Patch Operation[] 
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- shape string
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- source
DbSystem Source 
- The source used to restore the database system.
- state string
- The current state of the database system.
- storageDetails DbSystem Storage Details 
- (Updatable) Storage details of the database system.
- {[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. - ** 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 
- 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
- admin_username str
- The database system administrator username.
- apply_config str
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- compartment_id str
- (Updatable) The OCID of the compartment that contains the database system.
- config_id str
- The OCID of the configuration associated with the database system.
- credentials
DbSystem Credentials Args 
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- db_version str
- Version of database system software.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description str
- (Updatable) A user-provided description of a database system.
- display_name str
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- instance_count int
- Count of database instances nodes to be created in the database system.
- instance_memory_ intsize_ in_ gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- instance_ocpu_ intcount 
- (Updatable) The total number of OCPUs available to each database instance node.
- instances
Sequence[DbSystem Instance Args] 
- The list of instances, or nodes, in the database system.
- instances_details Sequence[DbSystem Instances Detail Args] 
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- 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_policy DbSystem Management Policy Args 
- (Updatable) PostgreSQL database system management policy update details.
- network_details DbSystem Network Details Args 
- (Updatable) Network details for the database system.
- patch_operations Sequence[DbSystem Patch Operation Args] 
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- shape str
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- source
DbSystem Source Args 
- The source used to restore the database system.
- state str
- The current state of the database system.
- storage_details DbSystem Storage Details Args 
- (Updatable) Storage details of the database system.
- 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. - ** 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 
- 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
- adminUsername String
- The database system administrator username.
- applyConfig String
- Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as RESTARTorRELOAD
- compartmentId String
- (Updatable) The OCID of the compartment that contains the database system.
- configId String
- The OCID of the configuration associated with the database system.
- credentials Property Map
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- dbVersion String
- Version of database system software.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A user-provided description of a database system.
- displayName String
- (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Map<String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- instanceCount Number
- Count of database instances nodes to be created in the database system.
- instanceMemory NumberSize In Gbs 
- (Updatable) The total amount of memory available to each database instance node, in gigabytes.
- instanceOcpu NumberCount 
- (Updatable) 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>
- Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.
- 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.
- managementPolicy Property Map
- (Updatable) PostgreSQL database system management policy update details.
- networkDetails Property Map
- (Updatable) Network details for the database system.
- patchOperations List<Property Map>
- (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- shape String
- (Updatable) The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: VM.Standard.E4.Flex
- source Property Map
- The source used to restore the database system.
- state String
- The current state of the database system.
- storageDetails Property Map
- (Updatable) Storage details of the database system.
- 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. - ** 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 
- 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
Supporting Types
DbSystemCredentials, DbSystemCredentialsArgs      
- PasswordDetails DbSystem Credentials Password Details 
- Details for the database system password. Password can be passed as VaultSecretPasswordDetailsorPlainTextPasswordDetails.
- Username string
- The database system administrator username.
- PasswordDetails DbSystem Credentials Password Details 
- Details for the database system password. Password can be passed as VaultSecretPasswordDetailsorPlainTextPasswordDetails.
- Username string
- The database system administrator username.
- passwordDetails DbSystem Credentials Password Details 
- Details for the database system password. Password can be passed as VaultSecretPasswordDetailsorPlainTextPasswordDetails.
- username String
- The database system administrator username.
- passwordDetails DbSystem Credentials Password Details 
- Details for the database system password. Password can be passed as VaultSecretPasswordDetailsorPlainTextPasswordDetails.
- username string
- The database system administrator username.
- password_details DbSystem Credentials Password Details 
- Details for the database system password. Password can be passed as VaultSecretPasswordDetailsorPlainTextPasswordDetails.
- username str
- The database system administrator username.
- passwordDetails Property Map
- Details for the database system password. Password can be passed as VaultSecretPasswordDetailsorPlainTextPasswordDetails.
- username String
- The database system administrator username.
DbSystemCredentialsPasswordDetails, DbSystemCredentialsPasswordDetailsArgs          
- PasswordType string
- The password type.
- Password string
- The database system password.
- SecretId string
- The OCID of the secret where the password is stored.
- SecretVersion string
- The secret version of the stored password.
- PasswordType string
- The password type.
- Password string
- The database system password.
- SecretId string
- The OCID of the secret where the password is stored.
- SecretVersion string
- The secret version of the stored password.
- passwordType String
- The password type.
- password String
- The database system password.
- secretId String
- The OCID of the secret where the password is stored.
- secretVersion String
- The secret version of the stored password.
- passwordType string
- The password type.
- password string
- The database system password.
- secretId string
- The OCID of the secret where the password is stored.
- secretVersion string
- The secret version of the stored password.
- password_type str
- The password type.
- password str
- The database system password.
- secret_id str
- The OCID of the secret where the password is stored.
- secret_version str
- The secret version of the stored password.
- passwordType String
- The password type.
- password String
- The database system password.
- secretId String
- The OCID of the secret where the password is stored.
- secretVersion String
- The secret version of the stored password.
DbSystemInstance, DbSystemInstanceArgs      
- AvailabilityDomain string
- Specifies the availability domain of AD-local storage. If isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- Description string
- (Updatable) A user-provided description of a database system.
- DisplayName string
- (Updatable) A user-friendly display name for the database system. 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- Description string
- (Updatable) A user-provided description of a database system.
- DisplayName string
- (Updatable) A user-friendly display name for the database system. 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- description String
- (Updatable) A user-provided description of a database system.
- displayName String
- (Updatable) A user-friendly display name for the database system. 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- description string
- (Updatable) A user-provided description of a database system.
- displayName string
- (Updatable) A user-friendly display name for the database system. 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- description str
- (Updatable) A user-provided description of a database system.
- display_name str
- (Updatable) A user-friendly display name for the database system. 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- description String
- (Updatable) A user-provided description of a database system.
- displayName String
- (Updatable) A user-friendly display name for the database system. 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
DbSystemInstancesDetail, DbSystemInstancesDetailArgs        
- Description string
- A user-provided description of the database instance node.
- DisplayName string
- Display name of the database instance node. Avoid entering confidential information.
- PrivateIp string
- Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
- Description string
- A user-provided description of the database instance node.
- DisplayName string
- Display name of the database instance node. Avoid entering confidential information.
- PrivateIp string
- Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
- description String
- A user-provided description of the database instance node.
- displayName String
- Display name of the database instance node. Avoid entering confidential information.
- privateIp String
- Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
- description string
- A user-provided description of the database instance node.
- displayName string
- Display name of the database instance node. Avoid entering confidential information.
- privateIp string
- Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
- description str
- A user-provided description of the database instance node.
- display_name str
- Display name of the database instance node. Avoid entering confidential information.
- private_ip str
- Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
- description String
- A user-provided description of the database instance node.
- displayName String
- Display name of the database instance node. Avoid entering confidential information.
- privateIp String
- Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
DbSystemManagementPolicy, DbSystemManagementPolicyArgs        
- BackupPolicy DbSystem Management Policy Backup Policy 
- (Updatable) PostgreSQL database system backup policy.
- MaintenanceWindow stringStart 
- (Updatable) The start of the maintenance window in UTC. - This string is of the format: "{day-of-week} {time-of-day}". "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. 
- BackupPolicy DbSystem Management Policy Backup Policy 
- (Updatable) PostgreSQL database system backup policy.
- MaintenanceWindow stringStart 
- (Updatable) The start of the maintenance window in UTC. - This string is of the format: "{day-of-week} {time-of-day}". "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. 
- backupPolicy DbSystem Management Policy Backup Policy 
- (Updatable) PostgreSQL database system backup policy.
- maintenanceWindow StringStart 
- (Updatable) The start of the maintenance window in UTC. - This string is of the format: "{day-of-week} {time-of-day}". "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. 
- backupPolicy DbSystem Management Policy Backup Policy 
- (Updatable) PostgreSQL database system backup policy.
- maintenanceWindow stringStart 
- (Updatable) The start of the maintenance window in UTC. - This string is of the format: "{day-of-week} {time-of-day}". "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. 
- backup_policy DbSystem Management Policy Backup Policy 
- (Updatable) PostgreSQL database system backup policy.
- maintenance_window_ strstart 
- (Updatable) The start of the maintenance window in UTC. - This string is of the format: "{day-of-week} {time-of-day}". "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. 
- backupPolicy Property Map
- (Updatable) PostgreSQL database system backup policy.
- maintenanceWindow StringStart 
- (Updatable) The start of the maintenance window in UTC. - This string is of the format: "{day-of-week} {time-of-day}". "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. 
DbSystemManagementPolicyBackupPolicy, DbSystemManagementPolicyBackupPolicyArgs            
- BackupStart string
- (Updatable) Hour of the day when the backup starts.
- CopyPolicy DbSystem Management Policy Backup Policy Copy Policy 
- (Updatable) Backup copy details
- DaysOf List<int>The Months 
- (Updatable) 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.
- DaysOf List<string>The Weeks 
- (Updatable) The day of the week that the backup starts.
- Kind string
- (Updatable) The kind of backup policy.
- RetentionDays int
- (Updatable) How many days the data should be stored after the database system deletion.
- BackupStart string
- (Updatable) Hour of the day when the backup starts.
- CopyPolicy DbSystem Management Policy Backup Policy Copy Policy 
- (Updatable) Backup copy details
- DaysOf []intThe Months 
- (Updatable) 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.
- DaysOf []stringThe Weeks 
- (Updatable) The day of the week that the backup starts.
- Kind string
- (Updatable) The kind of backup policy.
- RetentionDays int
- (Updatable) How many days the data should be stored after the database system deletion.
- backupStart String
- (Updatable) Hour of the day when the backup starts.
- copyPolicy DbSystem Management Policy Backup Policy Copy Policy 
- (Updatable) Backup copy details
- daysOf List<Integer>The Months 
- (Updatable) 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.
- daysOf List<String>The Weeks 
- (Updatable) The day of the week that the backup starts.
- kind String
- (Updatable) The kind of backup policy.
- retentionDays Integer
- (Updatable) How many days the data should be stored after the database system deletion.
- backupStart string
- (Updatable) Hour of the day when the backup starts.
- copyPolicy DbSystem Management Policy Backup Policy Copy Policy 
- (Updatable) Backup copy details
- daysOf number[]The Months 
- (Updatable) 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.
- daysOf string[]The Weeks 
- (Updatable) The day of the week that the backup starts.
- kind string
- (Updatable) The kind of backup policy.
- retentionDays number
- (Updatable) How many days the data should be stored after the database system deletion.
- backup_start str
- (Updatable) Hour of the day when the backup starts.
- copy_policy DbSystem Management Policy Backup Policy Copy Policy 
- (Updatable) Backup copy details
- days_of_ Sequence[int]the_ months 
- (Updatable) 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_ Sequence[str]the_ weeks 
- (Updatable) The day of the week that the backup starts.
- kind str
- (Updatable) The kind of backup policy.
- retention_days int
- (Updatable) How many days the data should be stored after the database system deletion.
- backupStart String
- (Updatable) Hour of the day when the backup starts.
- copyPolicy Property Map
- (Updatable) Backup copy details
- daysOf List<Number>The Months 
- (Updatable) 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.
- daysOf List<String>The Weeks 
- (Updatable) The day of the week that the backup starts.
- kind String
- (Updatable) The kind of backup policy.
- retentionDays Number
- (Updatable) How many days the data should be stored after the database system deletion.
DbSystemManagementPolicyBackupPolicyCopyPolicy, DbSystemManagementPolicyBackupPolicyCopyPolicyArgs                
- CompartmentId string
- (Updatable) target compartment to place a new backup
- Regions List<string>
- (Updatable) List of region names of the remote region
- RetentionPeriod int
- (Updatable) Retention period in days of the backup copy.
- CompartmentId string
- (Updatable) target compartment to place a new backup
- Regions []string
- (Updatable) List of region names of the remote region
- RetentionPeriod int
- (Updatable) Retention period in days of the backup copy.
- compartmentId String
- (Updatable) target compartment to place a new backup
- regions List<String>
- (Updatable) List of region names of the remote region
- retentionPeriod Integer
- (Updatable) Retention period in days of the backup copy.
- compartmentId string
- (Updatable) target compartment to place a new backup
- regions string[]
- (Updatable) List of region names of the remote region
- retentionPeriod number
- (Updatable) Retention period in days of the backup copy.
- compartment_id str
- (Updatable) target compartment to place a new backup
- regions Sequence[str]
- (Updatable) List of region names of the remote region
- retention_period int
- (Updatable) Retention period in days of the backup copy.
- compartmentId String
- (Updatable) target compartment to place a new backup
- regions List<String>
- (Updatable) List of region names of the remote region
- retentionPeriod Number
- (Updatable) Retention period in days of the backup copy.
DbSystemNetworkDetails, DbSystemNetworkDetailsArgs        
- SubnetId string
- The OCID of the customer subnet associated with the database system.
- IsReader boolEndpoint Enabled 
- (Updatable) Specifies if the reader endpoint is enabled on the dbSystem.
- NsgIds List<string>
- (Updatable) List of customer Network Security Group OCIDs associated with the database system.
- PrimaryDb stringEndpoint 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.
- SubnetId string
- The OCID of the customer subnet associated with the database system.
- IsReader boolEndpoint Enabled 
- (Updatable) Specifies if the reader endpoint is enabled on the dbSystem.
- NsgIds []string
- (Updatable) List of customer Network Security Group OCIDs associated with the database system.
- PrimaryDb stringEndpoint 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.
- subnetId String
- The OCID of the customer subnet associated with the database system.
- isReader BooleanEndpoint Enabled 
- (Updatable) Specifies if the reader endpoint is enabled on the dbSystem.
- nsgIds List<String>
- (Updatable) List of customer Network Security Group OCIDs associated with the database system.
- primaryDb StringEndpoint 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.
- subnetId string
- The OCID of the customer subnet associated with the database system.
- isReader booleanEndpoint Enabled 
- (Updatable) Specifies if the reader endpoint is enabled on the dbSystem.
- nsgIds string[]
- (Updatable) List of customer Network Security Group OCIDs associated with the database system.
- primaryDb stringEndpoint 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 str
- The OCID of the customer subnet associated with the database system.
- is_reader_ boolendpoint_ enabled 
- (Updatable) Specifies if the reader endpoint is enabled on the dbSystem.
- nsg_ids Sequence[str]
- (Updatable) List of customer Network Security Group OCIDs associated with the database system.
- primary_db_ strendpoint_ 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.
- subnetId String
- The OCID of the customer subnet associated with the database system.
- isReader BooleanEndpoint Enabled 
- (Updatable) Specifies if the reader endpoint is enabled on the dbSystem.
- nsgIds List<String>
- (Updatable) List of customer Network Security Group OCIDs associated with the database system.
- primaryDb StringEndpoint 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.
DbSystemPatchOperation, DbSystemPatchOperationArgs        
- Operation string
- The operation can be one of these values: INSERT,REMOVE.
- Selection string
- In case of INSERT, selection isinstances. In case ofREMOVE, selection isinstances[?id == '${var.instance_id}'].
- From string
- Position string
- SelectedItem string
- Value Dictionary<string, string>
- Specify instance details such as displayName, description or privateIp. Example: {"displayName": "value"}.
- Operation string
- The operation can be one of these values: INSERT,REMOVE.
- Selection string
- In case of INSERT, selection isinstances. In case ofREMOVE, selection isinstances[?id == '${var.instance_id}'].
- From string
- Position string
- SelectedItem string
- Value map[string]string
- Specify instance details such as displayName, description or privateIp. Example: {"displayName": "value"}.
- operation String
- The operation can be one of these values: INSERT,REMOVE.
- selection String
- In case of INSERT, selection isinstances. In case ofREMOVE, selection isinstances[?id == '${var.instance_id}'].
- from String
- position String
- selectedItem String
- value Map<String,String>
- Specify instance details such as displayName, description or privateIp. Example: {"displayName": "value"}.
- operation string
- The operation can be one of these values: INSERT,REMOVE.
- selection string
- In case of INSERT, selection isinstances. In case ofREMOVE, selection isinstances[?id == '${var.instance_id}'].
- from string
- position string
- selectedItem string
- value {[key: string]: string}
- Specify instance details such as displayName, description or privateIp. Example: {"displayName": "value"}.
- operation str
- The operation can be one of these values: INSERT,REMOVE.
- selection str
- In case of INSERT, selection isinstances. In case ofREMOVE, selection isinstances[?id == '${var.instance_id}'].
- from_ str
- position str
- selected_item str
- value Mapping[str, str]
- Specify instance details such as displayName, description or privateIp. Example: {"displayName": "value"}.
- operation String
- The operation can be one of these values: INSERT,REMOVE.
- selection String
- In case of INSERT, selection isinstances. In case ofREMOVE, selection isinstances[?id == '${var.instance_id}'].
- from String
- position String
- selectedItem String
- value Map<String>
- Specify instance details such as displayName, description or privateIp. Example: {"displayName": "value"}.
DbSystemSource, DbSystemSourceArgs      
- SourceType string
- The source descriminator. Example: {"source_type": "BACKUP"}.
- BackupId string
- The OCID of the database system backup.
- IsHaving boolRestore Config Overrides 
- Deprecated. Don't use.
- SourceType string
- The source descriminator. Example: {"source_type": "BACKUP"}.
- BackupId string
- The OCID of the database system backup.
- IsHaving boolRestore Config Overrides 
- Deprecated. Don't use.
- sourceType String
- The source descriminator. Example: {"source_type": "BACKUP"}.
- backupId String
- The OCID of the database system backup.
- isHaving BooleanRestore Config Overrides 
- Deprecated. Don't use.
- sourceType string
- The source descriminator. Example: {"source_type": "BACKUP"}.
- backupId string
- The OCID of the database system backup.
- isHaving booleanRestore Config Overrides 
- Deprecated. Don't use.
- source_type str
- The source descriminator. Example: {"source_type": "BACKUP"}.
- backup_id str
- The OCID of the database system backup.
- is_having_ boolrestore_ config_ overrides 
- Deprecated. Don't use.
- sourceType String
- The source descriminator. Example: {"source_type": "BACKUP"}.
- backupId String
- The OCID of the database system backup.
- isHaving BooleanRestore Config Overrides 
- Deprecated. Don't use.
DbSystemStorageDetails, DbSystemStorageDetailsArgs        
- IsRegionally boolDurable 
- 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- SystemType string
- Type of the database system.
- AvailabilityDomain string
- Specifies the availability domain of AD-local storage. If isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- Iops string
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
- IsRegionally boolDurable 
- 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- SystemType string
- Type of the database system.
- AvailabilityDomain string
- Specifies the availability domain of AD-local storage. If isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- Iops string
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
- isRegionally BooleanDurable 
- 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- systemType String
- Type of the database system.
- availabilityDomain String
- Specifies the availability domain of AD-local storage. If isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- iops String
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
- isRegionally booleanDurable 
- 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- systemType string
- Type of the database system.
- availabilityDomain string
- Specifies the availability domain of AD-local storage. If isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- iops string
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
- is_regionally_ booldurable 
- 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- system_type str
- Type of the database system.
- availability_domain str
- Specifies the availability domain of AD-local storage. If isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- iops str
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
- isRegionally BooleanDurable 
- 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 isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- systemType String
- Type of the database system.
- availabilityDomain String
- Specifies the availability domain of AD-local storage. If isRegionallyDurableis set to true,availabilityDomainshould not be specified. IfisRegionallyDurableis set to false,availabilityDomainmust be specified.
- iops String
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
Import
DbSystems can be imported using the id, e.g.
$ pulumi import oci:Psql/dbSystem:DbSystem test_db_system "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.