Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AutonomousDatabaseSummary

An Oracle Autonomous Database.

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

Enumerations

Properties

Functions

Properties

Optional actualUsedDataStorageSizeInTBs

actualUsedDataStorageSizeInTBs: undefined | number

The current amount of storage in use for user and system data, in terabytes (TB). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional allocatedStorageSizeInTBs

allocatedStorageSizeInTBs: undefined | number

The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the {@code dataStorageSizeInTBs} value. You can compare this value to the {@code actualUsedDataStorageSizeInTBs} value to determine if a manual shrink operation is appropriate for your allocated storage.

*Note:** Auto-scaling does not automatically decrease allocated storage when data is deleted from the database. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional apexDetails

apexDetails: model.AutonomousDatabaseApex

Information about Oracle APEX Application Development.

Optional arePrimaryWhitelistedIpsUsed

arePrimaryWhitelistedIpsUsed: undefined | false | true

This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be {@code TRUE} if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would be {@code FALSE} if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary.

Optional autoRefreshFrequencyInSeconds

autoRefreshFrequencyInSeconds: undefined | number

The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the {@code timeOfAutoRefreshStart} parameter. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional autoRefreshPointLagInSeconds

autoRefreshPointLagInSeconds: undefined | number

The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional autonomousContainerDatabaseId

autonomousContainerDatabaseId: undefined | string

The Autonomous Container Database OCID. Used only by Autonomous Database on Dedicated Exadata Infrastructure.

Optional autonomousMaintenanceScheduleType

autonomousMaintenanceScheduleType: AutonomousMaintenanceScheduleType

The maintenance schedule type of the Autonomous Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle

Optional availableUpgradeVersions

availableUpgradeVersions: Array<string>

List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.

Optional backupConfig

backupConfig: model.AutonomousDatabaseBackupConfig

Optional backupRetentionPeriodInDays

backupRetentionPeriodInDays: undefined | number

Retention period, in days, for long-term backups Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional characterSet

characterSet: undefined | string

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

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

compartmentId

compartmentId: string

The OCID of the compartment.

Optional computeCount

computeCount: undefined | number

The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the {@code computeModel} parameter. When using {@code cpuCoreCount} parameter, it is an error to specify computeCount to a non-null value. Providing {@code computeModel} and {@code computeCount} is the preferred method for both OCPU and ECPU. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional computeModel

computeModel: ComputeModel

The compute model of the Autonomous Database. This is required if using the {@code computeCount} parameter. If using {@code cpuCoreCount} then it is an error to specify {@code computeModel} to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.

Optional connectionStrings

connectionStrings: model.AutonomousDatabaseConnectionStrings

The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.

Optional connectionUrls

connectionUrls: model.AutonomousDatabaseConnectionUrls

Optional cpuCoreCount

cpuCoreCount: undefined | number

The number of CPU cores to be made available to the database. When the ECPU is selected, the value for cpuCoreCount is 0. For Autonomous Database on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.

*Note:** This parameter cannot be used with the {@code ocpuCount} parameter. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional customerContacts

customerContacts: Array<CustomerContact>

Customer Contacts.

Optional dataSafeStatus

dataSafeStatus: DataSafeStatus

Status of the Data Safe registration for this Autonomous Database.

Optional dataStorageSizeInGBs

dataStorageSizeInGBs: undefined | number

The quantity of data in the database, in gigabytes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

dataStorageSizeInTBs

dataStorageSizeInTBs: number

The quantity of data in the database, in terabytes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional databaseEdition

databaseEdition: DatabaseEdition

The Oracle Database Edition that applies to the Autonomous databases.

Optional databaseManagementStatus

databaseManagementStatus: DatabaseManagementStatus

Status of Database Management for this Autonomous Database.

Optional dataguardRegionType

dataguardRegionType: DataguardRegionType

The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region.

dbName

dbName: string

The database name.

Optional dbToolsDetails

dbToolsDetails: Array<DatabaseTool>

The list of database tools details.

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

Optional dbVersion

dbVersion: undefined | string

A valid Oracle Database version for Autonomous Database.

Optional dbWorkload

dbWorkload: DbWorkload

The Autonomous Database workload type. The following values are valid:

- OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.

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

Optional definedTags

definedTags: undefined | object

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

Optional disasterRecoveryRegionType

disasterRecoveryRegionType: DisasterRecoveryRegionType

The disaster recovery (DR) region type of the Autonomous Database. For Autonomous Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region.

Optional displayName

displayName: undefined | string

The user-friendly name for the Autonomous Database. The name does not have to be unique.

Optional failedDataRecoveryInSeconds

failedDataRecoveryInSeconds: undefined | number

Indicates the number of seconds of data loss for a Data Guard failover. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional freeformTags

freeformTags: undefined | 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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the Autonomous Database.

Optional inMemoryAreaInGBs

inMemoryAreaInGBs: undefined | number

The area assigned to In-Memory tables in Autonomous Database. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional inMemoryPercentage

inMemoryPercentage: undefined | number

The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional infrastructureType

infrastructureType: InfrastructureType

