1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. DbSystemsUpgrade
Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi

oci.Database.DbSystemsUpgrade

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi

    This resource provides the Db Systems Upgrade resource in Oracle Cloud Infrastructure Database service.

    Upgrades the operating system and grid infrastructure of the DB system.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testDbSystemsUpgrade = new Oci.Database.DbSystemsUpgrade("testDbSystemsUpgrade", new()
        {
            Action = @var.Db_systems_upgrade_action,
            DbSystemId = oci_database_db_system.Test_db_system.Id,
            IsSnapshotRetentionDaysForceUpdated = @var.Db_systems_upgrade_is_snapshot_retention_days_force_updated,
            NewGiVersion = @var.Db_systems_upgrade_new_gi_version,
            SnapshotRetentionPeriodInDays = @var.Db_systems_upgrade_snapshot_retention_period_in_days,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Database"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Database.NewDbSystemsUpgrade(ctx, "testDbSystemsUpgrade", &Database.DbSystemsUpgradeArgs{
    			Action:                              pulumi.Any(_var.Db_systems_upgrade_action),
    			DbSystemId:                          pulumi.Any(oci_database_db_system.Test_db_system.Id),
    			IsSnapshotRetentionDaysForceUpdated: pulumi.Any(_var.Db_systems_upgrade_is_snapshot_retention_days_force_updated),
    			NewGiVersion:                        pulumi.Any(_var.Db_systems_upgrade_new_gi_version),
    			SnapshotRetentionPeriodInDays:       pulumi.Any(_var.Db_systems_upgrade_snapshot_retention_period_in_days),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Database.DbSystemsUpgrade;
    import com.pulumi.oci.Database.DbSystemsUpgradeArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testDbSystemsUpgrade = new DbSystemsUpgrade("testDbSystemsUpgrade", DbSystemsUpgradeArgs.builder()        
                .action(var_.db_systems_upgrade_action())
                .dbSystemId(oci_database_db_system.test_db_system().id())
                .isSnapshotRetentionDaysForceUpdated(var_.db_systems_upgrade_is_snapshot_retention_days_force_updated())
                .newGiVersion(var_.db_systems_upgrade_new_gi_version())
                .snapshotRetentionPeriodInDays(var_.db_systems_upgrade_snapshot_retention_period_in_days())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_db_systems_upgrade = oci.database.DbSystemsUpgrade("testDbSystemsUpgrade",
        action=var["db_systems_upgrade_action"],
        db_system_id=oci_database_db_system["test_db_system"]["id"],
        is_snapshot_retention_days_force_updated=var["db_systems_upgrade_is_snapshot_retention_days_force_updated"],
        new_gi_version=var["db_systems_upgrade_new_gi_version"],
        snapshot_retention_period_in_days=var["db_systems_upgrade_snapshot_retention_period_in_days"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDbSystemsUpgrade = new oci.database.DbSystemsUpgrade("testDbSystemsUpgrade", {
        action: _var.db_systems_upgrade_action,
        dbSystemId: oci_database_db_system.test_db_system.id,
        isSnapshotRetentionDaysForceUpdated: _var.db_systems_upgrade_is_snapshot_retention_days_force_updated,
        newGiVersion: _var.db_systems_upgrade_new_gi_version,
        snapshotRetentionPeriodInDays: _var.db_systems_upgrade_snapshot_retention_period_in_days,
    });
    
    resources:
      testDbSystemsUpgrade:
        type: oci:Database:DbSystemsUpgrade
        properties:
          #Required
          action: ${var.db_systems_upgrade_action}
          dbSystemId: ${oci_database_db_system.test_db_system.id}
          #Optional
          isSnapshotRetentionDaysForceUpdated: ${var.db_systems_upgrade_is_snapshot_retention_days_force_updated}
          newGiVersion: ${var.db_systems_upgrade_new_gi_version}
          snapshotRetentionPeriodInDays: ${var.db_systems_upgrade_snapshot_retention_period_in_days}
    

    Create DbSystemsUpgrade Resource

    new DbSystemsUpgrade(name: string, args: DbSystemsUpgradeArgs, opts?: CustomResourceOptions);
    @overload
    def DbSystemsUpgrade(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         action: Optional[str] = None,
                         db_system_id: Optional[str] = None,
                         is_snapshot_retention_days_force_updated: Optional[bool] = None,
                         new_gi_version: Optional[str] = None,
                         snapshot_retention_period_in_days: Optional[int] = None)
    @overload
    def DbSystemsUpgrade(resource_name: str,
                         args: DbSystemsUpgradeArgs,
                         opts: Optional[ResourceOptions] = None)
    func NewDbSystemsUpgrade(ctx *Context, name string, args DbSystemsUpgradeArgs, opts ...ResourceOption) (*DbSystemsUpgrade, error)
    public DbSystemsUpgrade(string name, DbSystemsUpgradeArgs args, CustomResourceOptions? opts = null)
    public DbSystemsUpgrade(String name, DbSystemsUpgradeArgs args)
    public DbSystemsUpgrade(String name, DbSystemsUpgradeArgs args, CustomResourceOptions options)
    
    type: oci:Database:DbSystemsUpgrade
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DbSystemsUpgradeArgs
    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 DbSystemsUpgradeArgs
    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 DbSystemsUpgradeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbSystemsUpgradeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbSystemsUpgradeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DbSystemsUpgrade Resource Properties

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

    Inputs

    The DbSystemsUpgrade resource accepts the following input properties:

    Action string

    The operating system upgrade action.

    DbSystemId string

    The DB system OCID.

    IsSnapshotRetentionDaysForceUpdated bool

    If true, rollback time is updated even if operating system upgrade history contains errors.

    NewGiVersion string

    A valid Oracle Grid Infrastructure (GI) software version.

    SnapshotRetentionPeriodInDays int

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    Action string

    The operating system upgrade action.

    DbSystemId string

    The DB system OCID.

    IsSnapshotRetentionDaysForceUpdated bool

    If true, rollback time is updated even if operating system upgrade history contains errors.

    NewGiVersion string

    A valid Oracle Grid Infrastructure (GI) software version.

    SnapshotRetentionPeriodInDays int

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    action String

    The operating system upgrade action.

    dbSystemId String

    The DB system OCID.

    isSnapshotRetentionDaysForceUpdated Boolean

    If true, rollback time is updated even if operating system upgrade history contains errors.

    newGiVersion String

    A valid Oracle Grid Infrastructure (GI) software version.

    snapshotRetentionPeriodInDays Integer

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    action string

    The operating system upgrade action.

    dbSystemId string

    The DB system OCID.

    isSnapshotRetentionDaysForceUpdated boolean

    If true, rollback time is updated even if operating system upgrade history contains errors.

    newGiVersion string

    A valid Oracle Grid Infrastructure (GI) software version.

    snapshotRetentionPeriodInDays number

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    action str

    The operating system upgrade action.

    db_system_id str

    The DB system OCID.

    is_snapshot_retention_days_force_updated bool

    If true, rollback time is updated even if operating system upgrade history contains errors.

    new_gi_version str

    A valid Oracle Grid Infrastructure (GI) software version.

    snapshot_retention_period_in_days int

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    action String

    The operating system upgrade action.

    dbSystemId String

    The DB system OCID.

    isSnapshotRetentionDaysForceUpdated Boolean

    If true, rollback time is updated even if operating system upgrade history contains errors.

    newGiVersion String

    A valid Oracle Grid Infrastructure (GI) software version.

    snapshotRetentionPeriodInDays Number

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

    ** 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 DbSystemsUpgrade resource produces the following output properties:

    AvailabilityDomain string

    The name of the availability domain that the DB system is located in.

    BackupNetworkNsgIds List<string>

    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.

    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.

    CompartmentId string

    The OCID of the compartment.

    CpuCoreCount int

    The number of CPU cores enabled on the DB system.

    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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    DataStorageSizeInGb int

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    DatabaseEdition string

    The Oracle Database edition that applies to all the databases on the DB system.

    DbSystemOptions List<DbSystemsUpgradeDbSystemOption>

    The DB system options.

    DefinedTags Dictionary<string, object>

    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. HIGH is 3-way redundancy.

    DisplayName string

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

    Domain string

    The domain name for the DB system.

    FaultDomains List<string>

    List of the Fault Domains in which this DB system is provisioned.

    FreeformTags Dictionary<string, object>

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

    Hostname string

    The hostname for the DB system.

    Id string

    The provider-assigned unique ID for this managed resource.

    IormConfigCaches List<DbSystemsUpgradeIormConfigCach>

    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.

    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

    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.

    MaintenanceWindows List<DbSystemsUpgradeMaintenanceWindow>

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

    NextMaintenanceRunId string

    The OCID of the next maintenance run.

    NodeCount int

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    NsgIds List<string>

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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) IP addresses associated with the DB system. SCAN IP 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.

    Shape string

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    SourceDbSystemId string

    The OCID of the DB system.

    SparseDiskgroup bool

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    SshPublicKeys List<string>

    The public key portion of one or more key pairs used for SSH access to the DB system.

    State string

    The current state of the DB system.

    SubnetId string

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

    TimeCreated string

    The date and time the DB system was created.

    TimeZone string

    The time zone of the DB system. For details, see DB System Time Zones.

    Version string

    The Oracle Database version of the DB system.

    VipIds List<string>

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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 name of the availability domain that the DB system is located in.

    BackupNetworkNsgIds []string

    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.

    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.

    CompartmentId string

    The OCID of the compartment.

    CpuCoreCount int

    The number of CPU cores enabled on the DB system.

    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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    DataStorageSizeInGb int

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    DatabaseEdition string

    The Oracle Database edition that applies to all the databases on the DB system.

    DbSystemOptions []DbSystemsUpgradeDbSystemOption

    The DB system options.

    DefinedTags map[string]interface{}

    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. HIGH is 3-way redundancy.

    DisplayName string

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

    Domain string

    The domain name for the DB system.

    FaultDomains []string

    List of the Fault Domains in which this DB system is provisioned.

    FreeformTags map[string]interface{}

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

    Hostname string

    The hostname for the DB system.

    Id string

    The provider-assigned unique ID for this managed resource.

    IormConfigCaches []DbSystemsUpgradeIormConfigCach

    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.

    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

    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.

    MaintenanceWindows []DbSystemsUpgradeMaintenanceWindow

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

    NextMaintenanceRunId string

    The OCID of the next maintenance run.

    NodeCount int

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    NsgIds []string

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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

    The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.

    Shape string

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    SourceDbSystemId string

    The OCID of the DB system.

    SparseDiskgroup bool

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    SshPublicKeys []string

    The public key portion of one or more key pairs used for SSH access to the DB system.

    State string

    The current state of the DB system.

    SubnetId string

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

    TimeCreated string

    The date and time the DB system was created.

    TimeZone string

    The time zone of the DB system. For details, see DB System Time Zones.

    Version string

    The Oracle Database version of the DB system.

    VipIds []string

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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 name of the availability domain that the DB system is located in.

    backupNetworkNsgIds List<String>

    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.

    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.

    compartmentId String

    The OCID of the compartment.

    cpuCoreCount Integer

    The number of CPU cores enabled on the DB system.

    dataStoragePercentage Integer

    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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    dataStorageSizeInGb Integer

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    databaseEdition String

    The Oracle Database edition that applies to all the databases on the DB system.

    dbSystemOptions List<DbSystemsUpgradeDbSystemOption>

    The DB system options.

    definedTags Map<String,Object>

    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. HIGH is 3-way redundancy.

    displayName String

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

    domain String

    The domain name for the DB system.

    faultDomains List<String>

    List of the Fault Domains in which this DB system is provisioned.

    freeformTags Map<String,Object>

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

    hostname String

    The hostname for the DB system.

    id String

    The provider-assigned unique ID for this managed resource.

    iormConfigCaches List<DbSystemsUpgradeIormConfigCach>

    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.

    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

    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.

    maintenanceWindows List<DbSystemsUpgradeMaintenanceWindow>

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

    nextMaintenanceRunId String

    The OCID of the next maintenance run.

    nodeCount Integer

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    nsgIds List<String>

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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>

    The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.

    shape String

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    sourceDbSystemId String

    The OCID of the DB system.

    sparseDiskgroup Boolean

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    sshPublicKeys List<String>

    The public key portion of one or more key pairs used for SSH access to the DB system.

    state String

    The current state of the DB system.

    subnetId String

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

    timeCreated String

    The date and time the DB system was created.

    timeZone String

    The time zone of the DB system. For details, see DB System Time Zones.

    version String

    The Oracle Database version of the DB system.

    vipIds List<String>

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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 name of the availability domain that the DB system is located in.

    backupNetworkNsgIds string[]

    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.

    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.

    compartmentId string

    The OCID of the compartment.

    cpuCoreCount number

    The number of CPU cores enabled on the DB system.

    dataStoragePercentage number

    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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    dataStorageSizeInGb number

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    databaseEdition string

    The Oracle Database edition that applies to all the databases on the DB system.

    dbSystemOptions DbSystemsUpgradeDbSystemOption[]

    The DB system options.

    definedTags {[key: string]: any}

    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. HIGH is 3-way redundancy.

    displayName string

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

    domain string

    The domain name for the DB system.

    faultDomains string[]

    List of the Fault Domains in which this DB system is provisioned.

    freeformTags {[key: string]: any}

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

    hostname string

    The hostname for the DB system.

    id string

    The provider-assigned unique ID for this managed resource.

    iormConfigCaches DbSystemsUpgradeIormConfigCach[]

    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.

    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

    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.

    maintenanceWindows DbSystemsUpgradeMaintenanceWindow[]

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

    nextMaintenanceRunId string

    The OCID of the next maintenance run.

    nodeCount number

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    nsgIds string[]

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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[]

    The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.

    shape string

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    sourceDbSystemId string

    The OCID of the DB system.

    sparseDiskgroup boolean

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    sshPublicKeys string[]

    The public key portion of one or more key pairs used for SSH access to the DB system.

    state string

    The current state of the DB system.

    subnetId string

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

    timeCreated string

    The date and time the DB system was created.

    timeZone string

    The time zone of the DB system. For details, see DB System Time Zones.

    version string

    The Oracle Database version of the DB system.

    vipIds string[]

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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.

    availability_domain str

    The name of the availability domain that the DB system is located in.

    backup_network_nsg_ids Sequence[str]

    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.

    backup_subnet_id str

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

    cluster_name str

    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.

    compartment_id str

    The OCID of the compartment.

    cpu_core_count int

    The number of CPU cores enabled on the DB system.

    data_storage_percentage 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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    data_storage_size_in_gb int

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    database_edition str

    The Oracle Database edition that applies to all the databases on the DB system.

    db_system_options DbSystemsUpgradeDbSystemOption]

    The DB system options.

    defined_tags Mapping[str, Any]

    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. HIGH is 3-way redundancy.

    display_name str

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

    domain str

    The domain name for the DB system.

    fault_domains Sequence[str]

    List of the Fault Domains in which this DB system is provisioned.

    freeform_tags Mapping[str, Any]

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

    hostname str

    The hostname for the DB system.

    id str

    The provider-assigned unique ID for this managed resource.

    iorm_config_caches DbSystemsUpgradeIormConfigCach]

    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.

    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

    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_windows DbSystemsUpgradeMaintenanceWindow]

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

    next_maintenance_run_id str

    The OCID of the next maintenance run.

    node_count int

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    nsg_ids Sequence[str]

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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]

    The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.

    shape str

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    source_db_system_id str

    The OCID of the DB system.

    sparse_diskgroup bool

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    ssh_public_keys Sequence[str]

    The public key portion of one or more key pairs used for SSH access to the DB system.

    state str

    The current state of the DB system.

    subnet_id str

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

    time_created str

    The date and time the DB system was created.

    time_zone str

    The time zone of the DB system. For details, see DB System Time Zones.

    version str

    The Oracle Database version of the DB system.

    vip_ids Sequence[str]

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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.

    availabilityDomain String

    The name of the availability domain that the DB system is located in.

    backupNetworkNsgIds List<String>

    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.

    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.

    compartmentId String

    The OCID of the compartment.

    cpuCoreCount Number

    The number of CPU cores enabled on the DB system.

    dataStoragePercentage Number

    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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    dataStorageSizeInGb Number

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    databaseEdition String

    The Oracle Database edition that applies to all the databases on the DB system.

    dbSystemOptions List<Property Map>

    The DB system options.

    definedTags Map<Any>

    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. HIGH is 3-way redundancy.

    displayName String

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

    domain String

    The domain name for the DB system.

    faultDomains List<String>

    List of the Fault Domains in which this DB system is provisioned.

    freeformTags Map<Any>

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

    hostname String

    The hostname for the DB system.

    id String

    The provider-assigned unique ID for this managed resource.

    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.

    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

    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.

    maintenanceWindows List<Property Map>

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

    nextMaintenanceRunId String

    The OCID of the next maintenance run.

    nodeCount Number

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    nsgIds List<String>

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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>

    The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.

    shape String

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    sourceDbSystemId String

    The OCID of the DB system.

    sparseDiskgroup Boolean

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    sshPublicKeys List<String>

    The public key portion of one or more key pairs used for SSH access to the DB system.

    state String

    The current state of the DB system.

    subnetId String

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

    timeCreated String

    The date and time the DB system was created.

    timeZone String

    The time zone of the DB system. For details, see DB System Time Zones.

    version String

    The Oracle Database version of the DB system.

    vipIds List<String>

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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 DbSystemsUpgrade Resource

    Get an existing DbSystemsUpgrade 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?: DbSystemsUpgradeState, opts?: CustomResourceOptions): DbSystemsUpgrade
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action: Optional[str] = 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_storage_percentage: Optional[int] = None,
            data_storage_size_in_gb: Optional[int] = None,
            database_edition: Optional[str] = None,
            db_system_id: Optional[str] = None,
            db_system_options: Optional[Sequence[_database.DbSystemsUpgradeDbSystemOptionArgs]] = None,
            defined_tags: Optional[Mapping[str, Any]] = 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, Any]] = None,
            hostname: Optional[str] = None,
            iorm_config_caches: Optional[Sequence[_database.DbSystemsUpgradeIormConfigCachArgs]] = None,
            is_snapshot_retention_days_force_updated: Optional[bool] = None,
            kms_key_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_windows: Optional[Sequence[_database.DbSystemsUpgradeMaintenanceWindowArgs]] = None,
            new_gi_version: Optional[str] = None,
            next_maintenance_run_id: Optional[str] = None,
            node_count: Optional[int] = None,
            nsg_ids: Optional[Sequence[str]] = None,
            point_in_time_data_disk_clone_timestamp: 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,
            shape: Optional[str] = None,
            snapshot_retention_period_in_days: Optional[int] = None,
            source_db_system_id: Optional[str] = None,
            sparse_diskgroup: Optional[bool] = None,
            ssh_public_keys: Optional[Sequence[str]] = None,
            state: 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,
            zone_id: Optional[str] = None) -> DbSystemsUpgrade
    func GetDbSystemsUpgrade(ctx *Context, name string, id IDInput, state *DbSystemsUpgradeState, opts ...ResourceOption) (*DbSystemsUpgrade, error)
    public static DbSystemsUpgrade Get(string name, Input<string> id, DbSystemsUpgradeState? state, CustomResourceOptions? opts = null)
    public static DbSystemsUpgrade get(String name, Output<String> id, DbSystemsUpgradeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Action string

    The operating system upgrade action.

    AvailabilityDomain string

    The name of the availability domain that the DB system is located in.

    BackupNetworkNsgIds List<string>

    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.

    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.

    CompartmentId string

    The OCID of the compartment.

    CpuCoreCount int

    The number of CPU cores enabled on the DB system.

    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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    DataStorageSizeInGb int

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    DatabaseEdition string

    The Oracle Database edition that applies to all the databases on the DB system.

    DbSystemId string

    The DB system OCID.

    DbSystemOptions List<DbSystemsUpgradeDbSystemOption>

    The DB system options.

    DefinedTags Dictionary<string, object>

    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. HIGH is 3-way redundancy.

    DisplayName string

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

    Domain string

    The domain name for the DB system.

    FaultDomains List<string>

    List of the Fault Domains in which this DB system is provisioned.

    FreeformTags Dictionary<string, object>

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

    Hostname string

    The hostname for the DB system.

    IormConfigCaches List<DbSystemsUpgradeIormConfigCach>

    The IORM settings of the Exadata DB system.

    IsSnapshotRetentionDaysForceUpdated bool

    If true, rollback time is updated even if operating system upgrade history contains errors.

    KmsKeyId string

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

    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

    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.

    MaintenanceWindows List<DbSystemsUpgradeMaintenanceWindow>

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

    NewGiVersion string

    A valid Oracle Grid Infrastructure (GI) software version.

    NextMaintenanceRunId string

    The OCID of the next maintenance run.

    NodeCount int

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    NsgIds List<string>

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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) IP addresses associated with the DB system. SCAN IP 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.

    Shape string

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    SnapshotRetentionPeriodInDays int

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    SourceDbSystemId string

    The OCID of the DB system.

    SparseDiskgroup bool

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    SshPublicKeys List<string>

    The public key portion of one or more key pairs used for SSH access to the DB system.

    State string

    The current state of the DB system.

    SubnetId string

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

    TimeCreated string

    The date and time the DB system was created.

    TimeZone string

    The time zone of the DB system. For details, see DB System Time Zones.

    Version string

    The Oracle Database version of the DB system.

    VipIds List<string>

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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.

    Action string

    The operating system upgrade action.

    AvailabilityDomain string

    The name of the availability domain that the DB system is located in.

    BackupNetworkNsgIds []string

    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.

    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.

    CompartmentId string

    The OCID of the compartment.

    CpuCoreCount int

    The number of CPU cores enabled on the DB system.

    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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    DataStorageSizeInGb int

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    DatabaseEdition string

    The Oracle Database edition that applies to all the databases on the DB system.

    DbSystemId string

    The DB system OCID.

    DbSystemOptions []DbSystemsUpgradeDbSystemOptionArgs

    The DB system options.

    DefinedTags map[string]interface{}

    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. HIGH is 3-way redundancy.

    DisplayName string

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

    Domain string

    The domain name for the DB system.

    FaultDomains []string

    List of the Fault Domains in which this DB system is provisioned.

    FreeformTags map[string]interface{}

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

    Hostname string

    The hostname for the DB system.

    IormConfigCaches []DbSystemsUpgradeIormConfigCachArgs

    The IORM settings of the Exadata DB system.

    IsSnapshotRetentionDaysForceUpdated bool

    If true, rollback time is updated even if operating system upgrade history contains errors.

    KmsKeyId string

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

    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

    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.

    MaintenanceWindows []DbSystemsUpgradeMaintenanceWindowArgs

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

    NewGiVersion string

    A valid Oracle Grid Infrastructure (GI) software version.

    NextMaintenanceRunId string

    The OCID of the next maintenance run.

    NodeCount int

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    NsgIds []string

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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

    The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.

    Shape string

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    SnapshotRetentionPeriodInDays int

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    SourceDbSystemId string

    The OCID of the DB system.

    SparseDiskgroup bool

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    SshPublicKeys []string

    The public key portion of one or more key pairs used for SSH access to the DB system.

    State string

    The current state of the DB system.

    SubnetId string

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

    TimeCreated string

    The date and time the DB system was created.

    TimeZone string

    The time zone of the DB system. For details, see DB System Time Zones.

    Version string

    The Oracle Database version of the DB system.

    VipIds []string

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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.

    action String

    The operating system upgrade action.

    availabilityDomain String

    The name of the availability domain that the DB system is located in.

    backupNetworkNsgIds List<String>

    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.

    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.

    compartmentId String

    The OCID of the compartment.

    cpuCoreCount Integer

    The number of CPU cores enabled on the DB system.

    dataStoragePercentage Integer

    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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    dataStorageSizeInGb Integer

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    databaseEdition String

    The Oracle Database edition that applies to all the databases on the DB system.

    dbSystemId String

    The DB system OCID.

    dbSystemOptions List<DbSystemsUpgradeDbSystemOption>

    The DB system options.

    definedTags Map<String,Object>

    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. HIGH is 3-way redundancy.

    displayName String

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

    domain String

    The domain name for the DB system.

    faultDomains List<String>

    List of the Fault Domains in which this DB system is provisioned.

    freeformTags Map<String,Object>

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

    hostname String

    The hostname for the DB system.

    iormConfigCaches List<DbSystemsUpgradeIormConfigCach>

    The IORM settings of the Exadata DB system.

    isSnapshotRetentionDaysForceUpdated Boolean

    If true, rollback time is updated even if operating system upgrade history contains errors.

    kmsKeyId String

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

    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

    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.

    maintenanceWindows List<DbSystemsUpgradeMaintenanceWindow>

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

    newGiVersion String

    A valid Oracle Grid Infrastructure (GI) software version.

    nextMaintenanceRunId String

    The OCID of the next maintenance run.

    nodeCount Integer

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    nsgIds List<String>

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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>

    The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.

    shape String

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    snapshotRetentionPeriodInDays Integer

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    sourceDbSystemId String

    The OCID of the DB system.

    sparseDiskgroup Boolean

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    sshPublicKeys List<String>

    The public key portion of one or more key pairs used for SSH access to the DB system.

    state String

    The current state of the DB system.

    subnetId String

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

    timeCreated String

    The date and time the DB system was created.

    timeZone String

    The time zone of the DB system. For details, see DB System Time Zones.

    version String

    The Oracle Database version of the DB system.

    vipIds List<String>

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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.

    action string

    The operating system upgrade action.

    availabilityDomain string

    The name of the availability domain that the DB system is located in.

    backupNetworkNsgIds string[]

    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.

    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.

    compartmentId string

    The OCID of the compartment.

    cpuCoreCount number

    The number of CPU cores enabled on the DB system.

    dataStoragePercentage number

    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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    dataStorageSizeInGb number

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    databaseEdition string

    The Oracle Database edition that applies to all the databases on the DB system.

    dbSystemId string

    The DB system OCID.

    dbSystemOptions DbSystemsUpgradeDbSystemOption[]

    The DB system options.

    definedTags {[key: string]: any}

    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. HIGH is 3-way redundancy.

    displayName string

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

    domain string

    The domain name for the DB system.

    faultDomains string[]

    List of the Fault Domains in which this DB system is provisioned.

    freeformTags {[key: string]: any}

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

    hostname string

    The hostname for the DB system.

    iormConfigCaches DbSystemsUpgradeIormConfigCach[]

    The IORM settings of the Exadata DB system.

    isSnapshotRetentionDaysForceUpdated boolean

    If true, rollback time is updated even if operating system upgrade history contains errors.

    kmsKeyId string

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

    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

    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.

    maintenanceWindows DbSystemsUpgradeMaintenanceWindow[]

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

    newGiVersion string

    A valid Oracle Grid Infrastructure (GI) software version.

    nextMaintenanceRunId string

    The OCID of the next maintenance run.

    nodeCount number

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    nsgIds string[]

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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[]

    The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.

    shape string

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    snapshotRetentionPeriodInDays number

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    sourceDbSystemId string

    The OCID of the DB system.

    sparseDiskgroup boolean

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    sshPublicKeys string[]

    The public key portion of one or more key pairs used for SSH access to the DB system.

    state string

    The current state of the DB system.

    subnetId string

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

    timeCreated string

    The date and time the DB system was created.

    timeZone string

    The time zone of the DB system. For details, see DB System Time Zones.

    version string

    The Oracle Database version of the DB system.

    vipIds string[]

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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.

    action str

    The operating system upgrade action.

    availability_domain str

    The name of the availability domain that the DB system is located in.

    backup_network_nsg_ids Sequence[str]

    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.

    backup_subnet_id str

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

    cluster_name str

    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.

    compartment_id str

    The OCID of the compartment.

    cpu_core_count int

    The number of CPU cores enabled on the DB system.

    data_storage_percentage 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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    data_storage_size_in_gb int

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    database_edition str

    The Oracle Database edition that applies to all the databases on the DB system.

    db_system_id str

    The DB system OCID.

    db_system_options DbSystemsUpgradeDbSystemOptionArgs]

    The DB system options.

    defined_tags Mapping[str, Any]

    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. HIGH is 3-way redundancy.

    display_name str

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

    domain str

    The domain name for the DB system.

    fault_domains Sequence[str]

    List of the Fault Domains in which this DB system is provisioned.

    freeform_tags Mapping[str, Any]

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

    hostname str

    The hostname for the DB system.

    iorm_config_caches DbSystemsUpgradeIormConfigCachArgs]

    The IORM settings of the Exadata DB system.

    is_snapshot_retention_days_force_updated bool

    If true, rollback time is updated even if operating system upgrade history contains errors.

    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.

    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

    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_windows DbSystemsUpgradeMaintenanceWindowArgs]

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

    new_gi_version str

    A valid Oracle Grid Infrastructure (GI) software version.

    next_maintenance_run_id str

    The OCID of the next maintenance run.

    node_count int

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    nsg_ids Sequence[str]

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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]

    The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.

    shape str

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    snapshot_retention_period_in_days int

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    source_db_system_id str

    The OCID of the DB system.

    sparse_diskgroup bool

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    ssh_public_keys Sequence[str]

    The public key portion of one or more key pairs used for SSH access to the DB system.

    state str

    The current state of the DB system.

    subnet_id str

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

    time_created str

    The date and time the DB system was created.

    time_zone str

    The time zone of the DB system. For details, see DB System Time Zones.

    version str

    The Oracle Database version of the DB system.

    vip_ids Sequence[str]

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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.

    action String

    The operating system upgrade action.

    availabilityDomain String

    The name of the availability domain that the DB system is located in.

    backupNetworkNsgIds List<String>

    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.

    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.

    compartmentId String

    The OCID of the compartment.

    cpuCoreCount Number

    The number of CPU cores enabled on the DB system.

    dataStoragePercentage Number

    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). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

    dataStorageSizeInGb Number

    The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

    databaseEdition String

    The Oracle Database edition that applies to all the databases on the DB system.

    dbSystemId String

    The DB system OCID.

    dbSystemOptions List<Property Map>

    The DB system options.

    definedTags Map<Any>

    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. HIGH is 3-way redundancy.

    displayName String

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

    domain String

    The domain name for the DB system.

    faultDomains List<String>

    List of the Fault Domains in which this DB system is provisioned.

    freeformTags Map<Any>

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

    hostname String

    The hostname for the DB system.

    iormConfigCaches List<Property Map>

    The IORM settings of the Exadata DB system.

    isSnapshotRetentionDaysForceUpdated Boolean

    If true, rollback time is updated even if operating system upgrade history contains errors.

    kmsKeyId String

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

    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

    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.

    maintenanceWindows List<Property Map>

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

    newGiVersion String

    A valid Oracle Grid Infrastructure (GI) software version.

    nextMaintenanceRunId String

    The OCID of the next maintenance run.

    nodeCount Number

    The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

    nsgIds List<String>

    A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

    • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot be empty.
    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.

    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>

    The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.

    shape String

    The shape of the DB system. The shape determines resources to allocate 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, storage, and memory
    snapshotRetentionPeriodInDays Number

    The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade.

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

    sourceDbSystemId String

    The OCID of the DB system.

    sparseDiskgroup Boolean

    True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.

    sshPublicKeys List<String>

    The public key portion of one or more key pairs used for SSH access to the DB system.

    state String

    The current state of the DB system.

    subnetId String

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

    timeCreated String

    The date and time the DB system was created.

    timeZone String

    The time zone of the DB system. For details, see DB System Time Zones.

    version String

    The Oracle Database version of the DB system.

    vipIds List<String>

    The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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.

    Supporting Types

    DbSystemsUpgradeDbSystemOption, DbSystemsUpgradeDbSystemOptionArgs

    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

    DbSystemsUpgradeIormConfigCach, DbSystemsUpgradeIormConfigCachArgs

    DbPlans List<DbSystemsUpgradeIormConfigCachDbPlan>

    An array of IORM settings for all the database in the Exadata DB system.

    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 []DbSystemsUpgradeIormConfigCachDbPlan

    An array of IORM settings for all the database in the Exadata DB system.

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

    An array of IORM settings for all the database in the Exadata DB system.

    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 DbSystemsUpgradeIormConfigCachDbPlan[]

    An array of IORM settings for all the database in the Exadata DB system.

    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 DbSystemsUpgradeIormConfigCachDbPlan]

    An array of IORM settings for all the database in the Exadata DB system.

    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.

    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.

    DbSystemsUpgradeIormConfigCachDbPlan, DbSystemsUpgradeIormConfigCachDbPlanArgs

    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.

    DbSystemsUpgradeMaintenanceWindow, DbSystemsUpgradeMaintenanceWindowArgs

    DaysOfWeeks List<DbSystemsUpgradeMaintenanceWindowDaysOfWeek>

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

    Months during the year when maintenance should be performed.

    Preference string

    The maintenance window scheduling preference.

    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.

    DaysOfWeeks []DbSystemsUpgradeMaintenanceWindowDaysOfWeek

    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
    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 []DbSystemsUpgradeMaintenanceWindowMonth

    Months during the year when maintenance should be performed.

    Preference string

    The maintenance window scheduling preference.

    WeeksOfMonths []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.

    daysOfWeeks List<DbSystemsUpgradeMaintenanceWindowDaysOfWeek>

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

    Months during the year when maintenance should be performed.

    preference String

    The maintenance window scheduling preference.

    weeksOfMonths List<Integer>

    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.

    daysOfWeeks DbSystemsUpgradeMaintenanceWindowDaysOfWeek[]

    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
    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 DbSystemsUpgradeMaintenanceWindowMonth[]

    Months during the year when maintenance should be performed.

    preference string

    The maintenance window scheduling preference.

    weeksOfMonths number[]

    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.

    days_of_weeks DbSystemsUpgradeMaintenanceWindowDaysOfWeek]

    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
    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 DbSystemsUpgradeMaintenanceWindowMonth]

    Months during the year when maintenance should be performed.

    preference str

    The maintenance window scheduling preference.

    weeks_of_months Sequence[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.

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

    preference String

    The maintenance window scheduling preference.

    weeksOfMonths List<Number>

    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.

    DbSystemsUpgradeMaintenanceWindowDaysOfWeek, DbSystemsUpgradeMaintenanceWindowDaysOfWeekArgs

    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.

    DbSystemsUpgradeMaintenanceWindowMonth, DbSystemsUpgradeMaintenanceWindowMonthArgs

    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

    Import is not supported for this resource.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the oci Terraform Provider.

    oci logo
    Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi