Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Database.DbSystem

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

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,
             availability_domain: Optional[str] = None,
             subnet_id: Optional[str] = None,
             ssh_public_keys: Optional[Sequence[str]] = None,
             shape: Optional[str] = None,
             compartment_id: Optional[str] = None,
             hostname: Optional[str] = None,
             db_home: Optional[_database.DbSystemDbHomeArgs] = None,
             database_edition: Optional[str] = None,
             maintenance_window_details: Optional[_database.DbSystemMaintenanceWindowDetailsArgs] = None,
             data_storage_percentage: Optional[int] = None,
             data_collection_options: Optional[_database.DbSystemDataCollectionOptionsArgs] = None,
             db_system_options: Optional[_database.DbSystemDbSystemOptionsArgs] = None,
             defined_tags: Optional[Mapping[str, str]] = None,
             disk_redundancy: Optional[str] = None,
             display_name: Optional[str] = None,
             domain: Optional[str] = None,
             fault_domains: Optional[Sequence[str]] = None,
             freeform_tags: Optional[Mapping[str, str]] = None,
             cpu_core_count: Optional[int] = None,
             kms_key_id: Optional[str] = None,
             kms_key_version_id: Optional[str] = None,
             license_model: Optional[str] = None,
             data_storage_size_in_gb: Optional[int] = None,
             node_count: Optional[int] = None,
             nsg_ids: Optional[Sequence[str]] = None,
             private_ip: Optional[str] = None,
             private_ip_v6: Optional[str] = None,
             reco_storage_size_in_gb: Optional[int] = None,
             security_attributes: Optional[Mapping[str, str]] = None,
             cluster_name: Optional[str] = None,
             source: Optional[str] = None,
             source_db_system_id: Optional[str] = None,
             sparse_diskgroup: Optional[bool] = None,
             backup_subnet_id: Optional[str] = None,
             storage_volume_performance_mode: Optional[str] = None,
             backup_network_nsg_ids: Optional[Sequence[str]] = None,
             time_zone: 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:Database: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 dbSystemResource = new Oci.Database.DbSystem("dbSystemResource", new()
{
    AvailabilityDomain = "string",
    SubnetId = "string",
    SshPublicKeys = new[]
    {
        "string",
    },
    Shape = "string",
    CompartmentId = "string",
    Hostname = "string",
    DbHome = new Oci.Database.Inputs.DbSystemDbHomeArgs
    {
        Database = new Oci.Database.Inputs.DbSystemDbHomeDatabaseArgs
        {
            AdminPassword = "string",
            BackupId = "string",
            BackupTdePassword = "string",
            CharacterSet = "string",
            ConnectionStrings = new[]
            {
                new Oci.Database.Inputs.DbSystemDbHomeDatabaseConnectionStringArgs
                {
                    AllConnectionStrings = 
                    {
                        { "string", "string" },
                    },
                    CdbDefault = "string",
                    CdbIpDefault = "string",
                },
            },
            DatabaseId = "string",
            DatabaseSoftwareImageId = "string",
            DbBackupConfig = new Oci.Database.Inputs.DbSystemDbHomeDatabaseDbBackupConfigArgs
            {
                AutoBackupEnabled = false,
                AutoBackupWindow = "string",
                AutoFullBackupDay = "string",
                AutoFullBackupWindow = "string",
                BackupDeletionPolicy = "string",
                BackupDestinationDetails = new[]
                {
                    new Oci.Database.Inputs.DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs
                    {
                        DbrsPolicyId = "string",
                        Id = "string",
                        Type = "string",
                    },
                },
                RecoveryWindowInDays = 0,
                RunImmediateFullBackup = false,
            },
            DbDomain = "string",
            DbName = "string",
            DbUniqueName = "string",
            DbWorkload = "string",
            DefinedTags = 
            {
                { "string", "string" },
            },
            FreeformTags = 
            {
                { "string", "string" },
            },
            Id = "string",
            KmsKeyId = "string",
            KmsKeyVersionId = "string",
            LifecycleDetails = "string",
            NcharacterSet = "string",
            PdbName = "string",
            PluggableDatabases = new[]
            {
                "string",
            },
            State = "string",
            TdeWalletPassword = "string",
            TimeCreated = "string",
            TimeStampForPointInTimeRecovery = "string",
            VaultId = "string",
        },
        DisplayName = "string",
        DatabaseSoftwareImageId = "string",
        DbHomeLocation = "string",
        DbVersion = "string",
        DefinedTags = 
        {
            { "string", "string" },
        },
        CreateAsync = false,
        FreeformTags = 
        {
            { "string", "string" },
        },
        Id = "string",
        IsUnifiedAuditingEnabled = false,
        LastPatchHistoryEntryId = "string",
        LifecycleDetails = "string",
        State = "string",
        TimeCreated = "string",
    },
    DatabaseEdition = "string",
    MaintenanceWindowDetails = new Oci.Database.Inputs.DbSystemMaintenanceWindowDetailsArgs
    {
        CustomActionTimeoutInMins = 0,
        DaysOfWeeks = new[]
        {
            new Oci.Database.Inputs.DbSystemMaintenanceWindowDetailsDaysOfWeekArgs
            {
                Name = "string",
            },
        },
        HoursOfDays = new[]
        {
            0,
        },
        IsCustomActionTimeoutEnabled = false,
        IsMonthlyPatchingEnabled = false,
        LeadTimeInWeeks = 0,
        Months = new[]
        {
            new Oci.Database.Inputs.DbSystemMaintenanceWindowDetailsMonthArgs
            {
                Name = "string",
            },
        },
        PatchingMode = "string",
        Preference = "string",
        SkipRus = new[]
        {
            false,
        },
        WeeksOfMonths = new[]
        {
            0,
        },
    },
    DataStoragePercentage = 0,
    DataCollectionOptions = new Oci.Database.Inputs.DbSystemDataCollectionOptionsArgs
    {
        IsDiagnosticsEventsEnabled = false,
        IsHealthMonitoringEnabled = false,
        IsIncidentLogsEnabled = false,
    },
    DbSystemOptions = new Oci.Database.Inputs.DbSystemDbSystemOptionsArgs
    {
        StorageManagement = "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    DiskRedundancy = "string",
    DisplayName = "string",
    Domain = "string",
    FaultDomains = new[]
    {
        "string",
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    CpuCoreCount = 0,
    KmsKeyId = "string",
    KmsKeyVersionId = "string",
    LicenseModel = "string",
    DataStorageSizeInGb = 0,
    NodeCount = 0,
    NsgIds = new[]
    {
        "string",
    },
    PrivateIp = "string",
    PrivateIpV6 = "string",
    RecoStorageSizeInGb = 0,
    SecurityAttributes = 
    {
        { "string", "string" },
    },
    ClusterName = "string",
    Source = "string",
    SourceDbSystemId = "string",
    SparseDiskgroup = false,
    BackupSubnetId = "string",
    StorageVolumePerformanceMode = "string",
    BackupNetworkNsgIds = new[]
    {
        "string",
    },
    TimeZone = "string",
});

example, err := Database.NewDbSystem(ctx, "dbSystemResource", &Database.DbSystemArgs{
	AvailabilityDomain: pulumi.String("string"),
	SubnetId:           pulumi.String("string"),
	SshPublicKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	Shape:         pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	Hostname:      pulumi.String("string"),
	DbHome: &database.DbSystemDbHomeArgs{
		Database: &database.DbSystemDbHomeDatabaseArgs{
			AdminPassword:     pulumi.String("string"),
			BackupId:          pulumi.String("string"),
			BackupTdePassword: pulumi.String("string"),
			CharacterSet:      pulumi.String("string"),
			ConnectionStrings: database.DbSystemDbHomeDatabaseConnectionStringArray{
				&database.DbSystemDbHomeDatabaseConnectionStringArgs{
					AllConnectionStrings: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
					CdbDefault:   pulumi.String("string"),
					CdbIpDefault: pulumi.String("string"),
				},
			},
			DatabaseId:              pulumi.String("string"),
			DatabaseSoftwareImageId: pulumi.String("string"),
			DbBackupConfig: &database.DbSystemDbHomeDatabaseDbBackupConfigArgs{
				AutoBackupEnabled:    pulumi.Bool(false),
				AutoBackupWindow:     pulumi.String("string"),
				AutoFullBackupDay:    pulumi.String("string"),
				AutoFullBackupWindow: pulumi.String("string"),
				BackupDeletionPolicy: pulumi.String("string"),
				BackupDestinationDetails: database.DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArray{
					&database.DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs{
						DbrsPolicyId: pulumi.String("string"),
						Id:           pulumi.String("string"),
						Type:         pulumi.String("string"),
					},
				},
				RecoveryWindowInDays:   pulumi.Int(0),
				RunImmediateFullBackup: pulumi.Bool(false),
			},
			DbDomain:     pulumi.String("string"),
			DbName:       pulumi.String("string"),
			DbUniqueName: pulumi.String("string"),
			DbWorkload:   pulumi.String("string"),
			DefinedTags: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			FreeformTags: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Id:               pulumi.String("string"),
			KmsKeyId:         pulumi.String("string"),
			KmsKeyVersionId:  pulumi.String("string"),
			LifecycleDetails: pulumi.String("string"),
			NcharacterSet:    pulumi.String("string"),
			PdbName:          pulumi.String("string"),
			PluggableDatabases: pulumi.StringArray{
				pulumi.String("string"),
			},
			State:                           pulumi.String("string"),
			TdeWalletPassword:               pulumi.String("string"),
			TimeCreated:                     pulumi.String("string"),
			TimeStampForPointInTimeRecovery: pulumi.String("string"),
			VaultId:                         pulumi.String("string"),
		},
		DisplayName:             pulumi.String("string"),
		DatabaseSoftwareImageId: pulumi.String("string"),
		DbHomeLocation:          pulumi.String("string"),
		DbVersion:               pulumi.String("string"),
		DefinedTags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		CreateAsync: pulumi.Bool(false),
		FreeformTags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Id:                       pulumi.String("string"),
		IsUnifiedAuditingEnabled: pulumi.Bool(false),
		LastPatchHistoryEntryId:  pulumi.String("string"),
		LifecycleDetails:         pulumi.String("string"),
		State:                    pulumi.String("string"),
		TimeCreated:              pulumi.String("string"),
	},
	DatabaseEdition: pulumi.String("string"),
	MaintenanceWindowDetails: &database.DbSystemMaintenanceWindowDetailsArgs{
		CustomActionTimeoutInMins: pulumi.Int(0),
		DaysOfWeeks: database.DbSystemMaintenanceWindowDetailsDaysOfWeekArray{
			&database.DbSystemMaintenanceWindowDetailsDaysOfWeekArgs{
				Name: pulumi.String("string"),
			},
		},
		HoursOfDays: pulumi.IntArray{
			pulumi.Int(0),
		},
		IsCustomActionTimeoutEnabled: pulumi.Bool(false),
		IsMonthlyPatchingEnabled:     pulumi.Bool(false),
		LeadTimeInWeeks:              pulumi.Int(0),
		Months: database.DbSystemMaintenanceWindowDetailsMonthArray{
			&database.DbSystemMaintenanceWindowDetailsMonthArgs{
				Name: pulumi.String("string"),
			},
		},
		PatchingMode: pulumi.String("string"),
		Preference:   pulumi.String("string"),
		SkipRus: pulumi.BoolArray{
			pulumi.Bool(false),
		},
		WeeksOfMonths: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	DataStoragePercentage: pulumi.Int(0),
	DataCollectionOptions: &database.DbSystemDataCollectionOptionsArgs{
		IsDiagnosticsEventsEnabled: pulumi.Bool(false),
		IsHealthMonitoringEnabled:  pulumi.Bool(false),
		IsIncidentLogsEnabled:      pulumi.Bool(false),
	},
	DbSystemOptions: &database.DbSystemDbSystemOptionsArgs{
		StorageManagement: pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DiskRedundancy: pulumi.String("string"),
	DisplayName:    pulumi.String("string"),
	Domain:         pulumi.String("string"),
	FaultDomains: pulumi.StringArray{
		pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CpuCoreCount:        pulumi.Int(0),
	KmsKeyId:            pulumi.String("string"),
	KmsKeyVersionId:     pulumi.String("string"),
	LicenseModel:        pulumi.String("string"),
	DataStorageSizeInGb: pulumi.Int(0),
	NodeCount:           pulumi.Int(0),
	NsgIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrivateIp:           pulumi.String("string"),
	PrivateIpV6:         pulumi.String("string"),
	RecoStorageSizeInGb: pulumi.Int(0),
	SecurityAttributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ClusterName:                  pulumi.String("string"),
	Source:                       pulumi.String("string"),
	SourceDbSystemId:             pulumi.String("string"),
	SparseDiskgroup:              pulumi.Bool(false),
	BackupSubnetId:               pulumi.String("string"),
	StorageVolumePerformanceMode: pulumi.String("string"),
	BackupNetworkNsgIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	TimeZone: pulumi.String("string"),
})

var dbSystemResource = new DbSystem("dbSystemResource", DbSystemArgs.builder()
    .availabilityDomain("string")
    .subnetId("string")
    .sshPublicKeys("string")
    .shape("string")
    .compartmentId("string")
    .hostname("string")
    .dbHome(DbSystemDbHomeArgs.builder()
        .database(DbSystemDbHomeDatabaseArgs.builder()
            .adminPassword("string")
            .backupId("string")
            .backupTdePassword("string")
            .characterSet("string")
            .connectionStrings(DbSystemDbHomeDatabaseConnectionStringArgs.builder()
                .allConnectionStrings(Map.of("string", "string"))
                .cdbDefault("string")
                .cdbIpDefault("string")
                .build())
            .databaseId("string")
            .databaseSoftwareImageId("string")
            .dbBackupConfig(DbSystemDbHomeDatabaseDbBackupConfigArgs.builder()
                .autoBackupEnabled(false)
                .autoBackupWindow("string")
                .autoFullBackupDay("string")
                .autoFullBackupWindow("string")
                .backupDeletionPolicy("string")
                .backupDestinationDetails(DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs.builder()
                    .dbrsPolicyId("string")
                    .id("string")
                    .type("string")
                    .build())
                .recoveryWindowInDays(0)
                .runImmediateFullBackup(false)
                .build())
            .dbDomain("string")
            .dbName("string")
            .dbUniqueName("string")
            .dbWorkload("string")
            .definedTags(Map.of("string", "string"))
            .freeformTags(Map.of("string", "string"))
            .id("string")
            .kmsKeyId("string")
            .kmsKeyVersionId("string")
            .lifecycleDetails("string")
            .ncharacterSet("string")
            .pdbName("string")
            .pluggableDatabases("string")
            .state("string")
            .tdeWalletPassword("string")
            .timeCreated("string")
            .timeStampForPointInTimeRecovery("string")
            .vaultId("string")
            .build())
        .displayName("string")
        .databaseSoftwareImageId("string")
        .dbHomeLocation("string")
        .dbVersion("string")
        .definedTags(Map.of("string", "string"))
        .createAsync(false)
        .freeformTags(Map.of("string", "string"))
        .id("string")
        .isUnifiedAuditingEnabled(false)
        .lastPatchHistoryEntryId("string")
        .lifecycleDetails("string")
        .state("string")
        .timeCreated("string")
        .build())
    .databaseEdition("string")
    .maintenanceWindowDetails(DbSystemMaintenanceWindowDetailsArgs.builder()
        .customActionTimeoutInMins(0)
        .daysOfWeeks(DbSystemMaintenanceWindowDetailsDaysOfWeekArgs.builder()
            .name("string")
            .build())
        .hoursOfDays(0)
        .isCustomActionTimeoutEnabled(false)
        .isMonthlyPatchingEnabled(false)
        .leadTimeInWeeks(0)
        .months(DbSystemMaintenanceWindowDetailsMonthArgs.builder()
            .name("string")
            .build())
        .patchingMode("string")
        .preference("string")
        .skipRus(false)
        .weeksOfMonths(0)
        .build())
    .dataStoragePercentage(0)
    .dataCollectionOptions(DbSystemDataCollectionOptionsArgs.builder()
        .isDiagnosticsEventsEnabled(false)
        .isHealthMonitoringEnabled(false)
        .isIncidentLogsEnabled(false)
        .build())
    .dbSystemOptions(DbSystemDbSystemOptionsArgs.builder()
        .storageManagement("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .diskRedundancy("string")
    .displayName("string")
    .domain("string")
    .faultDomains("string")
    .freeformTags(Map.of("string", "string"))
    .cpuCoreCount(0)
    .kmsKeyId("string")
    .kmsKeyVersionId("string")
    .licenseModel("string")
    .dataStorageSizeInGb(0)
    .nodeCount(0)
    .nsgIds("string")
    .privateIp("string")
    .privateIpV6("string")
    .recoStorageSizeInGb(0)
    .securityAttributes(Map.of("string", "string"))
    .clusterName("string")
    .source("string")
    .sourceDbSystemId("string")
    .sparseDiskgroup(false)
    .backupSubnetId("string")
    .storageVolumePerformanceMode("string")
    .backupNetworkNsgIds("string")
    .timeZone("string")
    .build());

db_system_resource = oci.database.DbSystem("dbSystemResource",
    availability_domain="string",
    subnet_id="string",
    ssh_public_keys=["string"],
    shape="string",
    compartment_id="string",
    hostname="string",
    db_home={
        "database": {
            "admin_password": "string",
            "backup_id": "string",
            "backup_tde_password": "string",
            "character_set": "string",
            "connection_strings": [{
                "all_connection_strings": {
                    "string": "string",
                },
                "cdb_default": "string",
                "cdb_ip_default": "string",
            }],
            "database_id": "string",
            "database_software_image_id": "string",
            "db_backup_config": {
                "auto_backup_enabled": False,
                "auto_backup_window": "string",
                "auto_full_backup_day": "string",
                "auto_full_backup_window": "string",
                "backup_deletion_policy": "string",
                "backup_destination_details": [{
                    "dbrs_policy_id": "string",
                    "id": "string",
                    "type": "string",
                }],
                "recovery_window_in_days": 0,
                "run_immediate_full_backup": False,
            },
            "db_domain": "string",
            "db_name": "string",
            "db_unique_name": "string",
            "db_workload": "string",
            "defined_tags": {
                "string": "string",
            },
            "freeform_tags": {
                "string": "string",
            },
            "id": "string",
            "kms_key_id": "string",
            "kms_key_version_id": "string",
            "lifecycle_details": "string",
            "ncharacter_set": "string",
            "pdb_name": "string",
            "pluggable_databases": ["string"],
            "state": "string",
            "tde_wallet_password": "string",
            "time_created": "string",
            "time_stamp_for_point_in_time_recovery": "string",
            "vault_id": "string",
        },
        "display_name": "string",
        "database_software_image_id": "string",
        "db_home_location": "string",
        "db_version": "string",
        "defined_tags": {
            "string": "string",
        },
        "create_async": False,
        "freeform_tags": {
            "string": "string",
        },
        "id": "string",
        "is_unified_auditing_enabled": False,
        "last_patch_history_entry_id": "string",
        "lifecycle_details": "string",
        "state": "string",
        "time_created": "string",
    },
    database_edition="string",
    maintenance_window_details={
        "custom_action_timeout_in_mins": 0,
        "days_of_weeks": [{
            "name": "string",
        }],
        "hours_of_days": [0],
        "is_custom_action_timeout_enabled": False,
        "is_monthly_patching_enabled": False,
        "lead_time_in_weeks": 0,
        "months": [{
            "name": "string",
        }],
        "patching_mode": "string",
        "preference": "string",
        "skip_rus": [False],
        "weeks_of_months": [0],
    },
    data_storage_percentage=0,
    data_collection_options={
        "is_diagnostics_events_enabled": False,
        "is_health_monitoring_enabled": False,
        "is_incident_logs_enabled": False,
    },
    db_system_options={
        "storage_management": "string",
    },
    defined_tags={
        "string": "string",
    },
    disk_redundancy="string",
    display_name="string",
    domain="string",
    fault_domains=["string"],
    freeform_tags={
        "string": "string",
    },
    cpu_core_count=0,
    kms_key_id="string",
    kms_key_version_id="string",
    license_model="string",
    data_storage_size_in_gb=0,
    node_count=0,
    nsg_ids=["string"],
    private_ip="string",
    private_ip_v6="string",
    reco_storage_size_in_gb=0,
    security_attributes={
        "string": "string",
    },
    cluster_name="string",
    source="string",
    source_db_system_id="string",
    sparse_diskgroup=False,
    backup_subnet_id="string",
    storage_volume_performance_mode="string",
    backup_network_nsg_ids=["string"],
    time_zone="string")

const dbSystemResource = new oci.database.DbSystem("dbSystemResource", {
    availabilityDomain: "string",
    subnetId: "string",
    sshPublicKeys: ["string"],
    shape: "string",
    compartmentId: "string",
    hostname: "string",
    dbHome: {
        database: {
            adminPassword: "string",
            backupId: "string",
            backupTdePassword: "string",
            characterSet: "string",
            connectionStrings: [{
                allConnectionStrings: {
                    string: "string",
                },
                cdbDefault: "string",
                cdbIpDefault: "string",
            }],
            databaseId: "string",
            databaseSoftwareImageId: "string",
            dbBackupConfig: {
                autoBackupEnabled: false,
                autoBackupWindow: "string",
                autoFullBackupDay: "string",
                autoFullBackupWindow: "string",
                backupDeletionPolicy: "string",
                backupDestinationDetails: [{
                    dbrsPolicyId: "string",
                    id: "string",
                    type: "string",
                }],
                recoveryWindowInDays: 0,
                runImmediateFullBackup: false,
            },
            dbDomain: "string",
            dbName: "string",
            dbUniqueName: "string",
            dbWorkload: "string",
            definedTags: {
                string: "string",
            },
            freeformTags: {
                string: "string",
            },
            id: "string",
            kmsKeyId: "string",
            kmsKeyVersionId: "string",
            lifecycleDetails: "string",
            ncharacterSet: "string",
            pdbName: "string",
            pluggableDatabases: ["string"],
            state: "string",
            tdeWalletPassword: "string",
            timeCreated: "string",
            timeStampForPointInTimeRecovery: "string",
            vaultId: "string",
        },
        displayName: "string",
        databaseSoftwareImageId: "string",
        dbHomeLocation: "string",
        dbVersion: "string",
        definedTags: {
            string: "string",
        },
        createAsync: false,
        freeformTags: {
            string: "string",
        },
        id: "string",
        isUnifiedAuditingEnabled: false,
        lastPatchHistoryEntryId: "string",
        lifecycleDetails: "string",
        state: "string",
        timeCreated: "string",
    },
    databaseEdition: "string",
    maintenanceWindowDetails: {
        customActionTimeoutInMins: 0,
        daysOfWeeks: [{
            name: "string",
        }],
        hoursOfDays: [0],
        isCustomActionTimeoutEnabled: false,
        isMonthlyPatchingEnabled: false,
        leadTimeInWeeks: 0,
        months: [{
            name: "string",
        }],
        patchingMode: "string",
        preference: "string",
        skipRus: [false],
        weeksOfMonths: [0],
    },
    dataStoragePercentage: 0,
    dataCollectionOptions: {
        isDiagnosticsEventsEnabled: false,
        isHealthMonitoringEnabled: false,
        isIncidentLogsEnabled: false,
    },
    dbSystemOptions: {
        storageManagement: "string",
    },
    definedTags: {
        string: "string",
    },
    diskRedundancy: "string",
    displayName: "string",
    domain: "string",
    faultDomains: ["string"],
    freeformTags: {
        string: "string",
    },
    cpuCoreCount: 0,
    kmsKeyId: "string",
    kmsKeyVersionId: "string",
    licenseModel: "string",
    dataStorageSizeInGb: 0,
    nodeCount: 0,
    nsgIds: ["string"],
    privateIp: "string",
    privateIpV6: "string",
    recoStorageSizeInGb: 0,
    securityAttributes: {
        string: "string",
    },
    clusterName: "string",
    source: "string",
    sourceDbSystemId: "string",
    sparseDiskgroup: false,
    backupSubnetId: "string",
    storageVolumePerformanceMode: "string",
    backupNetworkNsgIds: ["string"],
    timeZone: "string",
});

type: oci:Database:DbSystem
properties:
    availabilityDomain: string
    backupNetworkNsgIds:
        - string
    backupSubnetId: string
    clusterName: string
    compartmentId: string
    cpuCoreCount: 0
    dataCollectionOptions:
        isDiagnosticsEventsEnabled: false
        isHealthMonitoringEnabled: false
        isIncidentLogsEnabled: false
    dataStoragePercentage: 0
    dataStorageSizeInGb: 0
    databaseEdition: string
    dbHome:
        createAsync: false
        database:
            adminPassword: string
            backupId: string
            backupTdePassword: string
            characterSet: string
            connectionStrings:
                - allConnectionStrings:
                    string: string
                  cdbDefault: string
                  cdbIpDefault: string
            databaseId: string
            databaseSoftwareImageId: string
            dbBackupConfig:
                autoBackupEnabled: false
                autoBackupWindow: string
                autoFullBackupDay: string
                autoFullBackupWindow: string
                backupDeletionPolicy: string
                backupDestinationDetails:
                    - dbrsPolicyId: string
                      id: string
                      type: string
                recoveryWindowInDays: 0
                runImmediateFullBackup: false
            dbDomain: string
            dbName: string
            dbUniqueName: string
            dbWorkload: string
            definedTags:
                string: string
            freeformTags:
                string: string
            id: string
            kmsKeyId: string
            kmsKeyVersionId: string
            lifecycleDetails: string
            ncharacterSet: string
            pdbName: string
            pluggableDatabases:
                - string
            state: string
            tdeWalletPassword: string
            timeCreated: string
            timeStampForPointInTimeRecovery: string
            vaultId: string
        databaseSoftwareImageId: string
        dbHomeLocation: string
        dbVersion: string
        definedTags:
            string: string
        displayName: string
        freeformTags:
            string: string
        id: string
        isUnifiedAuditingEnabled: false
        lastPatchHistoryEntryId: string
        lifecycleDetails: string
        state: string
        timeCreated: string
    dbSystemOptions:
        storageManagement: string
    definedTags:
        string: string
    diskRedundancy: string
    displayName: string
    domain: string
    faultDomains:
        - string
    freeformTags:
        string: string
    hostname: string
    kmsKeyId: string
    kmsKeyVersionId: string
    licenseModel: string
    maintenanceWindowDetails:
        customActionTimeoutInMins: 0
        daysOfWeeks:
            - name: string
        hoursOfDays:
            - 0
        isCustomActionTimeoutEnabled: false
        isMonthlyPatchingEnabled: false
        leadTimeInWeeks: 0
        months:
            - name: string
        patchingMode: string
        preference: string
        skipRus:
            - false
        weeksOfMonths:
            - 0
    nodeCount: 0
    nsgIds:
        - string
    privateIp: string
    privateIpV6: string
    recoStorageSizeInGb: 0
    securityAttributes:
        string: string
    shape: string
    source: string
    sourceDbSystemId: string
    sparseDiskgroup: false
    sshPublicKeys:
        - string
    storageVolumePerformanceMode: string
    subnetId: string
    timeZone: string

DbSystem Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DbSystem resource accepts the following input properties:

AvailabilityDomain string

The availability domain where the DB system is located.

CompartmentId string

(Updatable) The OCID of the compartment the DB system belongs in.

DbHome DbSystemDbHome

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Hostname string

The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

Shape string

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

SshPublicKeys List<string>

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

SubnetId string

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.

BackupNetworkNsgIds List<string>

(Updatable) A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

BackupSubnetId string

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

ClusterName string

The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

CpuCoreCount int

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems

DataCollectionOptions DbSystemDataCollectionOptions

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

DataStoragePercentage int

The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.

DataStorageSizeInGb int

(Updatable) Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. Required for VMDBs.

DatabaseEdition string

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

DbSystemOptions DbSystemDbSystemOptions

The DB system options.

DefinedTags Dictionary<string, string>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DiskRedundancy string

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

DisplayName string

The user-friendly name for the DB system. The name does not have to be unique.

Domain string

A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.

FaultDomains List<string>

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

FreeformTags Dictionary<string, string>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyVersionId string

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

LicenseModel string

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

MaintenanceWindowDetails DbSystemMaintenanceWindowDetails

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

NodeCount int

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

NsgIds List<string>

(Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

PrivateIp string

A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. Supported for VM BM shape.

PrivateIpV6 string

A private IPv6 address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value and the subnet is dual stack, Oracle automatically assigns a private IPv6 address from the subnet.

RecoStorageSizeInGb int

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

SecurityAttributes Dictionary<string, string>

(Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}

Source string

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. Use DATABASE for creating a new database from an existing database, including archive redo log data. The default is NONE.

SourceDbSystemId string

The OCID of the DB system.

SparseDiskgroup bool

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

StorageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

TimeZone string

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

AvailabilityDomain string

The availability domain where the DB system is located.

CompartmentId string

(Updatable) The OCID of the compartment the DB system belongs in.

DbHome DbSystemDbHomeArgs

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Hostname string

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

Shape string

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

SshPublicKeys []string

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

SubnetId string

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

BackupNetworkNsgIds []string

BackupSubnetId string

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

ClusterName string

CpuCoreCount int

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

DataCollectionOptions DbSystemDataCollectionOptionsArgs

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

DataStoragePercentage int

DataStorageSizeInGb int

DatabaseEdition string

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

DbSystemOptions DbSystemDbSystemOptionsArgs

The DB system options.

DefinedTags map[string]string

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DiskRedundancy string

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

DisplayName string

The user-friendly name for the DB system. The name does not have to be unique.

Domain string

FaultDomains []string

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

FreeformTags map[string]string

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyVersionId string

LicenseModel string

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

MaintenanceWindowDetails DbSystemMaintenanceWindowDetailsArgs

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

NodeCount int

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

NsgIds []string

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

PrivateIp string

PrivateIpV6 string

RecoStorageSizeInGb int

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

SecurityAttributes map[string]string

Source string

SourceDbSystemId string

The OCID of the DB system.

SparseDiskgroup bool

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

StorageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

TimeZone string

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

availabilityDomain String

The availability domain where the DB system is located.

compartmentId String

(Updatable) The OCID of the compartment the DB system belongs in.

dbHome DbSystemDbHome

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

hostname String

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

shape String

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

sshPublicKeys List<String>

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

subnetId String

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

backupNetworkNsgIds List<String>

backupSubnetId String

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

clusterName String

cpuCoreCount Integer

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

dataCollectionOptions DbSystemDataCollectionOptions

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataStoragePercentage Integer

dataStorageSizeInGb Integer

databaseEdition String

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

dbSystemOptions DbSystemDbSystemOptions

The DB system options.

definedTags Map<String,String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

diskRedundancy String

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

displayName String

The user-friendly name for the DB system. The name does not have to be unique.

domain String

faultDomains List<String>

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

freeformTags Map<String,String>

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId String

licenseModel String

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

maintenanceWindowDetails DbSystemMaintenanceWindowDetails

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

nodeCount Integer

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

nsgIds List<String>

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

privateIp String

privateIpV6 String

recoStorageSizeInGb Integer

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

securityAttributes Map<String,String>

source String

sourceDbSystemId String

The OCID of the DB system.

sparseDiskgroup Boolean

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

storageVolumePerformanceMode String

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

timeZone String

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

availabilityDomain string

The availability domain where the DB system is located.

compartmentId string

(Updatable) The OCID of the compartment the DB system belongs in.

dbHome DbSystemDbHome

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

hostname string

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

shape string

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

sshPublicKeys string[]

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

subnetId string

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

backupNetworkNsgIds string[]

backupSubnetId string

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

clusterName string

cpuCoreCount number

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

dataCollectionOptions DbSystemDataCollectionOptions

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataStoragePercentage number

dataStorageSizeInGb number

databaseEdition string

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

dbSystemOptions DbSystemDbSystemOptions

The DB system options.

definedTags {[key: string]: string}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

diskRedundancy string

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

displayName string

The user-friendly name for the DB system. The name does not have to be unique.

domain string

faultDomains string[]

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

freeformTags {[key: string]: string}

kmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId string

licenseModel string

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

maintenanceWindowDetails DbSystemMaintenanceWindowDetails

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

nodeCount number

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

nsgIds string[]

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

privateIp string

privateIpV6 string

recoStorageSizeInGb number

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

securityAttributes {[key: string]: string}

source string

sourceDbSystemId string

The OCID of the DB system.

sparseDiskgroup boolean

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

storageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

timeZone string

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

availability_domain str

The availability domain where the DB system is located.

compartment_id str

(Updatable) The OCID of the compartment the DB system belongs in.

db_home database.DbSystemDbHomeArgs

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

hostname str

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

shape str

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

ssh_public_keys Sequence[str]

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

subnet_id str

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

backup_network_nsg_ids Sequence[str]

backup_subnet_id str

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

cluster_name str

cpu_core_count int

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

data_collection_options database.DbSystemDataCollectionOptionsArgs

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

data_storage_percentage int

data_storage_size_in_gb int

database_edition str

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

db_system_options database.DbSystemDbSystemOptionsArgs

The DB system options.

defined_tags Mapping[str, str]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

disk_redundancy str

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

display_name str

The user-friendly name for the DB system. The name does not have to be unique.

domain str

fault_domains Sequence[str]

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

freeform_tags Mapping[str, str]

kms_key_id str

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kms_key_version_id str

license_model str

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

maintenance_window_details database.DbSystemMaintenanceWindowDetailsArgs

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

node_count int

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

nsg_ids Sequence[str]

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

private_ip str

private_ip_v6 str

reco_storage_size_in_gb int

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

security_attributes Mapping[str, str]

source str

source_db_system_id str

The OCID of the DB system.

sparse_diskgroup bool

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

storage_volume_performance_mode str

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

time_zone str

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

availabilityDomain String

The availability domain where the DB system is located.

compartmentId String

(Updatable) The OCID of the compartment the DB system belongs in.

dbHome Property Map

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

hostname String

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

shape String

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

sshPublicKeys List<String>

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

subnetId String

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

backupNetworkNsgIds List<String>

backupSubnetId String

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

clusterName String

cpuCoreCount Number

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

dataCollectionOptions Property Map

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataStoragePercentage Number

dataStorageSizeInGb Number

databaseEdition String

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

dbSystemOptions Property Map

The DB system options.

definedTags Map<String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

diskRedundancy String

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

displayName String

The user-friendly name for the DB system. The name does not have to be unique.

domain String

faultDomains List<String>

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

freeformTags Map<String>

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId String

licenseModel String

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

maintenanceWindowDetails Property Map

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

nodeCount Number

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

nsgIds List<String>

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

privateIp String

privateIpV6 String

recoStorageSizeInGb Number

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

securityAttributes Map<String>

source String

sourceDbSystemId String

The OCID of the DB system.

sparseDiskgroup Boolean

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

storageVolumePerformanceMode String

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

timeZone String

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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:

Id string: The provider-assigned unique ID for this managed resource.
IormConfigCaches List<DbSystemIormConfigCach>: The IORM settings of the Exadata DB system.
LastMaintenanceRunId string: The OCID of the last maintenance run.
LastPatchHistoryEntryId string: The OCID of the last patch history. This value is updated as soon as a patch operation starts.
LifecycleDetails string: Additional information about the current lifecycle state.
ListenerPort int: The port number configured for the listener on the DB system.
MaintenanceWindows List<DbSystemMaintenanceWindow>: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
MemorySizeInGbs int: Memory allocated to the DB system, in gigabytes.
NextMaintenanceRunId string: The OCID of the next maintenance run.
OsVersion string: The most recent OS Patch Version applied on the DB system.
PointInTimeDataDiskCloneTimestamp string: The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
ScanDnsName string: The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
ScanDnsRecordId string: The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
ScanIpIds List<string>: The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
ScanIpv6ids List<string>: The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
State string: The current state of the DB system.
TimeCreated string: The date and time the DB system was created.
Version string: The Oracle Database version of the DB system.
VipIds List<string>: The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
Vipv6ids List<string>: The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
ZoneId string: The OCID of the zone the DB system is associated with.

Id string: The provider-assigned unique ID for this managed resource.
IormConfigCaches []DbSystemIormConfigCach: The IORM settings of the Exadata DB system.
LastMaintenanceRunId string: The OCID of the last maintenance run.
LastPatchHistoryEntryId string: The OCID of the last patch history. This value is updated as soon as a patch operation starts.
LifecycleDetails string: Additional information about the current lifecycle state.
ListenerPort int: The port number configured for the listener on the DB system.
MaintenanceWindows []DbSystemMaintenanceWindow: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
MemorySizeInGbs int: Memory allocated to the DB system, in gigabytes.
NextMaintenanceRunId string: The OCID of the next maintenance run.
OsVersion string: The most recent OS Patch Version applied on the DB system.
PointInTimeDataDiskCloneTimestamp string: The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
ScanDnsName string: The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
ScanDnsRecordId string: The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
ScanIpIds []string: The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
ScanIpv6ids []string: The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
State string: The current state of the DB system.
TimeCreated string: The date and time the DB system was created.
Version string: The Oracle Database version of the DB system.
VipIds []string: The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
Vipv6ids []string: The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
ZoneId string: The OCID of the zone the DB system is associated with.

id String: The provider-assigned unique ID for this managed resource.
iormConfigCaches List<DbSystemIormConfigCach>: The IORM settings of the Exadata DB system.
lastMaintenanceRunId String: The OCID of the last maintenance run.
lastPatchHistoryEntryId String: The OCID of the last patch history. This value is updated as soon as a patch operation starts.
lifecycleDetails String: Additional information about the current lifecycle state.
listenerPort Integer: The port number configured for the listener on the DB system.
maintenanceWindows List<DbSystemMaintenanceWindow>: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
memorySizeInGbs Integer: Memory allocated to the DB system, in gigabytes.
nextMaintenanceRunId String: The OCID of the next maintenance run.
osVersion String: The most recent OS Patch Version applied on the DB system.
pointInTimeDataDiskCloneTimestamp String: The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
scanDnsName String: The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanDnsRecordId String: The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanIpIds List<String>: The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
scanIpv6ids List<String>: The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
state String: The current state of the DB system.
timeCreated String: The date and time the DB system was created.
version String: The Oracle Database version of the DB system.
vipIds List<String>: The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
vipv6ids List<String>: The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
zoneId String: The OCID of the zone the DB system is associated with.

id string: The provider-assigned unique ID for this managed resource.
iormConfigCaches DbSystemIormConfigCach[]: The IORM settings of the Exadata DB system.
lastMaintenanceRunId string: The OCID of the last maintenance run.
lastPatchHistoryEntryId string: The OCID of the last patch history. This value is updated as soon as a patch operation starts.
lifecycleDetails string: Additional information about the current lifecycle state.
listenerPort number: The port number configured for the listener on the DB system.
maintenanceWindows DbSystemMaintenanceWindow[]: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
memorySizeInGbs number: Memory allocated to the DB system, in gigabytes.
nextMaintenanceRunId string: The OCID of the next maintenance run.
osVersion string: The most recent OS Patch Version applied on the DB system.
pointInTimeDataDiskCloneTimestamp string: The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
scanDnsName string: The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanDnsRecordId string: The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanIpIds string[]: The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
scanIpv6ids string[]: The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
state string: The current state of the DB system.
timeCreated string: The date and time the DB system was created.
version string: The Oracle Database version of the DB system.
vipIds string[]: The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
vipv6ids string[]: The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
zoneId string: The OCID of the zone the DB system is associated with.

id str: The provider-assigned unique ID for this managed resource.
iorm_config_caches Sequence[database.DbSystemIormConfigCach]: The IORM settings of the Exadata DB system.
last_maintenance_run_id str: The OCID of the last maintenance run.
last_patch_history_entry_id str: The OCID of the last patch history. This value is updated as soon as a patch operation starts.
lifecycle_details str: Additional information about the current lifecycle state.
listener_port int: The port number configured for the listener on the DB system.
maintenance_windows Sequence[database.DbSystemMaintenanceWindow]: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
memory_size_in_gbs int: Memory allocated to the DB system, in gigabytes.
next_maintenance_run_id str: The OCID of the next maintenance run.
os_version str: The most recent OS Patch Version applied on the DB system.
point_in_time_data_disk_clone_timestamp str: The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
scan_dns_name str: The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
scan_dns_record_id str: The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
scan_ip_ids Sequence[str]: The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
scan_ipv6ids Sequence[str]: The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
state str: The current state of the DB system.
time_created str: The date and time the DB system was created.
version str: The Oracle Database version of the DB system.
vip_ids Sequence[str]: The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
vipv6ids Sequence[str]: The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
zone_id str: The OCID of the zone the DB system is associated with.

id String: The provider-assigned unique ID for this managed resource.
iormConfigCaches List<Property Map>: The IORM settings of the Exadata DB system.
lastMaintenanceRunId String: The OCID of the last maintenance run.
lastPatchHistoryEntryId String: The OCID of the last patch history. This value is updated as soon as a patch operation starts.
lifecycleDetails String: Additional information about the current lifecycle state.
listenerPort Number: The port number configured for the listener on the DB system.
maintenanceWindows List<Property Map>: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
memorySizeInGbs Number: Memory allocated to the DB system, in gigabytes.
nextMaintenanceRunId String: The OCID of the next maintenance run.
osVersion String: The most recent OS Patch Version applied on the DB system.
pointInTimeDataDiskCloneTimestamp String: The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
scanDnsName String: The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanDnsRecordId String: The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanIpIds List<String>: The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
scanIpv6ids List<String>: The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
state String: The current state of the DB system.
timeCreated String: The date and time the DB system was created.
version String: The Oracle Database version of the DB system.
vipIds List<String>: The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
vipv6ids List<String>: The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
zoneId String: The OCID of the zone the DB system is associated with.

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,
        availability_domain: Optional[str] = None,
        backup_network_nsg_ids: Optional[Sequence[str]] = None,
        backup_subnet_id: Optional[str] = None,
        cluster_name: Optional[str] = None,
        compartment_id: Optional[str] = None,
        cpu_core_count: Optional[int] = None,
        data_collection_options: Optional[_database.DbSystemDataCollectionOptionsArgs] = None,
        data_storage_percentage: Optional[int] = None,
        data_storage_size_in_gb: Optional[int] = None,
        database_edition: Optional[str] = None,
        db_home: Optional[_database.DbSystemDbHomeArgs] = None,
        db_system_options: Optional[_database.DbSystemDbSystemOptionsArgs] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        disk_redundancy: Optional[str] = None,
        display_name: Optional[str] = None,
        domain: Optional[str] = None,
        fault_domains: Optional[Sequence[str]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        hostname: Optional[str] = None,
        iorm_config_caches: Optional[Sequence[_database.DbSystemIormConfigCachArgs]] = None,
        kms_key_id: Optional[str] = None,
        kms_key_version_id: Optional[str] = None,
        last_maintenance_run_id: Optional[str] = None,
        last_patch_history_entry_id: Optional[str] = None,
        license_model: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        listener_port: Optional[int] = None,
        maintenance_window_details: Optional[_database.DbSystemMaintenanceWindowDetailsArgs] = None,
        maintenance_windows: Optional[Sequence[_database.DbSystemMaintenanceWindowArgs]] = None,
        memory_size_in_gbs: Optional[int] = None,
        next_maintenance_run_id: Optional[str] = None,
        node_count: Optional[int] = None,
        nsg_ids: Optional[Sequence[str]] = None,
        os_version: Optional[str] = None,
        point_in_time_data_disk_clone_timestamp: Optional[str] = None,
        private_ip: Optional[str] = None,
        private_ip_v6: Optional[str] = None,
        reco_storage_size_in_gb: Optional[int] = None,
        scan_dns_name: Optional[str] = None,
        scan_dns_record_id: Optional[str] = None,
        scan_ip_ids: Optional[Sequence[str]] = None,
        scan_ipv6ids: Optional[Sequence[str]] = None,
        security_attributes: Optional[Mapping[str, str]] = None,
        shape: Optional[str] = None,
        source: Optional[str] = None,
        source_db_system_id: Optional[str] = None,
        sparse_diskgroup: Optional[bool] = None,
        ssh_public_keys: Optional[Sequence[str]] = None,
        state: Optional[str] = None,
        storage_volume_performance_mode: Optional[str] = None,
        subnet_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_zone: Optional[str] = None,
        version: Optional[str] = None,
        vip_ids: Optional[Sequence[str]] = None,
        vipv6ids: Optional[Sequence[str]] = None,
        zone_id: 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)

resources:  _:    type: oci:Database:DbSystem    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AvailabilityDomain string

The availability domain where the DB system is located.

BackupNetworkNsgIds List<string>

BackupSubnetId string

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

ClusterName string

CompartmentId string

(Updatable) The OCID of the compartment the DB system belongs in.

CpuCoreCount int

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

DataCollectionOptions DbSystemDataCollectionOptions

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

DataStoragePercentage int

DataStorageSizeInGb int

DatabaseEdition string

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

DbHome DbSystemDbHome

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

DbSystemOptions DbSystemDbSystemOptions

The DB system options.

DefinedTags Dictionary<string, string>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DiskRedundancy string

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

DisplayName string

The user-friendly name for the DB system. The name does not have to be unique.

Domain string

FaultDomains List<string>

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

FreeformTags Dictionary<string, string>

Hostname string

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

IormConfigCaches List<DbSystemIormConfigCach>

The IORM settings of the Exadata DB system.

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyVersionId string

LastMaintenanceRunId string

The OCID of the last maintenance run.

LastPatchHistoryEntryId string

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

LicenseModel string

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

LifecycleDetails string

Additional information about the current lifecycle state.

ListenerPort int

The port number configured for the listener on the DB system.

MaintenanceWindowDetails DbSystemMaintenanceWindowDetails

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

MaintenanceWindows List<DbSystemMaintenanceWindow>

The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

MemorySizeInGbs int

Memory allocated to the DB system, in gigabytes.

NextMaintenanceRunId string

The OCID of the next maintenance run.

NodeCount int

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

NsgIds List<string>

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

OsVersion string

The most recent OS Patch Version applied on the DB system.

PointInTimeDataDiskCloneTimestamp string

The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.

PrivateIp string

PrivateIpV6 string

RecoStorageSizeInGb int

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

ScanDnsName string

The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

ScanDnsRecordId string

The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.

ScanIpIds List<string>

The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.

ScanIpv6ids List<string>

The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.

SecurityAttributes Dictionary<string, string>

Shape string

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

Source string

SourceDbSystemId string

The OCID of the DB system.

SparseDiskgroup bool

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

SshPublicKeys List<string>

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

State string

The current state of the DB system.

StorageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

SubnetId string

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

TimeCreated string

The date and time the DB system was created.

TimeZone string

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

Version string

The Oracle Database version of the DB system.

VipIds List<string>

The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.

Vipv6ids List<string>

The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.

ZoneId string

The OCID of the zone the DB system is associated with.

AvailabilityDomain string

The availability domain where the DB system is located.

BackupNetworkNsgIds []string

BackupSubnetId string

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

ClusterName string

CompartmentId string

(Updatable) The OCID of the compartment the DB system belongs in.

CpuCoreCount int

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

DataCollectionOptions DbSystemDataCollectionOptionsArgs

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

DataStoragePercentage int

DataStorageSizeInGb int

DatabaseEdition string

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

DbHome DbSystemDbHomeArgs

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

DbSystemOptions DbSystemDbSystemOptionsArgs

The DB system options.

DefinedTags map[string]string

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DiskRedundancy string

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

DisplayName string

The user-friendly name for the DB system. The name does not have to be unique.

Domain string

FaultDomains []string

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

FreeformTags map[string]string

Hostname string

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

IormConfigCaches []DbSystemIormConfigCachArgs

The IORM settings of the Exadata DB system.

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyVersionId string

LastMaintenanceRunId string

The OCID of the last maintenance run.

LastPatchHistoryEntryId string

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

LicenseModel string

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

LifecycleDetails string

Additional information about the current lifecycle state.

ListenerPort int

The port number configured for the listener on the DB system.

MaintenanceWindowDetails DbSystemMaintenanceWindowDetailsArgs

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

MaintenanceWindows []DbSystemMaintenanceWindowArgs

The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

MemorySizeInGbs int

Memory allocated to the DB system, in gigabytes.

NextMaintenanceRunId string

The OCID of the next maintenance run.

NodeCount int

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

NsgIds []string

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

OsVersion string

The most recent OS Patch Version applied on the DB system.

PointInTimeDataDiskCloneTimestamp string

The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.

PrivateIp string

PrivateIpV6 string

RecoStorageSizeInGb int

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

ScanDnsName string

The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

ScanDnsRecordId string

The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.

ScanIpIds []string

ScanIpv6ids []string

SecurityAttributes map[string]string

Shape string

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

Source string

SourceDbSystemId string

The OCID of the DB system.

SparseDiskgroup bool

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

SshPublicKeys []string

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

State string

The current state of the DB system.

StorageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

SubnetId string

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

TimeCreated string

The date and time the DB system was created.

TimeZone string

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

Version string

The Oracle Database version of the DB system.

VipIds []string

Vipv6ids []string

ZoneId string

The OCID of the zone the DB system is associated with.

availabilityDomain String

The availability domain where the DB system is located.

backupNetworkNsgIds List<String>

backupSubnetId String

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

clusterName String

compartmentId String

(Updatable) The OCID of the compartment the DB system belongs in.

cpuCoreCount Integer

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

dataCollectionOptions DbSystemDataCollectionOptions

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataStoragePercentage Integer

dataStorageSizeInGb Integer

databaseEdition String

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

dbHome DbSystemDbHome

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

dbSystemOptions DbSystemDbSystemOptions

The DB system options.

definedTags Map<String,String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

diskRedundancy String

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

displayName String

The user-friendly name for the DB system. The name does not have to be unique.

domain String

faultDomains List<String>

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

freeformTags Map<String,String>

hostname String

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

iormConfigCaches List<DbSystemIormConfigCach>

The IORM settings of the Exadata DB system.

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId String

lastMaintenanceRunId String

The OCID of the last maintenance run.

lastPatchHistoryEntryId String

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

licenseModel String

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

lifecycleDetails String

Additional information about the current lifecycle state.

listenerPort Integer

The port number configured for the listener on the DB system.

maintenanceWindowDetails DbSystemMaintenanceWindowDetails

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

maintenanceWindows List<DbSystemMaintenanceWindow>

The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

memorySizeInGbs Integer

Memory allocated to the DB system, in gigabytes.

nextMaintenanceRunId String

The OCID of the next maintenance run.

nodeCount Integer

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

nsgIds List<String>

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

osVersion String

The most recent OS Patch Version applied on the DB system.

pointInTimeDataDiskCloneTimestamp String

The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.

privateIp String

privateIpV6 String

recoStorageSizeInGb Integer

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

scanDnsName String

The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

scanDnsRecordId String

The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.

scanIpIds List<String>

scanIpv6ids List<String>

securityAttributes Map<String,String>

shape String

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

source String

sourceDbSystemId String

The OCID of the DB system.

sparseDiskgroup Boolean

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

sshPublicKeys List<String>

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

state String

The current state of the DB system.

storageVolumePerformanceMode String

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnetId String

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

timeCreated String

The date and time the DB system was created.

timeZone String

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

version String

The Oracle Database version of the DB system.

vipIds List<String>

vipv6ids List<String>

zoneId String

The OCID of the zone the DB system is associated with.

availabilityDomain string

The availability domain where the DB system is located.

backupNetworkNsgIds string[]

backupSubnetId string

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

clusterName string

compartmentId string

(Updatable) The OCID of the compartment the DB system belongs in.

cpuCoreCount number

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

dataCollectionOptions DbSystemDataCollectionOptions

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataStoragePercentage number

dataStorageSizeInGb number

databaseEdition string

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

dbHome DbSystemDbHome

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

dbSystemOptions DbSystemDbSystemOptions

The DB system options.

definedTags {[key: string]: string}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

diskRedundancy string

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

displayName string

The user-friendly name for the DB system. The name does not have to be unique.

domain string

faultDomains string[]

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

freeformTags {[key: string]: string}

hostname string

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

iormConfigCaches DbSystemIormConfigCach[]

The IORM settings of the Exadata DB system.

kmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId string

lastMaintenanceRunId string

The OCID of the last maintenance run.

lastPatchHistoryEntryId string

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

licenseModel string

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

lifecycleDetails string

Additional information about the current lifecycle state.

listenerPort number

The port number configured for the listener on the DB system.

maintenanceWindowDetails DbSystemMaintenanceWindowDetails

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

maintenanceWindows DbSystemMaintenanceWindow[]

The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

memorySizeInGbs number

Memory allocated to the DB system, in gigabytes.

nextMaintenanceRunId string

The OCID of the next maintenance run.

nodeCount number

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

nsgIds string[]

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

osVersion string

The most recent OS Patch Version applied on the DB system.

pointInTimeDataDiskCloneTimestamp string

The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.

privateIp string

privateIpV6 string

recoStorageSizeInGb number

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

scanDnsName string

The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

scanDnsRecordId string

The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.

scanIpIds string[]

scanIpv6ids string[]

securityAttributes {[key: string]: string}

shape string

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

source string

sourceDbSystemId string

The OCID of the DB system.

sparseDiskgroup boolean

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

sshPublicKeys string[]

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

state string

The current state of the DB system.

storageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnetId string

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

timeCreated string

The date and time the DB system was created.

timeZone string

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

version string

The Oracle Database version of the DB system.

vipIds string[]

vipv6ids string[]

zoneId string

The OCID of the zone the DB system is associated with.

availability_domain str

The availability domain where the DB system is located.

backup_network_nsg_ids Sequence[str]

backup_subnet_id str

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

cluster_name str

compartment_id str

(Updatable) The OCID of the compartment the DB system belongs in.

cpu_core_count int

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

data_collection_options database.DbSystemDataCollectionOptionsArgs

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

data_storage_percentage int

data_storage_size_in_gb int

database_edition str

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

db_home database.DbSystemDbHomeArgs

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

db_system_options database.DbSystemDbSystemOptionsArgs

The DB system options.

defined_tags Mapping[str, str]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

disk_redundancy str

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

display_name str

The user-friendly name for the DB system. The name does not have to be unique.

domain str

fault_domains Sequence[str]

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

freeform_tags Mapping[str, str]

hostname str

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

iorm_config_caches Sequence[database.DbSystemIormConfigCachArgs]

The IORM settings of the Exadata DB system.

kms_key_id str

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kms_key_version_id str

last_maintenance_run_id str

The OCID of the last maintenance run.

last_patch_history_entry_id str

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

license_model str

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

lifecycle_details str

Additional information about the current lifecycle state.

listener_port int

The port number configured for the listener on the DB system.

maintenance_window_details database.DbSystemMaintenanceWindowDetailsArgs

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

maintenance_windows Sequence[database.DbSystemMaintenanceWindowArgs]

The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

memory_size_in_gbs int

Memory allocated to the DB system, in gigabytes.

next_maintenance_run_id str

The OCID of the next maintenance run.

node_count int

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

nsg_ids Sequence[str]

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

os_version str

The most recent OS Patch Version applied on the DB system.

point_in_time_data_disk_clone_timestamp str

The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.

private_ip str

private_ip_v6 str

reco_storage_size_in_gb int

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

scan_dns_name str

The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

scan_dns_record_id str

The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.

scan_ip_ids Sequence[str]

scan_ipv6ids Sequence[str]

security_attributes Mapping[str, str]

shape str

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

source str

source_db_system_id str

The OCID of the DB system.

sparse_diskgroup bool

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

ssh_public_keys Sequence[str]

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

state str

The current state of the DB system.

storage_volume_performance_mode str

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnet_id str

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

time_created str

The date and time the DB system was created.

time_zone str

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

version str

The Oracle Database version of the DB system.

vip_ids Sequence[str]

vipv6ids Sequence[str]

zone_id str

The OCID of the zone the DB system is associated with.

availabilityDomain String

The availability domain where the DB system is located.

backupNetworkNsgIds List<String>

backupSubnetId String

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

clusterName String

compartmentId String

(Updatable) The OCID of the compartment the DB system belongs in.

cpuCoreCount Number

(Updatable) The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

dataCollectionOptions Property Map

(Updatable) Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

dataStoragePercentage Number

dataStorageSizeInGb Number

databaseEdition String

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

dbHome Property Map

(Updatable) Details for creating a Database Home if you are creating a database by restoring from a database backup.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

dbSystemOptions Property Map

The DB system options.

definedTags Map<String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

diskRedundancy String

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

displayName String

The user-friendly name for the DB system. The name does not have to be unique.

domain String

faultDomains List<String>

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

freeformTags Map<String>

hostname String

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

iormConfigCaches List<Property Map>

The IORM settings of the Exadata DB system.

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId String

lastMaintenanceRunId String

The OCID of the last maintenance run.

lastPatchHistoryEntryId String

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

licenseModel String

(Updatable) The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

lifecycleDetails String

Additional information about the current lifecycle state.

listenerPort Number

The port number configured for the listener on the DB system.

maintenanceWindowDetails Property Map

(Updatable) The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

maintenanceWindows List<Property Map>

The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

memorySizeInGbs Number

Memory allocated to the DB system, in gigabytes.

nextMaintenanceRunId String

The OCID of the next maintenance run.

nodeCount Number

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

nsgIds List<String>

A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

osVersion String

The most recent OS Patch Version applied on the DB system.

pointInTimeDataDiskCloneTimestamp String

The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.

privateIp String

privateIpV6 String

recoStorageSizeInGb Number

The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.

scanDnsName String

The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

scanDnsRecordId String

The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.

scanIpIds List<String>

scanIpv6ids List<String>

securityAttributes Map<String>

shape String

(Updatable) The shape of the DB system. The shape determines resources allocated to the DB system.

For virtual machine shapes, the number of CPU cores and memory
For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the ListDbSystemShapes operation.

source String

sourceDbSystemId String

The OCID of the DB system.

sparseDiskgroup Boolean

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured. Only applied for Exadata shape.

sshPublicKeys List<String>

(Updatable) The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

state String

The current state of the DB system.

storageVolumePerformanceMode String

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnetId String

The OCID of the subnet the DB system is associated with.

Subnet Restrictions:

For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

timeCreated String

The date and time the DB system was created.

timeZone String

The time zone to use for the DB system. For details, see DB System Time Zones.

** 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

version String

The Oracle Database version of the DB system.

vipIds List<String>

vipv6ids List<String>

zoneId String

The OCID of the zone the DB system is associated with.

Supporting Types

DbSystemDataCollectionOptions, DbSystemDataCollectionOptionsArgs

IsDiagnosticsEventsEnabled bool: (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
IsHealthMonitoringEnabled bool: (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
IsIncidentLogsEnabled bool: (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

IsDiagnosticsEventsEnabled bool: (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
IsHealthMonitoringEnabled bool: (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
IsIncidentLogsEnabled bool: (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

isDiagnosticsEventsEnabled Boolean: (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
isHealthMonitoringEnabled Boolean: (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
isIncidentLogsEnabled Boolean: (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

isDiagnosticsEventsEnabled boolean: (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
isHealthMonitoringEnabled boolean: (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
isIncidentLogsEnabled boolean: (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

is_diagnostics_events_enabled bool: (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
is_health_monitoring_enabled bool: (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
is_incident_logs_enabled bool: (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

isDiagnosticsEventsEnabled Boolean: (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
isHealthMonitoringEnabled Boolean: (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
isIncidentLogsEnabled Boolean: (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

DbSystemDbHome, DbSystemDbHomeArgs

Database DbSystemDbHomeDatabase

(Updatable) Details for creating a database by restoring from a source database system.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

CreateAsync bool

DatabaseSoftwareImageId string

The database software image OCID of the image to be used to restore a database.

DbHomeLocation string

DbVersion string

A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

DefinedTags Dictionary<string, string>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DisplayName string

The user-provided name of the Database Home.

FreeformTags Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the DB system.

IsUnifiedAuditingEnabled bool

Indicates whether unified auditing is enabled or not

LastPatchHistoryEntryId string

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

LifecycleDetails string

Additional information about the current lifecycle state.

State string

The current state of the DB system.

TimeCreated string

The date and time the DB system was created.

Database DbSystemDbHomeDatabase

(Updatable) Details for creating a database by restoring from a source database system.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

CreateAsync bool

DatabaseSoftwareImageId string

The database software image OCID of the image to be used to restore a database.

DbHomeLocation string

DbVersion string

A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

DefinedTags map[string]string

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DisplayName string

The user-provided name of the Database Home.

FreeformTags map[string]string

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the DB system.

IsUnifiedAuditingEnabled bool

Indicates whether unified auditing is enabled or not

LastPatchHistoryEntryId string

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

LifecycleDetails string

Additional information about the current lifecycle state.

State string

The current state of the DB system.

TimeCreated string

The date and time the DB system was created.

database DbSystemDbHome

(Updatable) Details for creating a database by restoring from a source database system.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

createAsync Boolean

databaseSoftwareImageId String

The database software image OCID of the image to be used to restore a database.

dbHomeLocation String

dbVersion String

A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

definedTags Map<String,String>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

displayName String

The user-provided name of the Database Home.

freeformTags Map<String,String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the DB system.

isUnifiedAuditingEnabled Boolean

Indicates whether unified auditing is enabled or not

lastPatchHistoryEntryId String

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

lifecycleDetails String

Additional information about the current lifecycle state.

state String

The current state of the DB system.

timeCreated String

The date and time the DB system was created.

database DbSystemDbHomeDatabase

(Updatable) Details for creating a database by restoring from a source database system.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

createAsync boolean

databaseSoftwareImageId string

The database software image OCID of the image to be used to restore a database.

dbHomeLocation string

dbVersion string

A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

definedTags {[key: string]: string}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

displayName string

The user-provided name of the Database Home.

freeformTags {[key: string]: string}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id string

The OCID of the DB system.

isUnifiedAuditingEnabled boolean

Indicates whether unified auditing is enabled or not

lastPatchHistoryEntryId string

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

lifecycleDetails string

Additional information about the current lifecycle state.

state string

The current state of the DB system.

timeCreated string

The date and time the DB system was created.

database database.DbSystemDbHomeDatabase

(Updatable) Details for creating a database by restoring from a source database system.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

create_async bool

database_software_image_id str

The database software image OCID of the image to be used to restore a database.

db_home_location str

db_version str

A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

defined_tags Mapping[str, str]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

display_name str

The user-provided name of the Database Home.

freeform_tags Mapping[str, str]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id str

The OCID of the DB system.

is_unified_auditing_enabled bool

Indicates whether unified auditing is enabled or not

last_patch_history_entry_id str

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

lifecycle_details str

Additional information about the current lifecycle state.

state str

The current state of the DB system.

time_created str

The date and time the DB system was created.

database Property Map

(Updatable) Details for creating a database by restoring from a source database system.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

createAsync Boolean

databaseSoftwareImageId String

The database software image OCID of the image to be used to restore a database.

dbHomeLocation String

dbVersion String

A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

definedTags Map<String>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

displayName String

The user-provided name of the Database Home.

freeformTags Map<String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the DB system.

isUnifiedAuditingEnabled Boolean

Indicates whether unified auditing is enabled or not

lastPatchHistoryEntryId String

The OCID of the last patch history. This value is updated as soon as a patch operation starts.

lifecycleDetails String

Additional information about the current lifecycle state.

state String

The current state of the DB system.

timeCreated String

The date and time the DB system was created.

DbSystemDbHomeDatabase, DbSystemDbHomeDatabaseArgs

AdminPassword string

A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

BackupId string

The backup OCID.

BackupTdePassword string

The password to open the TDE wallet.

CharacterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

ConnectionStrings List<DbSystemDbHomeDatabaseConnectionString>

DatabaseId string

The database OCID.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfig DbSystemDbHomeDatabaseDbBackupConfig

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

DbDomain string

The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.

DbName string

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

DbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database.

DbWorkload string

Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.

The database workload type.

DefinedTags Dictionary<string, string>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags Dictionary<string, string>

Id string

The OCID of the DB system.

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyVersionId string

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

PdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

PluggableDatabases List<string>

The list of pluggable databases that needs to be restored into new database.

State string

The current state of the DB system.

TdeWalletPassword string

The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

TimeCreated string

The date and time the DB system was created.

TimeStampForPointInTimeRecovery string

The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

AdminPassword string

BackupId string

The backup OCID.

BackupTdePassword string

The password to open the TDE wallet.

CharacterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

ConnectionStrings []DbSystemDbHomeDatabaseConnectionString

DatabaseId string

The database OCID.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfig DbSystemDbHomeDatabaseDbBackupConfig

DbDomain string

The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.

DbName string

DbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database.

DbWorkload string

The database workload type.

DefinedTags map[string]string

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags map[string]string

Id string

The OCID of the DB system.

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyVersionId string

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

PdbName string

PluggableDatabases []string

The list of pluggable databases that needs to be restored into new database.

State string

The current state of the DB system.

TdeWalletPassword string

TimeCreated string

The date and time the DB system was created.

TimeStampForPointInTimeRecovery string

The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

adminPassword String

backupId String

The backup OCID.

backupTdePassword String

The password to open the TDE wallet.

characterSet String

The character set for the database. The default is AL32UTF8. Allowed values are:

connectionStrings List<DbSystemDbHomeConnectionString>

databaseId String

The database OCID.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfig DbSystemDbHomeDbBackupConfig

dbDomain String

The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.

dbName String

dbUniqueName String

The DB_UNIQUE_NAME of the Oracle Database.

dbWorkload String

The database workload type.

definedTags Map<String,String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<String,String>

id String

The OCID of the DB system.

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId String

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName String

pluggableDatabases List<String>

The list of pluggable databases that needs to be restored into new database.

state String

The current state of the DB system.

tdeWalletPassword String

timeCreated String

The date and time the DB system was created.

timeStampForPointInTimeRecovery String

The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

adminPassword string

backupId string

The backup OCID.

backupTdePassword string

The password to open the TDE wallet.

characterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

connectionStrings DbSystemDbHomeDatabaseConnectionString[]

databaseId string

The database OCID.

databaseSoftwareImageId string

The database software image OCID

dbBackupConfig DbSystemDbHomeDatabaseDbBackupConfig

dbDomain string

The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.

dbName string

dbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database.

dbWorkload string

The database workload type.

definedTags {[key: string]: string}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags {[key: string]: string}

id string

The OCID of the DB system.

kmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId string

lifecycleDetails string

Additional information about the current lifecycle state.

ncharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName string

pluggableDatabases string[]

The list of pluggable databases that needs to be restored into new database.

state string

The current state of the DB system.

tdeWalletPassword string

timeCreated string

The date and time the DB system was created.

timeStampForPointInTimeRecovery string

The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

vaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

admin_password str

backup_id str

The backup OCID.

backup_tde_password str

The password to open the TDE wallet.

character_set str

The character set for the database. The default is AL32UTF8. Allowed values are:

connection_strings Sequence[database.DbSystemDbHomeDatabaseConnectionString]

database_id str

The database OCID.

database_software_image_id str

The database software image OCID

db_backup_config database.DbSystemDbHomeDatabaseDbBackupConfig

db_domain str

The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.

db_name str

db_unique_name str

The DB_UNIQUE_NAME of the Oracle Database.

db_workload str

The database workload type.

defined_tags Mapping[str, str]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeform_tags Mapping[str, str]

id str

The OCID of the DB system.

kms_key_id str

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kms_key_version_id str

lifecycle_details str

Additional information about the current lifecycle state.

ncharacter_set str

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdb_name str

pluggable_databases Sequence[str]

The list of pluggable databases that needs to be restored into new database.

state str

The current state of the DB system.

tde_wallet_password str

time_created str

The date and time the DB system was created.

time_stamp_for_point_in_time_recovery str

The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

vault_id str

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

adminPassword String

backupId String

The backup OCID.

backupTdePassword String

The password to open the TDE wallet.

characterSet String

The character set for the database. The default is AL32UTF8. Allowed values are:

connectionStrings List<Property Map>

databaseId String

The database OCID.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfig Property Map

dbDomain String

The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure.

dbName String

dbUniqueName String

The DB_UNIQUE_NAME of the Oracle Database.

dbWorkload String

The database workload type.

definedTags Map<String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<String>

id String

The OCID of the DB system.

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId String

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName String

pluggableDatabases List<String>

The list of pluggable databases that needs to be restored into new database.

state String

The current state of the DB system.

tdeWalletPassword String

timeCreated String

The date and time the DB system was created.

timeStampForPointInTimeRecovery String

The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

DbSystemDbHomeDatabaseConnectionString, DbSystemDbHomeDatabaseConnectionStringArgs

AllConnectionStrings Dictionary<string, string>
CdbDefault string
CdbIpDefault string

AllConnectionStrings map[string]string
CdbDefault string
CdbIpDefault string

allConnectionStrings Map<String,String>
cdbDefault String
cdbIpDefault String

allConnectionStrings {[key: string]: string}
cdbDefault string
cdbIpDefault string

all_connection_strings Mapping[str, str]
cdb_default str
cdb_ip_default str

allConnectionStrings Map<String>
cdbDefault String
cdbIpDefault String

DbSystemDbHomeDatabaseDbBackupConfig, DbSystemDbHomeDatabaseDbBackupConfigArgs

AutoBackupEnabled bool: (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
AutoBackupWindow string: (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
BackupDestinationDetails List<DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail>: (Updatable) Backup destination details.
RecoveryWindowInDays int: (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
RunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

AutoBackupEnabled bool: (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
AutoBackupWindow string: (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
BackupDestinationDetails []DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail: (Updatable) Backup destination details.
RecoveryWindowInDays int: (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
RunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled Boolean: (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
autoBackupWindow String: (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails List<DbSystemDbHomeDbBackupConfigBackupDestinationDetail>: (Updatable) Backup destination details.
recoveryWindowInDays Integer: (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
runImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled boolean: (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
autoBackupWindow string: (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail[]: (Updatable) Backup destination details.
recoveryWindowInDays number: (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
runImmediateFullBackup boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

auto_backup_enabled bool: (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
auto_backup_window str: (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
auto_full_backup_day str: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
auto_full_backup_window str: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backup_deletion_policy str: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backup_destination_details Sequence[database.DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail]: (Updatable) Backup destination details.
recovery_window_in_days int: (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
run_immediate_full_backup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled Boolean: (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
autoBackupWindow String: (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails List<Property Map>: (Updatable) Backup destination details.
recoveryWindowInDays Number: (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
runImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail, DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the backup destination.
Type string: Type of the database backup destination.

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the backup destination.
Type string: Type of the database backup destination.

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the backup destination.
type String: Type of the database backup destination.

dbrsPolicyId string: The OCID of the DBRS policy used for backup.
id string: The OCID of the backup destination.
type string: Type of the database backup destination.

dbrs_policy_id str: The OCID of the DBRS policy used for backup.
id str: The OCID of the backup destination.
type str: Type of the database backup destination.

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the backup destination.
type String: Type of the database backup destination.

DbSystemDbSystemOptions, DbSystemDbSystemOptionsArgs

StorageManagement string: The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management

StorageManagement string: The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management

storageManagement String: The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management

storageManagement string: The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management

storage_management str: The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management

storageManagement String: The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management

DbSystemIormConfigCach, DbSystemIormConfigCachArgs

DbPlans List<DbSystemIormConfigCachDbPlan>: An array of IORM settings for all the database in the Exadata DB system.
DbSystemId string
LifecycleDetails string: Additional information about the current lifecycle state.
Objective string: The current value for the IORM objective. The default is AUTO.
State string: The current state of the DB system.

DbPlans []DbSystemIormConfigCachDbPlan: An array of IORM settings for all the database in the Exadata DB system.
DbSystemId string
LifecycleDetails string: Additional information about the current lifecycle state.
Objective string: The current value for the IORM objective. The default is AUTO.
State string: The current state of the DB system.

dbPlans List<DbSystemIormConfigCachDbPlan>: An array of IORM settings for all the database in the Exadata DB system.
dbSystemId String
lifecycleDetails String: Additional information about the current lifecycle state.
objective String: The current value for the IORM objective. The default is AUTO.
state String: The current state of the DB system.

dbPlans DbSystemIormConfigCachDbPlan[]: An array of IORM settings for all the database in the Exadata DB system.
dbSystemId string
lifecycleDetails string: Additional information about the current lifecycle state.
objective string: The current value for the IORM objective. The default is AUTO.
state string: The current state of the DB system.

db_plans Sequence[database.DbSystemIormConfigCachDbPlan]: An array of IORM settings for all the database in the Exadata DB system.
db_system_id str
lifecycle_details str: Additional information about the current lifecycle state.
objective str: The current value for the IORM objective. The default is AUTO.
state str: The current state of the DB system.

dbPlans List<Property Map>: An array of IORM settings for all the database in the Exadata DB system.
dbSystemId String
lifecycleDetails String: Additional information about the current lifecycle state.
objective String: The current value for the IORM objective. The default is AUTO.
state String: The current state of the DB system.

DbSystemIormConfigCachDbPlan, DbSystemIormConfigCachDbPlanArgs

DbName string: The database name. For the default DbPlan, the dbName is default.
FlashCacheLimit string: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
Share int: The relative priority of this database.

DbName string: The database name. For the default DbPlan, the dbName is default.
FlashCacheLimit string: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
Share int: The relative priority of this database.

dbName String: The database name. For the default DbPlan, the dbName is default.
flashCacheLimit String: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share Integer: The relative priority of this database.

dbName string: The database name. For the default DbPlan, the dbName is default.
flashCacheLimit string: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share number: The relative priority of this database.

db_name str: The database name. For the default DbPlan, the dbName is default.
flash_cache_limit str: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share int: The relative priority of this database.

dbName String: The database name. For the default DbPlan, the dbName is default.
flashCacheLimit String: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share Number: The relative priority of this database.

DbSystemMaintenanceWindow, DbSystemMaintenanceWindowArgs

CustomActionTimeoutInMins int

Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).

DaysOfWeeks List<DbSystemMaintenanceWindowDaysOfWeek>

Days during the week when maintenance should be performed.

HoursOfDays List<int>

The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

IsCustomActionTimeoutEnabled bool

If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

IsMonthlyPatchingEnabled bool

If true, enables the monthly patching option.

LeadTimeInWeeks int

Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

Months List<DbSystemMaintenanceWindowMonth>

Months during the year when maintenance should be performed.

PatchingMode string

Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

Preference string

The maintenance window scheduling preference.

SkipRus List<bool>

WeeksOfMonths List<int>

Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.

CustomActionTimeoutInMins int

Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).

DaysOfWeeks []DbSystemMaintenanceWindowDaysOfWeek

Days during the week when maintenance should be performed.

HoursOfDays []int

The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

IsCustomActionTimeoutEnabled bool

If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

IsMonthlyPatchingEnabled bool

If true, enables the monthly patching option.

LeadTimeInWeeks int

Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

Months []DbSystemMaintenanceWindowMonth

Months during the year when maintenance should be performed.

PatchingMode string

Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

Preference string

The maintenance window scheduling preference.

SkipRus []bool

WeeksOfMonths []int

customActionTimeoutInMins Integer

Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).

daysOfWeeks List<DbSystemMaintenanceWindowDaysOfWeek>

Days during the week when maintenance should be performed.

hoursOfDays List<Integer>

The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

isCustomActionTimeoutEnabled Boolean

If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

isMonthlyPatchingEnabled Boolean

If true, enables the monthly patching option.

leadTimeInWeeks Integer

Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

months List<DbSystemMaintenanceWindowMonth>

Months during the year when maintenance should be performed.

patchingMode String

Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

preference String

The maintenance window scheduling preference.

skipRus List<Boolean>

weeksOfMonths List<Integer>

customActionTimeoutInMins number

Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).

daysOfWeeks DbSystemMaintenanceWindowDaysOfWeek[]

Days during the week when maintenance should be performed.

hoursOfDays number[]

The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

isCustomActionTimeoutEnabled boolean

If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

isMonthlyPatchingEnabled boolean

If true, enables the monthly patching option.

leadTimeInWeeks number

Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

months DbSystemMaintenanceWindowMonth[]

Months during the year when maintenance should be performed.

patchingMode string

Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

preference string

The maintenance window scheduling preference.

skipRus boolean[]

weeksOfMonths number[]

custom_action_timeout_in_mins int

Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).

days_of_weeks Sequence[database.DbSystemMaintenanceWindowDaysOfWeek]

Days during the week when maintenance should be performed.

hours_of_days Sequence[int]

The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

is_custom_action_timeout_enabled bool

If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

is_monthly_patching_enabled bool

If true, enables the monthly patching option.

lead_time_in_weeks int

Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

months Sequence[database.DbSystemMaintenanceWindowMonth]

Months during the year when maintenance should be performed.

patching_mode str

Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

preference str

The maintenance window scheduling preference.

skip_rus Sequence[bool]

weeks_of_months Sequence[int]

customActionTimeoutInMins Number

Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).

daysOfWeeks List<Property Map>

Days during the week when maintenance should be performed.

hoursOfDays List<Number>

The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

isCustomActionTimeoutEnabled Boolean

If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

isMonthlyPatchingEnabled Boolean

If true, enables the monthly patching option.

leadTimeInWeeks Number

Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

months List<Property Map>

Months during the year when maintenance should be performed.

patchingMode String

Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

preference String

The maintenance window scheduling preference.

skipRus List<Boolean>

weeksOfMonths List<Number>

DbSystemMaintenanceWindowDaysOfWeek, DbSystemMaintenanceWindowDaysOfWeekArgs

Name string: Name of the month of the year.

Name string: Name of the month of the year.

name String: Name of the month of the year.

name string: Name of the month of the year.

name str: Name of the month of the year.

name String: Name of the month of the year.

DbSystemMaintenanceWindowDetails, DbSystemMaintenanceWindowDetailsArgs

CustomActionTimeoutInMins int

(Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).

DaysOfWeeks List<DbSystemMaintenanceWindowDetailsDaysOfWeek>

(Updatable) Days during the week when maintenance should be performed.

HoursOfDays List<int>

(Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

IsCustomActionTimeoutEnabled bool

(Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

IsMonthlyPatchingEnabled bool

(Updatable) If true, enables the monthly patching option.

LeadTimeInWeeks int

(Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

Months List<DbSystemMaintenanceWindowDetailsMonth>

(Updatable) Months during the year when maintenance should be performed.

PatchingMode string

(Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

Preference string

(Updatable) The maintenance window scheduling preference.

SkipRus List<bool>

WeeksOfMonths List<int>

(Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.

CustomActionTimeoutInMins int

DaysOfWeeks []DbSystemMaintenanceWindowDetailsDaysOfWeek

(Updatable) Days during the week when maintenance should be performed.

HoursOfDays []int

(Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

IsCustomActionTimeoutEnabled bool

(Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

IsMonthlyPatchingEnabled bool

(Updatable) If true, enables the monthly patching option.

LeadTimeInWeeks int

(Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

Months []DbSystemMaintenanceWindowDetailsMonth

(Updatable) Months during the year when maintenance should be performed.

PatchingMode string

(Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

Preference string

(Updatable) The maintenance window scheduling preference.

SkipRus []bool

WeeksOfMonths []int

customActionTimeoutInMins Integer

daysOfWeeks List<DbSystemMaintenanceWindowDetailsDaysOfWeek>

(Updatable) Days during the week when maintenance should be performed.

hoursOfDays List<Integer>

(Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

isCustomActionTimeoutEnabled Boolean

(Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

isMonthlyPatchingEnabled Boolean

(Updatable) If true, enables the monthly patching option.

leadTimeInWeeks Integer

(Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

months List<DbSystemMaintenanceWindowDetailsMonth>

(Updatable) Months during the year when maintenance should be performed.

patchingMode String

(Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

preference String

(Updatable) The maintenance window scheduling preference.

skipRus List<Boolean>

weeksOfMonths List<Integer>

customActionTimeoutInMins number

daysOfWeeks DbSystemMaintenanceWindowDetailsDaysOfWeek[]

(Updatable) Days during the week when maintenance should be performed.

hoursOfDays number[]

(Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

isCustomActionTimeoutEnabled boolean

(Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

isMonthlyPatchingEnabled boolean

(Updatable) If true, enables the monthly patching option.

leadTimeInWeeks number

(Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

months DbSystemMaintenanceWindowDetailsMonth[]

(Updatable) Months during the year when maintenance should be performed.

patchingMode string

(Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

preference string

(Updatable) The maintenance window scheduling preference.

skipRus boolean[]

weeksOfMonths number[]

custom_action_timeout_in_mins int

days_of_weeks Sequence[database.DbSystemMaintenanceWindowDetailsDaysOfWeek]

(Updatable) Days during the week when maintenance should be performed.

hours_of_days Sequence[int]

(Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

is_custom_action_timeout_enabled bool

(Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

is_monthly_patching_enabled bool

(Updatable) If true, enables the monthly patching option.

lead_time_in_weeks int

(Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

months Sequence[database.DbSystemMaintenanceWindowDetailsMonth]

(Updatable) Months during the year when maintenance should be performed.

patching_mode str

(Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

preference str

(Updatable) The maintenance window scheduling preference.

skip_rus Sequence[bool]

weeks_of_months Sequence[int]

customActionTimeoutInMins Number

daysOfWeeks List<Property Map>

(Updatable) Days during the week when maintenance should be performed.

hoursOfDays List<Number>

(Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

isCustomActionTimeoutEnabled Boolean

(Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.

isMonthlyPatchingEnabled Boolean

(Updatable) If true, enables the monthly patching option.

leadTimeInWeeks Number

(Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

months List<Property Map>

(Updatable) Months during the year when maintenance should be performed.

patchingMode String

(Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.

IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.

preference String

(Updatable) The maintenance window scheduling preference.

skipRus List<Boolean>

weeksOfMonths List<Number>

DbSystemMaintenanceWindowDetailsDaysOfWeek, DbSystemMaintenanceWindowDetailsDaysOfWeekArgs

Name string: (Updatable) Name of the day of the week.

Name string: (Updatable) Name of the day of the week.

name String: (Updatable) Name of the day of the week.

name string: (Updatable) Name of the day of the week.

name str: (Updatable) Name of the day of the week.

name String: (Updatable) Name of the day of the week.

DbSystemMaintenanceWindowDetailsMonth, DbSystemMaintenanceWindowDetailsMonthArgs

Name string: (Updatable) Name of the month of the year.

Name string: (Updatable) Name of the month of the year.

name String: (Updatable) Name of the month of the year.

name string: (Updatable) Name of the month of the year.

name str: (Updatable) Name of the month of the year.

name String: (Updatable) Name of the month of the year.

DbSystemMaintenanceWindowMonth, DbSystemMaintenanceWindowMonthArgs

Name string: Name of the month of the year.

Name string: Name of the month of the year.

name String: Name of the month of the year.

name string: Name of the month of the year.

name str: Name of the month of the year.

name String: Name of the month of the year.

Import

DbSystems can be imported using the id, e.g.

$ pulumi import oci:Database/dbSystem:DbSystem test_db_system "id"

Import is only supported for source=NONE

db_home.0.database.0.admin_password is not returned by the service for security reasons. To avoid a force new of the db_home on the next apply, add the following to the resource:

lifecycle {

    ignore_changes = ["db_home.0.database.0.admin_password"]

}

You may also need to add hostname to the ignore_changes list if you see a diff on a subsequent apply

If the oci_database_db_system being imported is missing a primary db_home, an empty placeholder for db_home will be set in the Terraform state.

To keep configurations consistent with the imported state, add an empty placeholder for db_home to your configuration like this:

Add this placeholder into your oci_database_db_system configuration to indicate that the primary db home is empty.

db_home {

database {

  admin_password = ""

}

}

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.Database.DbSystem

On this page

On this page

Create DbSystem Resource

Constructor syntax

Parameters

Constructor example

DbSystem Resource Properties

Inputs

Outputs

Look up Existing DbSystem Resource

Supporting Types

DbSystemDataCollectionOptions, DbSystemDataCollectionOptionsArgs

DbSystemDbHome, DbSystemDbHomeArgs

DbSystemDbHomeDatabase, DbSystemDbHomeDatabaseArgs

DbSystemDbHomeDatabaseConnectionString, DbSystemDbHomeDatabaseConnectionStringArgs

DbSystemDbHomeDatabaseDbBackupConfig, DbSystemDbHomeDatabaseDbBackupConfigArgs

DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail, DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetailArgs

DbSystemDbSystemOptions, DbSystemDbSystemOptionsArgs

DbSystemIormConfigCach, DbSystemIormConfigCachArgs

DbSystemIormConfigCachDbPlan, DbSystemIormConfigCachDbPlanArgs

DbSystemMaintenanceWindow, DbSystemMaintenanceWindowArgs

DbSystemMaintenanceWindowDaysOfWeek, DbSystemMaintenanceWindowDaysOfWeekArgs

DbSystemMaintenanceWindowDetails, DbSystemMaintenanceWindowDetailsArgs

DbSystemMaintenanceWindowDetailsDaysOfWeek, DbSystemMaintenanceWindowDetailsDaysOfWeekArgs

DbSystemMaintenanceWindowDetailsMonth, DbSystemMaintenanceWindowDetailsMonthArgs

DbSystemMaintenanceWindowMonth, DbSystemMaintenanceWindowMonthArgs

Import

Add this placeholder into your oci_database_db_system configuration to indicate that the primary db home is empty.

Package Details

On this page

On this page