The infrastructure type this resource belongs to.

Optional isAccessControlEnabled

isAccessControlEnabled: undefined | false | true

Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the {@code whitelistedIps} property. While specifying {@code whitelistedIps} rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the {@code UpdateAutonomousDatabase} API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.

This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances, {@code whitelistedIps} is used.

Optional isAutoScalingEnabled

isAutoScalingEnabled: undefined | false | true

Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is {@code TRUE}.

Optional isAutoScalingForStorageEnabled

isAutoScalingForStorageEnabled: undefined | false | true

Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is {@code FALSE}.

Optional isDataGuardEnabled

isDataGuardEnabled: undefined | false | true

Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

Optional isDedicated

isDedicated: undefined | false | true

True if the database uses dedicated Exadata infrastructure.

Optional isDevTier

isDevTier: undefined | false | true

This project introduces Autonomous Database for Developers (ADB-Dev), a free tier on dedicated infrastructure, and Cloud@Customer for database development purposes. ADB-Dev enables ExaDB customers to experiment with ADB for free and incentivizes enterprises to use ADB for new development projects.Note that ADB-Dev have 4 CPU and 20GB of memory. For ADB-Dev , memory and CPU cannot be scaled

Optional isFreeTier

isFreeTier: undefined | false | true

Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled.

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

Optional isLocalDataGuardEnabled

isLocalDataGuardEnabled: undefined | false | true

Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

Optional isMtlsConnectionRequired

isMtlsConnectionRequired: undefined | false | true

Specifies if the Autonomous Database requires mTLS connections.

This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true.

Optional isPreview

isPreview: undefined | false | true

Indicates if the Autonomous Database version is a preview version.

Optional isReconnectCloneEnabled

isReconnectCloneEnabled: undefined | false | true

Indicates if the refreshable clone can be reconnected to its source database.

Optional isRefreshableClone

isRefreshableClone: undefined | false | true

Indicates if the Autonomous Database is a refreshable clone.

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

Optional isRemoteDataGuardEnabled

isRemoteDataGuardEnabled: undefined | false | true

Indicates whether the Autonomous Database has Cross Region Data Guard enabled. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

Optional keyHistoryEntry

Key History Entry.

Optional keyStoreId

keyStoreId: undefined | string

The OCID of the key store of Oracle Vault.

Optional keyStoreWalletName

keyStoreWalletName: undefined | string

The wallet name for Oracle Key Vault.

Optional kmsKeyId

kmsKeyId: undefined | string

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

Optional kmsKeyLifecycleDetails

kmsKeyLifecycleDetails: undefined | string

KMS key lifecycle details.

Optional kmsKeyVersionId

kmsKeyVersionId: undefined | string

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

Optional licenseModel

licenseModel: LicenseModel

The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Oracle Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to {@code BRING_YOUR_OWN_LICENSE}. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter.

This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Information about the current lifecycle state.

lifecycleState

lifecycleState: LifecycleState

The current state of the Autonomous Database.

Optional localAdgAutoFailoverMaxDataLossLimit

localAdgAutoFailoverMaxDataLossLimit: undefined | number

Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional localDisasterRecoveryType

localDisasterRecoveryType: undefined | string

Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.

Optional localStandbyDb

localStandbyDb: model.AutonomousDatabaseStandbySummary

Optional longTermBackupSchedule

longTermBackupSchedule: model.LongTermBackUpScheduleDetails

Optional memoryPerOracleComputeUnitInGBs

memoryPerOracleComputeUnitInGBs: undefined | number

The amount of memory (in GBs) enabled per ECPU or OCPU. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional ncharacterSet

ncharacterSet: undefined | string

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

Optional netServicesArchitecture

netServicesArchitecture: NetServicesArchitecture

Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.

Optional nextLongTermBackupTimeStamp

nextLongTermBackupTimeStamp: Date

The date and time when the next long-term backup would be created.

Optional nsgIds

nsgIds: Array<string>

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

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

Optional ocpuCount

ocpuCount: undefined | number

The number of OCPU cores to be made available to the database.

The following points apply: - For Autonomous Databases on Dedicated Exadata Infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Database Serverless instances.) - To provision cores, enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both serverless and dedicated Exadata infrastructure. - For Autonomous Database Serverless instances, this parameter is not used.

For Autonomous Databases on Dedicated Exadata Infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html) for shape details.

*Note:** This parameter cannot be used with the {@code cpuCoreCount} parameter. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional openMode

openMode: OpenMode

Indicates the Autonomous Database mode. The database can be opened in {@code READ_ONLY} or {@code READ_WRITE} mode.

This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Optional operationsInsightsStatus

operationsInsightsStatus: OperationsInsightsStatus

Status of Operations Insights for this Autonomous Database.

Optional peerDbIds

peerDbIds: Array<string>

The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.

Optional permissionLevel

permissionLevel: PermissionLevel

The Autonomous Database permission level. Restricted mode allows access only by admin users.

This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

Optional privateEndpoint

privateEndpoint: undefined | string

The private endpoint for the resource.

Optional privateEndpointIp

