Oracle Cloud Infrastructure v2.4.0, Jul 25 24

Oracle Cloud Infrastructure v2.4.0 published on Thursday, Jul 25, 2024 by Pulumi

oci.Psql.DbSystem

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.4.0 published on Thursday, Jul 25, 2024 by Pulumi

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,
    dbVersion: dbSystemDbVersion,
    displayName: dbSystemDisplayName,
    networkDetails: {
        subnetId: testSubnet.id,
        nsgIds: dbSystemNetworkDetailsNsgIds,
        primaryDbEndpointPrivateIp: dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp,
    },
    shape: dbSystemShape,
    storageDetails: {
        isRegionallyDurable: dbSystemStorageDetailsIsRegionallyDurable,
        systemType: dbSystemStorageDetailsSystemType,
        availabilityDomain: dbSystemStorageDetailsAvailabilityDomain,
        iops: dbSystemStorageDetailsIops,
    },
    configId: testConfig.id,
    applyConfig: dbSystemApplyConfigType,
    credentials: {
        passwordDetails: {
            passwordType: dbSystemCredentialsPasswordDetailsPasswordType,
            password: dbSystemCredentialsPasswordDetailsPassword,
            secretId: testSecret.id,
            secretVersion: dbSystemCredentialsPasswordDetailsSecretVersion,
        },
        username: dbSystemCredentialsUsername,
    },
    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,
            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,
    db_version=db_system_db_version,
    display_name=db_system_display_name,
    network_details=oci.psql.DbSystemNetworkDetailsArgs(
        subnet_id=test_subnet["id"],
        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=oci.psql.DbSystemStorageDetailsArgs(
        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"],
    apply_config=db_system_apply_config_type,
    credentials=oci.psql.DbSystemCredentialsArgs(
        password_details=oci.psql.DbSystemCredentialsPasswordDetailsArgs(
            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,
    ),
    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=[oci.psql.DbSystemInstancesDetailArgs(
        description=db_system_instances_details_description,
        display_name=db_system_instances_details_display_name,
        private_ip=db_system_instances_details_private_ip,
    )],
    management_policy=oci.psql.DbSystemManagementPolicyArgs(
        backup_policy=oci.psql.DbSystemManagementPolicyBackupPolicyArgs(
            backup_start=db_system_management_policy_backup_policy_backup_start,
            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=oci.psql.DbSystemSourceArgs(
        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=[oci.psql.DbSystemPatchOperationArgs(
        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),
			DbVersion:     pulumi.Any(dbSystemDbVersion),
			DisplayName:   pulumi.Any(dbSystemDisplayName),
			NetworkDetails: &psql.DbSystemNetworkDetailsArgs{
				SubnetId:                   pulumi.Any(testSubnet.Id),
				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),
			ApplyConfig: pulumi.Any(dbSystemApplyConfigType),
			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),
			},
			DefinedTags: pulumi.Map{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			Description: pulumi.Any(dbSystemDescription),
			FreeformTags: pulumi.Map{
				"bar-key": pulumi.Any("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),
					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,
        DbVersion = dbSystemDbVersion,
        DisplayName = dbSystemDisplayName,
        NetworkDetails = new Oci.Psql.Inputs.DbSystemNetworkDetailsArgs
        {
            SubnetId = testSubnet.Id,
            NsgIds = dbSystemNetworkDetailsNsgIds,
            PrimaryDbEndpointPrivateIp = dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp,
        },
        Shape = dbSystemShape,
        StorageDetails = new Oci.Psql.Inputs.DbSystemStorageDetailsArgs
        {
            IsRegionallyDurable = dbSystemStorageDetailsIsRegionallyDurable,
            SystemType = dbSystemStorageDetailsSystemType,
            AvailabilityDomain = dbSystemStorageDetailsAvailabilityDomain,
            Iops = dbSystemStorageDetailsIops,
        },
        ConfigId = testConfig.Id,
        ApplyConfig = dbSystemApplyConfigType,
        Credentials = new Oci.Psql.Inputs.DbSystemCredentialsArgs
        {
            PasswordDetails = new Oci.Psql.Inputs.DbSystemCredentialsPasswordDetailsArgs
            {
                PasswordType = dbSystemCredentialsPasswordDetailsPasswordType,
                Password = dbSystemCredentialsPasswordDetailsPassword,
                SecretId = testSecret.Id,
                SecretVersion = dbSystemCredentialsPasswordDetailsSecretVersion,
            },
            Username = dbSystemCredentialsUsername,
        },
        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,
                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.DbSystemNetworkDetailsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemStorageDetailsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemCredentialsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemCredentialsPasswordDetailsArgs;
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.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)
            .dbVersion(dbSystemDbVersion)
            .displayName(dbSystemDisplayName)
            .networkDetails(DbSystemNetworkDetailsArgs.builder()
                .subnetId(testSubnet.id())
                .nsgIds(dbSystemNetworkDetailsNsgIds)
                .primaryDbEndpointPrivateIp(dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp)
                .build())
            .shape(dbSystemShape)
            .storageDetails(DbSystemStorageDetailsArgs.builder()
                .isRegionallyDurable(dbSystemStorageDetailsIsRegionallyDurable)
                .systemType(dbSystemStorageDetailsSystemType)
                .availabilityDomain(dbSystemStorageDetailsAvailabilityDomain)
                .iops(dbSystemStorageDetailsIops)
                .build())
            .configId(testConfig.id())
            .applyConfig(dbSystemApplyConfigType)
            .credentials(DbSystemCredentialsArgs.builder()
                .passwordDetails(DbSystemCredentialsPasswordDetailsArgs.builder()
                    .passwordType(dbSystemCredentialsPasswordDetailsPasswordType)
                    .password(dbSystemCredentialsPasswordDetailsPassword)
                    .secretId(testSecret.id())
                    .secretVersion(dbSystemCredentialsPasswordDetailsSecretVersion)
                    .build())
                .username(dbSystemCredentialsUsername)
                .build())
            .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)
                    .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}
      dbVersion: ${dbSystemDbVersion}
      displayName: ${dbSystemDisplayName}
      networkDetails:
        subnetId: ${testSubnet.id}
        nsgIds: ${dbSystemNetworkDetailsNsgIds}
        primaryDbEndpointPrivateIp: ${dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp}
      shape: ${dbSystemShape}
      storageDetails:
        isRegionallyDurable: ${dbSystemStorageDetailsIsRegionallyDurable}
        systemType: ${dbSystemStorageDetailsSystemType}
        availabilityDomain: ${dbSystemStorageDetailsAvailabilityDomain}
        iops: ${dbSystemStorageDetailsIops}
      configId: ${testConfig.id}
      applyConfig: ${dbSystemApplyConfigType}
      credentials:
        passwordDetails:
          passwordType: ${dbSystemCredentialsPasswordDetailsPasswordType}
          password: ${dbSystemCredentialsPasswordDetailsPassword}
          secretId: ${testSecret.id}
          secretVersion: ${dbSystemCredentialsPasswordDetailsSecretVersion}
        username: ${dbSystemCredentialsUsername}
      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}
          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[_psql.DbSystemStorageDetailsArgs] = None,
             shape: Optional[str] = None,
             db_version: Optional[str] = None,
             network_details: Optional[_psql.DbSystemNetworkDetailsArgs] = None,
             instance_memory_size_in_gbs: Optional[int] = None,
             management_policy: Optional[_psql.DbSystemManagementPolicyArgs] = None,
             freeform_tags: Optional[Mapping[str, Any]] = None,
             instance_count: Optional[int] = None,
             apply_config: Optional[str] = None,
             instance_ocpu_count: Optional[int] = None,
             instances_details: Optional[Sequence[_psql.DbSystemInstancesDetailArgs]] = None,
             description: Optional[str] = None,
             defined_tags: Optional[Mapping[str, Any]] = None,
             patch_operations: Optional[Sequence[_psql.DbSystemPatchOperationArgs]] = None,
             credentials: Optional[_psql.DbSystemCredentialsArgs] = None,
             source: Optional[_psql.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",
        NsgIds = new[]
        {
            "string",
        },
        PrimaryDbEndpointPrivateIp = "string",
    },
    InstanceMemorySizeInGbs = 0,
    ManagementPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyArgs
    {
        BackupPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyBackupPolicyArgs
        {
            BackupStart = "string",
            DaysOfTheMonths = new[]
            {
                0,
            },
            DaysOfTheWeeks = new[]
            {
                "string",
            },
            Kind = "string",
            RetentionDays = 0,
        },
        MaintenanceWindowStart = "string",
    },
    FreeformTags = 
    {
        { "string", "any" },
    },
    InstanceCount = 0,
    ApplyConfig = "string",
    InstanceOcpuCount = 0,
    InstancesDetails = new[]
    {
        new Oci.Psql.Inputs.DbSystemInstancesDetailArgs
        {
            Description = "string",
            DisplayName = "string",
            PrivateIp = "string",
        },
    },
    Description = "string",
    DefinedTags = 
    {
        { "string", "any" },
    },
    PatchOperations = new[]
    {
        new Oci.Psql.Inputs.DbSystemPatchOperationArgs
        {
            Operation = "string",
            Selection = "string",
            From = "string",
            Position = "string",
            SelectedItem = "string",
            Value = 
            {
                { "string", "any" },
            },
        },
    },
    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"),
		NsgIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrimaryDbEndpointPrivateIp: pulumi.String("string"),
	},
	InstanceMemorySizeInGbs: pulumi.Int(0),
	ManagementPolicy: &psql.DbSystemManagementPolicyArgs{
		BackupPolicy: &psql.DbSystemManagementPolicyBackupPolicyArgs{
			BackupStart: pulumi.String("string"),
			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.Map{
		"string": pulumi.Any("any"),
	},
	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.Map{
		"string": pulumi.Any("any"),
	},
	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.Map{
				"string": pulumi.Any("any"),
			},
		},
	},
	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 DbSystem("ociDbSystemResource", 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")
        .nsgIds("string")
        .primaryDbEndpointPrivateIp("string")
        .build())
    .instanceMemorySizeInGbs(0)
    .managementPolicy(DbSystemManagementPolicyArgs.builder()
        .backupPolicy(DbSystemManagementPolicyBackupPolicyArgs.builder()
            .backupStart("string")
            .daysOfTheMonths(0)
            .daysOfTheWeeks("string")
            .kind("string")
            .retentionDays(0)
            .build())
        .maintenanceWindowStart("string")
        .build())
    .freeformTags(Map.of("string", "any"))
    .instanceCount(0)
    .applyConfig("string")
    .instanceOcpuCount(0)
    .instancesDetails(DbSystemInstancesDetailArgs.builder()
        .description("string")
        .displayName("string")
        .privateIp("string")
        .build())
    .description("string")
    .definedTags(Map.of("string", "any"))
    .patchOperations(DbSystemPatchOperationArgs.builder()
        .operation("string")
        .selection("string")
        .from("string")
        .position("string")
        .selectedItem("string")
        .value(Map.of("string", "any"))
        .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=oci.psql.DbSystemStorageDetailsArgs(
        is_regionally_durable=False,
        system_type="string",
        availability_domain="string",
        iops="string",
    ),
    shape="string",
    db_version="string",
    network_details=oci.psql.DbSystemNetworkDetailsArgs(
        subnet_id="string",
        nsg_ids=["string"],
        primary_db_endpoint_private_ip="string",
    ),
    instance_memory_size_in_gbs=0,
    management_policy=oci.psql.DbSystemManagementPolicyArgs(
        backup_policy=oci.psql.DbSystemManagementPolicyBackupPolicyArgs(
            backup_start="string",
            days_of_the_months=[0],
            days_of_the_weeks=["string"],
            kind="string",
            retention_days=0,
        ),
        maintenance_window_start="string",
    ),
    freeform_tags={
        "string": "any",
    },
    instance_count=0,
    apply_config="string",
    instance_ocpu_count=0,
    instances_details=[oci.psql.DbSystemInstancesDetailArgs(
        description="string",
        display_name="string",
        private_ip="string",
    )],
    description="string",
    defined_tags={
        "string": "any",
    },
    patch_operations=[oci.psql.DbSystemPatchOperationArgs(
        operation="string",
        selection="string",
        from_="string",
        position="string",
        selected_item="string",
        value={
            "string": "any",
        },
    )],
    credentials=oci.psql.DbSystemCredentialsArgs(
        password_details=oci.psql.DbSystemCredentialsPasswordDetailsArgs(
            password_type="string",
            password="string",
            secret_id="string",
            secret_version="string",
        ),
        username="string",
    ),
    source=oci.psql.DbSystemSourceArgs(
        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",
        nsgIds: ["string"],
        primaryDbEndpointPrivateIp: "string",
    },
    instanceMemorySizeInGbs: 0,
    managementPolicy: {
        backupPolicy: {
            backupStart: "string",
            daysOfTheMonths: [0],
            daysOfTheWeeks: ["string"],
            kind: "string",
            retentionDays: 0,
        },
        maintenanceWindowStart: "string",
    },
    freeformTags: {
        string: "any",
    },
    instanceCount: 0,
    applyConfig: "string",
    instanceOcpuCount: 0,
    instancesDetails: [{
        description: "string",
        displayName: "string",
        privateIp: "string",
    }],
    description: "string",
    definedTags: {
        string: "any",
    },
    patchOperations: [{
        operation: "string",
        selection: "string",
        from: "string",
        position: "string",
        selectedItem: "string",
        value: {
            string: "any",
        },
    }],
    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: any
    description: string
    displayName: string
    freeformTags:
        string: any
    instanceCount: 0
    instanceMemorySizeInGbs: 0
    instanceOcpuCount: 0
    instancesDetails:
        - description: string
          displayName: string
          privateIp: string
    managementPolicy:
        backupPolicy:
            backupStart: string
            daysOfTheMonths:
                - 0
            daysOfTheWeeks:
                - string
            kind: string
            retentionDays: 0
        maintenanceWindowStart: string
    networkDetails:
        nsgIds:
            - string
        primaryDbEndpointPrivateIp: string
        subnetId: string
    patchOperations:
        - from: string
          operation: string
          position: string
          selectedItem: string
          selection: string
          value:
            string: any
    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

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 DbSystemNetworkDetails

Network details for the database system.

Shape string

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

StorageDetails DbSystemStorageDetails

(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 RESTART or RELOAD

ConfigId string

The OCID of the configuration associated with the database system.

Credentials DbSystemCredentials

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

DefinedTags Dictionary<string, object>

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

FreeformTags Dictionary<string, object>

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

InstanceMemorySizeInGbs int

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

InstanceOcpuCount int

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

InstancesDetails List<DbSystemInstancesDetail>

Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.

ManagementPolicy DbSystemManagementPolicy

(Updatable) PostgreSQL database system management policy update details.

PatchOperations List<DbSystemPatchOperation>

(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 DbSystemSource

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 DbSystemNetworkDetailsArgs

Network details for the database system.

Shape string

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

StorageDetails DbSystemStorageDetailsArgs

(Updatable) Storage details of the database system.

ApplyConfig string

ConfigId string

The OCID of the configuration associated with the database system.

Credentials DbSystemCredentialsArgs

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

DefinedTags map[string]interface{}

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

FreeformTags map[string]interface{}

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

InstanceMemorySizeInGbs int

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

InstanceOcpuCount int

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

InstancesDetails []DbSystemInstancesDetailArgs

Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.

ManagementPolicy DbSystemManagementPolicyArgs

(Updatable) PostgreSQL database system management policy update details.

PatchOperations []DbSystemPatchOperationArgs

Source DbSystemSourceArgs

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 DbSystemNetworkDetails

Network details for the database system.

shape String

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

storageDetails DbSystemStorageDetails

(Updatable) Storage details of the database system.

applyConfig String

configId String

The OCID of the configuration associated with the database system.

credentials DbSystemCredentials

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

definedTags Map<String,Object>

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

freeformTags Map<String,Object>

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

instanceMemorySizeInGbs Integer

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

instanceOcpuCount Integer

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

instancesDetails List<DbSystemInstancesDetail>

Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.

managementPolicy DbSystemManagementPolicy

(Updatable) PostgreSQL database system management policy update details.

patchOperations List<DbSystemPatchOperation>

source DbSystemSource

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 DbSystemNetworkDetails

Network details for the database system.

shape string

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

storageDetails DbSystemStorageDetails

(Updatable) Storage details of the database system.

applyConfig string

configId string

The OCID of the configuration associated with the database system.

credentials DbSystemCredentials

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

definedTags {[key: string]: any}

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

freeformTags {[key: string]: any}

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

instanceMemorySizeInGbs number

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

instanceOcpuCount number

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

instancesDetails DbSystemInstancesDetail[]

Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.

managementPolicy DbSystemManagementPolicy

(Updatable) PostgreSQL database system management policy update details.

patchOperations DbSystemPatchOperation[]

source DbSystemSource

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 psql.DbSystemNetworkDetailsArgs

Network details for the database system.

shape str

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

storage_details psql.DbSystemStorageDetailsArgs

(Updatable) Storage details of the database system.

apply_config str

config_id str

The OCID of the configuration associated with the database system.

credentials psql.DbSystemCredentialsArgs

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

defined_tags Mapping[str, Any]

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

freeform_tags Mapping[str, Any]

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

instance_memory_size_in_gbs int

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

instance_ocpu_count int

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

instances_details Sequence[psql.DbSystemInstancesDetailArgs]

Details of database instances nodes to be created. This parameter is optional. If specified, its size must match instanceCount.

management_policy psql.DbSystemManagementPolicyArgs

(Updatable) PostgreSQL database system management policy update details.

patch_operations Sequence[psql.DbSystemPatchOperationArgs]

source psql.DbSystemSourceArgs

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

Network details for the database system.

shape String

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

storageDetails Property Map

(Updatable) Storage details of the database system.

applyConfig String

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

definedTags Map<Any>

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

freeformTags Map<Any>

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

instanceMemorySizeInGbs Number

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

instanceOcpuCount Number

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

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>

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<DbSystemInstance>: 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.
SystemTags Dictionary<string, object>: 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 []DbSystemInstance: 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.
SystemTags map[string]interface{}: 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<DbSystemInstance>: 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.
systemTags Map<String,Object>: 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 DbSystemInstance[]: 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.
systemTags {[key: string]: any}: 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[psql.DbSystemInstance]: 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.
system_tags Mapping[str, Any]: 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.
systemTags Map<Any>: 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[_psql.DbSystemCredentialsArgs] = None,
        db_version: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        instance_count: Optional[int] = None,
        instance_memory_size_in_gbs: Optional[int] = None,
        instance_ocpu_count: Optional[int] = None,
        instances: Optional[Sequence[_psql.DbSystemInstanceArgs]] = None,
        instances_details: Optional[Sequence[_psql.DbSystemInstancesDetailArgs]] = None,
        lifecycle_details: Optional[str] = None,
        management_policy: Optional[_psql.DbSystemManagementPolicyArgs] = None,
        network_details: Optional[_psql.DbSystemNetworkDetailsArgs] = None,
        patch_operations: Optional[Sequence[_psql.DbSystemPatchOperationArgs]] = None,
        shape: Optional[str] = None,
        source: Optional[_psql.DbSystemSourceArgs] = None,
        state: Optional[str] = None,
        storage_details: Optional[_psql.DbSystemStorageDetailsArgs] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        system_type: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> DbSystem

func 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)

Resource lookup is not supported in YAML

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.

The following state arguments are supported:

AdminUsername string

The database system administrator username.

ApplyConfig string

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 DbSystemCredentials

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.

DefinedTags Dictionary<string, object>

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

FreeformTags Dictionary<string, object>

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

InstanceMemorySizeInGbs int

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

InstanceOcpuCount int

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

Instances List<DbSystemInstance>

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

InstancesDetails List<DbSystemInstancesDetail>

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 DbSystemManagementPolicy

(Updatable) PostgreSQL database system management policy update details.

NetworkDetails DbSystemNetworkDetails

Network details for the database system.

PatchOperations List<DbSystemPatchOperation>

Shape string

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

Source DbSystemSource

The source used to restore the database system.

State string

The current state of the database system.

StorageDetails DbSystemStorageDetails

(Updatable) Storage details of the database system.

SystemTags Dictionary<string, object>

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

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 DbSystemCredentialsArgs

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.

DefinedTags map[string]interface{}

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

FreeformTags map[string]interface{}

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

InstanceMemorySizeInGbs int

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

InstanceOcpuCount int

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

Instances []DbSystemInstanceArgs

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

InstancesDetails []DbSystemInstancesDetailArgs

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 DbSystemManagementPolicyArgs

(Updatable) PostgreSQL database system management policy update details.

NetworkDetails DbSystemNetworkDetailsArgs

Network details for the database system.

PatchOperations []DbSystemPatchOperationArgs

Shape string

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

Source DbSystemSourceArgs

The source used to restore the database system.

State string

The current state of the database system.

StorageDetails DbSystemStorageDetailsArgs

(Updatable) Storage details of the database system.

SystemTags map[string]interface{}

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

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 DbSystemCredentials

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.

definedTags Map<String,Object>

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

freeformTags Map<String,Object>

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

instanceMemorySizeInGbs Integer

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

instanceOcpuCount Integer

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

instances List<DbSystemInstance>

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

instancesDetails List<DbSystemInstancesDetail>

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 DbSystemManagementPolicy

(Updatable) PostgreSQL database system management policy update details.

networkDetails DbSystemNetworkDetails

Network details for the database system.

patchOperations List<DbSystemPatchOperation>

shape String

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

source DbSystemSource

The source used to restore the database system.

state String

The current state of the database system.

storageDetails DbSystemStorageDetails

(Updatable) Storage details of the database system.

systemTags Map<String,Object>

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

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 DbSystemCredentials

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.

definedTags {[key: string]: any}

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

freeformTags {[key: string]: any}

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

instanceMemorySizeInGbs number

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

instanceOcpuCount number

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

instances DbSystemInstance[]

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

instancesDetails DbSystemInstancesDetail[]

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 DbSystemManagementPolicy

(Updatable) PostgreSQL database system management policy update details.

networkDetails DbSystemNetworkDetails

Network details for the database system.

patchOperations DbSystemPatchOperation[]

shape string

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

source DbSystemSource

The source used to restore the database system.

state string

The current state of the database system.

storageDetails DbSystemStorageDetails

(Updatable) Storage details of the database system.

systemTags {[key: string]: any}

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

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 psql.DbSystemCredentialsArgs

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.

defined_tags Mapping[str, Any]

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

freeform_tags Mapping[str, Any]

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

instance_memory_size_in_gbs int

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

instance_ocpu_count int

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

instances Sequence[psql.DbSystemInstanceArgs]

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

instances_details Sequence[psql.DbSystemInstancesDetailArgs]

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 psql.DbSystemManagementPolicyArgs

(Updatable) PostgreSQL database system management policy update details.

network_details psql.DbSystemNetworkDetailsArgs

Network details for the database system.

patch_operations Sequence[psql.DbSystemPatchOperationArgs]

shape str

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

source psql.DbSystemSourceArgs

The source used to restore the database system.

state str

The current state of the database system.

storage_details psql.DbSystemStorageDetailsArgs

(Updatable) Storage details of the database system.

system_tags Mapping[str, Any]

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

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.

definedTags Map<Any>

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

freeformTags Map<Any>

(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

(Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.

instanceMemorySizeInGbs Number

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

instanceOcpuCount Number

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

instances List<Property Map>

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

instancesDetails List<Property Map>

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

Network details for the database system.

patchOperations List<Property Map>

shape String

The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: PostgreSQL.VM.Standard.E4.Flex.2.32GB. Find more about the supported shapes here.

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.

systemTags Map<Any>

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 DbSystemCredentialsPasswordDetails: Details for the database system password. Password can be passed as VaultSecretPasswordDetails or PlainTextPasswordDetails.
Username string: The database system administrator username.

PasswordDetails DbSystemCredentialsPasswordDetails: Details for the database system password. Password can be passed as VaultSecretPasswordDetails or PlainTextPasswordDetails.
Username string: The database system administrator username.

passwordDetails DbSystemCredentialsPasswordDetails: Details for the database system password. Password can be passed as VaultSecretPasswordDetails or PlainTextPasswordDetails.
username String: The database system administrator username.

passwordDetails DbSystemCredentialsPasswordDetails: Details for the database system password. Password can be passed as VaultSecretPasswordDetails or PlainTextPasswordDetails.
username string: The database system administrator username.

password_details psql.DbSystemCredentialsPasswordDetails: Details for the database system password. Password can be passed as VaultSecretPasswordDetails or PlainTextPasswordDetails.
username str: The database system administrator username.

passwordDetails Property Map: Details for the database system password. Password can be passed as VaultSecretPasswordDetails or PlainTextPasswordDetails.
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 isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must 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 isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must 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 isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must 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 isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must 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 isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must 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 isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must 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 DbSystemManagementPolicyBackupPolicy: (Updatable) PostgreSQL database system backup policy.
MaintenanceWindowStart string: (Updatable) The start of the maintenance window.

BackupPolicy DbSystemManagementPolicyBackupPolicy: (Updatable) PostgreSQL database system backup policy.
MaintenanceWindowStart string: (Updatable) The start of the maintenance window.

backupPolicy DbSystemManagementPolicyBackupPolicy: (Updatable) PostgreSQL database system backup policy.
maintenanceWindowStart String: (Updatable) The start of the maintenance window.

backupPolicy DbSystemManagementPolicyBackupPolicy: (Updatable) PostgreSQL database system backup policy.
maintenanceWindowStart string: (Updatable) The start of the maintenance window.

backup_policy psql.DbSystemManagementPolicyBackupPolicy: (Updatable) PostgreSQL database system backup policy.
maintenance_window_start str: (Updatable) The start of the maintenance window.

backupPolicy Property Map: (Updatable) PostgreSQL database system backup policy.
maintenanceWindowStart String: (Updatable) The start of the maintenance window.

DbSystemManagementPolicyBackupPolicy, DbSystemManagementPolicyBackupPolicyArgs

BackupStart string: (Updatable) Hour of the day when the backup starts.
DaysOfTheMonths List<int>: (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.
DaysOfTheWeeks List<string>: (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.
DaysOfTheMonths []int: (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.
DaysOfTheWeeks []string: (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.
daysOfTheMonths List<Integer>: (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.
daysOfTheWeeks List<String>: (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.
daysOfTheMonths number[]: (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.
daysOfTheWeeks string[]: (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.
days_of_the_months Sequence[int]: (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_the_weeks Sequence[str]: (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.
daysOfTheMonths List<Number>: (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.
daysOfTheWeeks List<String>: (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.

DbSystemNetworkDetails, DbSystemNetworkDetailsArgs

SubnetId string: The OCID of the customer subnet associated with the database system.
NsgIds List<string>: List of customer Network Security Group OCIDs associated with the database system.
PrimaryDbEndpointPrivateIp string: Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.

SubnetId string: The OCID of the customer subnet associated with the database system.
NsgIds []string: List of customer Network Security Group OCIDs associated with the database system.
PrimaryDbEndpointPrivateIp string: Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.

subnetId String: The OCID of the customer subnet associated with the database system.
nsgIds List<String>: List of customer Network Security Group OCIDs associated with the database system.
primaryDbEndpointPrivateIp String: Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.

subnetId string: The OCID of the customer subnet associated with the database system.
nsgIds string[]: List of customer Network Security Group OCIDs associated with the database system.
primaryDbEndpointPrivateIp string: Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.

subnet_id str: The OCID of the customer subnet associated with the database system.
nsg_ids Sequence[str]: List of customer Network Security Group OCIDs associated with the database system.
primary_db_endpoint_private_ip str: Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.

subnetId String: The OCID of the customer subnet associated with the database system.
nsgIds List<String>: List of customer Network Security Group OCIDs associated with the database system.
primaryDbEndpointPrivateIp String: Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.

DbSystemPatchOperation, DbSystemPatchOperationArgs

Operation string: The operation can be one of these values: INSERT, REMOVE.
Selection string: In case of INSERT, selection is instances. In case of REMOVE, selection is instances[?id == '${var.instance_id}'].
From string
Position string
SelectedItem string
Value Dictionary<string, object>: 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 is instances. In case of REMOVE, selection is instances[?id == '${var.instance_id}'].
From string
Position string
SelectedItem string
Value map[string]interface{}: 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 is instances. In case of REMOVE, selection is instances[?id == '${var.instance_id}'].
from String
position String
selectedItem String
value Map<String,Object>: 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 is instances. In case of REMOVE, selection is instances[?id == '${var.instance_id}'].
from string
position string
selectedItem string
value {[key: string]: any}: 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 is instances. In case of REMOVE, selection is instances[?id == '${var.instance_id}'].
from_ str
position str
selected_item str
value Mapping[str, Any]: 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 is instances. In case of REMOVE, selection is instances[?id == '${var.instance_id}'].
from String
position String
selectedItem String
value Map<Any>: 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.
IsHavingRestoreConfigOverrides bool: Deprecated. Don't use.

SourceType string: The source descriminator. Example: {"source_type": "BACKUP"}.
BackupId string: The OCID of the database system backup.
IsHavingRestoreConfigOverrides bool: Deprecated. Don't use.

sourceType String: The source descriminator. Example: {"source_type": "BACKUP"}.
backupId String: The OCID of the database system backup.
isHavingRestoreConfigOverrides Boolean: Deprecated. Don't use.

sourceType string: The source descriminator. Example: {"source_type": "BACKUP"}.
backupId string: The OCID of the database system backup.
isHavingRestoreConfigOverrides boolean: 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_restore_config_overrides bool: Deprecated. Don't use.

sourceType String: The source descriminator. Example: {"source_type": "BACKUP"}.
backupId String: The OCID of the database system backup.
isHavingRestoreConfigOverrides Boolean: Deprecated. Don't use.

DbSystemStorageDetails, DbSystemStorageDetailsArgs

IsRegionallyDurable bool: Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
SystemType string: Type of the database system.
AvailabilityDomain string: Specifies the availability domain of AD-local storage. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
Iops string: (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.

IsRegionallyDurable bool: Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
SystemType string: Type of the database system.
AvailabilityDomain string: Specifies the availability domain of AD-local storage. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
Iops string: (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.

isRegionallyDurable Boolean: Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
systemType String: Type of the database system.
availabilityDomain String: Specifies the availability domain of AD-local storage. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
iops String: (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.

isRegionallyDurable boolean: Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
systemType string: Type of the database system.
availabilityDomain string: Specifies the availability domain of AD-local storage. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
iops string: (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.

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

isRegionallyDurable Boolean: Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
systemType String: Type of the database system.
availabilityDomain String: Specifies the availability domain of AD-local storage. If isRegionallyDurable is set to true, availabilityDomain should not be specified. If isRegionallyDurable is set to false, availabilityDomain must be specified.
iops String: (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 oci Terraform Provider.

Oracle Cloud Infrastructure v2.4.0 published on Thursday, Jul 25, 2024 by Pulumi

pulumi/pulumi-oci

oci.Psql.DbSystem

On this page

On this page

Example Usage

Create DbSystem Resource

Constructor syntax

Parameters

Constructor example

DbSystem Resource Properties

Inputs

Outputs

Look up Existing DbSystem Resource

Supporting Types

DbSystemCredentials, DbSystemCredentialsArgs

DbSystemCredentialsPasswordDetails, DbSystemCredentialsPasswordDetailsArgs

DbSystemInstance, DbSystemInstanceArgs

DbSystemInstancesDetail, DbSystemInstancesDetailArgs

DbSystemManagementPolicy, DbSystemManagementPolicyArgs

DbSystemManagementPolicyBackupPolicy, DbSystemManagementPolicyBackupPolicyArgs

DbSystemNetworkDetails, DbSystemNetworkDetailsArgs

DbSystemPatchOperation, DbSystemPatchOperationArgs

DbSystemSource, DbSystemSourceArgs

DbSystemStorageDetails, DbSystemStorageDetailsArgs

Import

Package Details

On this page

On this page