privateEndpointIp: undefined | string

The private endpoint Ip address for the resource.

Optional privateEndpointLabel

privateEndpointLabel: undefined | string

The resource's private endpoint label.

  • Setting the endpoint label to a non-empty string creates a private endpoint database.
  • Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database.
  • Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.

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

Optional provisionableCpus

provisionableCpus: Array<number>

An array of CPU values that an Autonomous Database can be scaled to.

Optional refreshableMode

refreshableMode: RefreshableMode

The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.

Optional refreshableStatus

refreshableStatus: RefreshableStatus

The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.

Optional remoteDisasterRecoveryConfiguration

remoteDisasterRecoveryConfiguration: model.DisasterRecoveryConfiguration

Optional resourcePoolLeaderId

resourcePoolLeaderId: undefined | string

The unique identifier for leader autonomous database OCID OCID.

Optional resourcePoolSummary

resourcePoolSummary: model.ResourcePoolSummary

Optional role

role: Role

The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Optional scheduledOperations

scheduledOperations: Array<ScheduledOperationDetails>

The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.

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

Optional serviceConsoleUrl

serviceConsoleUrl: undefined | string

The URL of the Service Console for the Autonomous Database.

Optional sourceId

sourceId: undefined | string

The OCID of the source Autonomous Database that was cloned to create the current Autonomous Database.

Optional standbyDb

standbyDb: model.AutonomousDatabaseStandbySummary

Deprecated Autonomous Data Guard standby database details.

Optional standbyWhitelistedIps

standbyWhitelistedIps: Array<string>

The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If {@code arePrimaryWhitelistedIpsUsed} is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer called {@code standbywhitelistedips}.

For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it\u2019s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: {@code [\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]} For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: {@code [\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]}

For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.

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

Optional subnetId

subnetId: undefined | string

The OCID of the subnet the resource is associated with.

*Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous Database, setting this will disable public secure access to the database.

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

Optional supportedRegionsToCloneTo

supportedRegionsToCloneTo: Array<string>

The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.

Optional systemTags

systemTags: undefined | object

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

Optional timeCreated

timeCreated: Date

The date and time the Autonomous Database was created.

Optional timeDataGuardRoleChanged

timeDataGuardRoleChanged: Date

The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.

Optional timeDeletionOfFreeAutonomousDatabase

timeDeletionOfFreeAutonomousDatabase: Date

The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.

Optional timeDisasterRecoveryRoleChanged

timeDisasterRecoveryRoleChanged: Date

The date and time the Disaster Recovery role was switched for the standby Autonomous Database.

Optional timeLocalDataGuardEnabled

timeLocalDataGuardEnabled: Date

The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.

Optional timeMaintenanceBegin

timeMaintenanceBegin: Date

The date and time when maintenance will begin.

Optional timeMaintenanceEnd

timeMaintenanceEnd: Date

The date and time when maintenance will end.

Optional timeOfAutoRefreshStart

timeOfAutoRefreshStart: Date

The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the {@code autoRefreshFrequencyInSeconds} parameter.

Optional timeOfJoiningResourcePool

timeOfJoiningResourcePool: Date

The time the member joined the resource pool.

Optional timeOfLastFailover

timeOfLastFailover: Date

The timestamp of the last failover operation.

Optional timeOfLastRefresh

timeOfLastRefresh: Date

The date and time when last refresh happened.

Optional timeOfLastRefreshPoint

timeOfLastRefreshPoint: Date

The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.

Optional timeOfLastSwitchover

timeOfLastSwitchover: Date

The timestamp of the last switchover operation for the Autonomous Database.

Optional timeOfNextRefresh

timeOfNextRefresh: Date

The date and time of next refresh.

Optional timeReclamationOfFreeAutonomousDatabase

timeReclamationOfFreeAutonomousDatabase: Date

The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.

Optional timeUntilReconnectCloneEnabled

timeUntilReconnectCloneEnabled: Date

The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.

Optional totalBackupStorageSizeInGBs

totalBackupStorageSizeInGBs: undefined | number

The backup storage to the database. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional usedDataStorageSizeInGBs

usedDataStorageSizeInGBs: undefined | number

The storage space consumed by Autonomous Database in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional usedDataStorageSizeInTBs

usedDataStorageSizeInTBs: undefined | number

The amount of storage that has been used, in terabytes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional vaultId

vaultId: undefined | string

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

Optional whitelistedIps

whitelistedIps: Array<string>

The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If {@code arePrimaryWhitelistedIpsUsed} is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer called {@code standbywhitelistedips}.

For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple IPs and VCN OCIDs should be separate strings separated by commas, but if it\u2019s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: {@code [\"1.1.1.1\",\"1.1.1.0/24\",\"ocid1.vcn.oc1.sea.\",\"ocid1.vcn.oc1.sea.;1.1.1.1\",\"ocid1.vcn.oc1.sea.;1.1.0.0/16\"]} For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: {@code [\"1.1.1.1\",\"1.1.1.0/24\",\"1.1.2.25\"]}

For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.

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

Functions

getDeserializedJsonObj

getJsonObj