autonomous_databases
Creates, updates, deletes, gets or lists an autonomous_databases resource.
Overview​
| Name | autonomous_databases |
| Type | Resource |
| Id | oci.database.autonomous_databases |
Fields​
The following fields are returned by SELECT queries:
- get
- list
Get the details of the specified Autonomous AI Database.
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. |
accessTypes | array | List of access types for an Autonomous AI Database. |
actualUsedDataStorageSizeInTBs | number (double) | The current amount of storage in use for user and system data, in terabytes (TB). |
allocatedStorageSizeInTBs | number (double) | 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 dataStorageSizeInTBs value. You can compare this value to the 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. |
apexDetails | object | Oracle APEX AI Application Development is a low-code development platform that enables you to build scalable, secure enterprise apps, with world-class features. Autonomous AI Database with the APEX workload type is optimized to support APEX development. |
arePrimaryWhitelistedIpsUsed | boolean | This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. It's value would be TRUE if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses primary IP access control list (ACL) for standby. It's value would be FALSE if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses different IP access control list (ACL) for standby compared to primary. |
autoRefreshFrequencyInSeconds | integer | 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 timeOfAutoRefreshStart parameter. |
autoRefreshPointLagInSeconds | integer | 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. |
autonomousContainerDatabaseId | string | The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. |
autonomousMaintenanceScheduleType | string | The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle (EARLY, REGULAR) |
availabilityDomain | string | The availability domain where the Autonomous AI Database Serverless instance is located. |
availableUpgradeVersions | array | List of Oracle AI Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. |
backupConfig | object | Autonomous AI Database configuration details for storing [manual backups](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/backup-restore.html#GUID-9035DFB8-4702-4CEB-8281-C2A303820809) in the [Object Storage](/Content/Object/Concepts/objectstorageoverview.htm) service. |
byolComputeCountLimit | number (float) | The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed. |
characterSet | string | The character set for the Autonomous AI 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 |
cloneTableSpaceList | array | A list of the source Autonomous AI Database's table space number(s) used to create this partial clone from the backup. |
cloneType | string | The Autonomous AI Database clone type. (FULL, METADATA, PARTIAL) |
clusterPlacementGroupId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Autonomous Serverless Database. |
compartmentId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. |
computeCount | number (float) | The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. 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 computeModel parameter. When using cpuCoreCount parameter, it is an error to specify computeCount to a non-null value. Providing computeModel and computeCount is the preferred method for both OCPU and ECPU. (x-default-description: Null used when unspecified.) |
computeModel | string | The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. (ECPU, OCPU) (x-default-description: Null used when unspecified.) |
connectionStrings | object | Connection strings to connect to an Oracle Autonomous AI Database. Example output for connection strings. See [DatabaseConnectionStringProfile](#/en/database/latest/datatypes/DatabaseConnectionStringProfile) for additional details: "connectionStrings": { "allConnectionStrings": { "HIGH": "adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com", "LOW": "adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com", "MEDIUM": "adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com" }, "profiles": [ { "displayName": "databasename_high", "value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_high.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))", "consumerGroup": "HIGH", "protocol": "TCPS", "tlsAuthentication": "MUTUAL", "hostFormat": "FQDN", "sessionMode": "DIRECT", "syntaxFormat": "LONG" }, { "displayName": "databasename_low", "value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_low.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))", "consumerGroup": "LOW", "protocol": "TCPS", "tlsAuthentication": "MUTUAL", "hostFormat": "FQDN", "sessionMode": "DIRECT", "syntaxFormat": "LONG" }, { "displayName": "databasename_medium", "value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_medium.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))", "consumerGroup": "MEDIUM", "protocol": "TCPS", "tlsAuthentication": "MUTUAL", "hostFormat": "FQDN", "sessionMode": "DIRECT", "syntaxFormat": "LONG" } ], "dedicated": null, "high": "adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com", "low": "adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com", "medium": "adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com" } |
connectionUrls | object | The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on [dedicated Exadata infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/index.html). Example: {"sqlDevWebUrl": "https:​//<hostname>/ords...", "apexUrl", "https:​//<hostname>/ords..."} |
cpuCoreCount | integer | 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 AI Database 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/) for shape details. Note: This parameter cannot be used with the ocpuCount parameter. |
customerContacts | array | Customer Contacts. |
dataSafeStatus | string | Status of the Data Safe registration for this Autonomous AI Database. (REGISTERING, REGISTERED, DEREGISTERING, NOT_REGISTERED, FAILED) |
dataStorageSizeInGBs | integer | The quantity of data in the database, in gigabytes. For Autonomous AI Transaction Processing databases using ECPUs on Serverless Infrastructure, this value is always populated. In all the other cases, this value will be null and dataStorageSizeInTBs will be populated instead. |
dataStorageSizeInTBs | integer | The quantity of data in the database, in terabytes. The following points apply to Autonomous AI Databases on Serverless Infrastructure: - This is an integer field whose value remains null when the data size is in GBs and cannot be converted to TBs (by dividing the GB value by 1024) without rounding error. - To get the exact value of data storage size without rounding error, please see dataStorageSizeInGBs of Autonomous AI Database. |
databaseEdition | string | The Oracle AI Database Edition that applies to the Autonomous AI Databases. (STANDARD_EDITION, ENTERPRISE_EDITION) |
databaseManagementStatus | string | Status of Database Management for this Autonomous AI Database. (ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING) |
dataguardRegionType | string | Deprecated. The Autonomous Data Guard region type of the Autonomous AI Database. For Autonomous AI 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. (PRIMARY_DG_REGION, REMOTE_STANDBY_DG_REGION) |
dbName | string | The database name. |
dbToolsDetails | array | 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. (x-default-description: null) |
dbVersion | string | A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. Note Starting December 2026, 23ai will not be supported as a valid value for this parameter. |
dbWorkload | string | The Autonomous AI Database workload type. The following values are valid: - OLTP - indicates an Autonomous AI Transaction Processing database - DW - indicates an Autonomous AI Lakehouse database - AJD - indicates an Autonomous AI JSON Database - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. - LH - indicates an Oracle Autonomous AI Lakehouse database Note Starting December 2026, DW will not be supported as a valid value for this parameter. When creating an Autonomous AI Database, if this parameter is not specified, the default value is OLTP. 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. (OLTP, DW, AJD, APEX, LH) |
definedTags | object | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
disasterRecoveryRegionType | string | Deprecated. The disaster recovery (DR) region type of the Autonomous AI Database. For Autonomous AI 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. (PRIMARY, REMOTE) |
displayName | string | The user-friendly name for the Autonomous AI Database. The name does not have to be unique. |
encryptionKey | object | Details of the Autonomous AI Database encryption key. |
encryptionKeyHistoryEntry | array | Key History Entry. |
failedDataRecoveryInSeconds | integer | Indicates the number of seconds of data loss for a Data Guard failover. |
freeformTags | 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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
inMemoryAreaInGBs | integer | The area assigned to In-Memory tables in Autonomous AI Database. |
inMemoryPercentage | integer | The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. |
infrastructureType | string | The infrastructure type this resource belongs to. (CLOUD, CLOUD_AT_CUSTOMER) |
isAccessControlEnabled | boolean | 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 whitelistedIps property. While specifying 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 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 AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, whitelistedIps is used. |
isAutoScalingEnabled | boolean | Indicates if auto scaling is enabled for the Autonomous AI Database CPU core count. The default value is TRUE. |
isAutoScalingForStorageEnabled | boolean | Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is FALSE. |
isBackupRetentionLocked | boolean | Indicates if the Autonomous AI Database is backup retention locked. |
isDataGuardEnabled | boolean | Deprecated. Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. |
isDedicated | boolean | True if the database uses [dedicated Exadata infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/index.html). |
isDevTier | boolean | Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. |
isFreeTier | boolean | Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI 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 |
isLocalDataGuardEnabled | boolean | Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. |
isMtlsConnectionRequired | boolean | Specifies if the Autonomous AI 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 AI 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. |
isPreview | boolean | Indicates if the Autonomous AI Database version is a preview version. |
isReconnectCloneEnabled | boolean | Indicates if the refreshable clone can be reconnected to its source database. |
isRefreshableClone | boolean | Indicates if the Autonomous AI 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. |
isRemoteDataGuardEnabled | boolean | Indicates whether the Autonomous AI Database has Cross Region Data Guard enabled. Not applicable to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. |
keyHistoryEntry | array | Key History Entry. |
keyStoreId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. |
keyStoreWalletName | string | The wallet name for Oracle Key Vault. |
kmsKeyId | string | The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. |
kmsKeyLifecycleDetails | string | KMS key lifecycle details. |
kmsKeyVersionId | string | The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. |
licenseModel | string | The Oracle license model that applies to the Oracle Autonomous AI 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 AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI 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 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. (LICENSE_INCLUDED, BRING_YOUR_OWN_LICENSE) |
lifecycleDetails | string | Information about the current lifecycle state. |
lifecycleState | string | The current state of the Autonomous AI Database. (PROVISIONING, AVAILABLE, STOPPING, STOPPED, STARTING, TERMINATING, TERMINATED, UNAVAILABLE, RESTORE_IN_PROGRESS, RESTORE_FAILED, BACKUP_IN_PROGRESS, SCALE_IN_PROGRESS, AVAILABLE_NEEDS_ATTENTION, UPDATING, MAINTENANCE_IN_PROGRESS, RESTARTING, RECREATING, ROLE_CHANGE_IN_PROGRESS, UPGRADING, INACCESSIBLE, STANDBY, TRANSPORTING) |
localAdgAutoFailoverMaxDataLossLimit | integer | 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 |
localDisasterRecoveryType | string | Indicates the local disaster recovery (DR) type of the Autonomous AI 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. (x-obmcs-enumref: #/definitions/DisasterRecoveryConfiguration/disasterRecoveryType) |
localStandbyDb | object | Autonomous Data Guard standby database details. |
longTermBackupSchedule | object | Details for the long-term backup schedule. |
maintenanceTargetComponent | string | The component chosen for maintenance. |
memoryPerOracleComputeUnitInGBs | integer | The amount of memory (in GBs) to be enabled per OCPU or ECPU. |
ncharacterSet | string | The national character set for the Autonomous AI Database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8. |
netServicesArchitecture | string | 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. (DEDICATED, SHARED) |
nextLongTermBackupTimeStamp | string (date-time) | The date and time when the next long-term backup would be created. |
nsgIds | array | The list of [OCIDs](/Content/General/Concepts/identifiers.htm) 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](/Content/Network/Concepts/securityrules.htm). |
ocpuCount | number (float) | The number of OCPU cores to be made available to the database. The following points apply: - For Autonomous AI 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 AI 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 AI Databases on both serverless and dedicated Exadata infrastructure. - For Autonomous AI Database Serverless instances, this parameter is not used. For Autonomous AI 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 cpuCoreCount parameter. |
openMode | string | Indicates the Autonomous AI Database mode. The database can be opened in READ_ONLY or 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. (READ_ONLY, READ_WRITE) (x-default-description: null) |
operationsInsightsStatus | string | Status of Operations Insights for this Autonomous AI Database. (ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING) |
peerDbIds | array | The list of [OCIDs](https:​//docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous AI Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. |
permissionLevel | string | The Autonomous AI 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. (RESTRICTED, UNRESTRICTED) (x-default-description: null) |
privateEndpoint | string | The private endpoint for the resource. |
privateEndpointIp | string | The private endpoint Ip address for the resource. |
privateEndpointLabel | 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. |
provisionableCpus | array | An array of CPU values that an Autonomous AI Database can be scaled to. |
publicConnectionUrls | object | The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on [dedicated Exadata infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/index.html). Example: {"sqlDevWebUrl": "https:​//<hostname>/ords...", "apexUrl", "https:​//<hostname>/ords..."} |
publicEndpoint | string | The public endpoint for the private endpoint enabled resource. |
refreshableMode | string | The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous AI Database. (AUTOMATIC, MANUAL) |
refreshableStatus | string | The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous AI Database. (REFRESHING, NOT_REFRESHING) (x-default-description: This property is only valid for refreshable clones and is null for for databases that are not refreshable clones.) |
remoteDisasterRecoveryConfiguration | object | Configurations of a Disaster Recovery. |
resourcePoolLeaderId | string | The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm). |
resourcePoolSummary | object | The configuration details for resource pool |
role | string | The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. (PRIMARY, STANDBY, DISABLED_STANDBY, BACKUP_COPY, SNAPSHOT_STANDBY) |
scheduledOperations | array | 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. |
securityAttributes | object | Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}} |
serviceConsoleUrl | string | The URL of the Service Console for the Autonomous AI Database. |
sourceId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the source Autonomous AI Database that was cloned to create the current Autonomous AI Database. |
sqlWebDeveloperUrl | string | The SQL Web Developer URL for the Oracle Autonomous AI Database. The sqlWebDeveloperUrl is only returned if isSqlWebDeveloperEnabled boolean is set to TRUE. |
standbyDb | object | Autonomous Data Guard standby database details. |
standbyWhitelistedIps | array | The client IP access control list (ACL). This feature is available for [Autonomous AI 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 AI Database instance. If arePrimaryWhitelistedIpsUsed is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called standbywhitelistedips. For Autonomous AI 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’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: ["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"] For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: ["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. |
subnetId | string | The [OCID](/Content/General/Concepts/identifiers.htm) 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 AI 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. |
subscriptionId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. |
supportedRegionsToCloneTo | array | The list of regions that support the creation of an Autonomous AI Database clone or an Autonomous Data Guard standby database. |
systemTags | object | System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
timeCreated | string (date-time) | The date and time the Autonomous AI Database was created. |
timeDataGuardRoleChanged | string (date-time) | The date and time the Autonomous Data Guard role was switched for the Autonomous AI 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. |
timeDeletionOfFreeAutonomousDatabase | string (date-time) | 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. |
timeDisasterRecoveryRoleChanged | string (date-time) | The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. |
timeLocalDataGuardEnabled | string (date-time) | The date and time that Autonomous Data Guard was enabled for an Autonomous AI Database where the standby was provisioned in the same region as the primary database. |
timeMaintenanceBegin | string (date-time) | The date and time when maintenance will begin. |
timeMaintenanceEnd | string (date-time) | The date and time when maintenance will end. |
timeOfAutoRefreshStart | string (date-time) | The the date and time that auto-refreshing will begin for an Autonomous AI 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 autoRefreshFrequencyInSeconds parameter. |
timeOfJoiningResourcePool | string (date-time) | The time the member joined the resource pool. |
timeOfLastFailover | string (date-time) | The timestamp of the last failover operation. |
timeOfLastRefresh | string (date-time) | The date and time when last refresh happened. |
timeOfLastRefreshPoint | string (date-time) | 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. |
timeOfLastSwitchover | string (date-time) | The timestamp of the last switchover operation for the Autonomous AI Database. |
timeOfNextRefresh | string (date-time) | The date and time of next refresh. |
timeReclamationOfFreeAutonomousDatabase | string (date-time) | 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. |
timeUndeleted | string (date-time) | The date and time the Autonomous AI Database was most recently undeleted. |
timeUntilReconnectCloneEnabled | string (date-time) | 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. |
usedDataStorageSizeInGBs | integer | The storage space consumed by Autonomous AI Database in GBs. |
usedDataStorageSizeInTBs | integer | The amount of storage that has been used for Autonomous AI Databases in dedicated infrastructure, in terabytes. |
vaultId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and secretId are required for Customer Managed Keys. |
whitelistedIps | array | The client IP access control list (ACL). This feature is available for [Autonomous AI 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 AI Database instance. If arePrimaryWhitelistedIpsUsed is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called standbywhitelistedips. For Autonomous AI 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’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: ["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"] For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: ["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. |
An Oracle Autonomous AI Database.<br /> <br />Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.<br />
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. |
accessTypes | array | List of access types for an Autonomous AI Database. |
actualUsedDataStorageSizeInTBs | number (double) | The current amount of storage in use for user and system data, in terabytes (TB). |
allocatedStorageSizeInTBs | number (double) | 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 dataStorageSizeInTBs value. You can compare this value to the 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. |
apexDetails | object | Oracle APEX AI Application Development is a low-code development platform that enables you to build scalable, secure enterprise apps, with world-class features. Autonomous AI Database with the APEX workload type is optimized to support APEX development. |
arePrimaryWhitelistedIpsUsed | boolean | This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. It's value would be TRUE if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses primary IP access control list (ACL) for standby. It's value would be FALSE if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses different IP access control list (ACL) for standby compared to primary. |
autoRefreshFrequencyInSeconds | integer | 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 timeOfAutoRefreshStart parameter. |
autoRefreshPointLagInSeconds | integer | 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. |
autonomousContainerDatabaseId | string | The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. |
autonomousMaintenanceScheduleType | string | The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle (EARLY, REGULAR) |
availabilityDomain | string | The availability domain where the Autonomous AI Database Serverless instance is located. |
availableUpgradeVersions | array | List of Oracle AI Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. |
backupConfig | object | Autonomous AI Database configuration details for storing [manual backups](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/backup-restore.html#GUID-9035DFB8-4702-4CEB-8281-C2A303820809) in the [Object Storage](/Content/Object/Concepts/objectstorageoverview.htm) service. |
byolComputeCountLimit | number (float) | The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed. |
characterSet | string | The character set for the Autonomous AI 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 |
cloneTableSpaceList | array | A list of the source Autonomous AI Database's table space number(s) used to create this partial clone from the backup. |
cloneType | string | The Autonomous AI Database clone type. (FULL, METADATA, PARTIAL) |
clusterPlacementGroupId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Autonomous Serverless Database. |
compartmentId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. |
computeCount | number (float) | The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure. 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 computeModel parameter. When using cpuCoreCount parameter, it is an error to specify computeCount to a non-null value. Providing computeModel and computeCount is the preferred method for both OCPU and ECPU. (x-default-description: Null used when unspecified.) |
computeModel | string | The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. (ECPU, OCPU) (x-default-description: Null used when unspecified.) |
connectionStrings | object | Connection strings to connect to an Oracle Autonomous AI Database. Example output for connection strings. See [DatabaseConnectionStringProfile](#/en/database/latest/datatypes/DatabaseConnectionStringProfile) for additional details: "connectionStrings": { "allConnectionStrings": { "HIGH": "adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com", "LOW": "adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com", "MEDIUM": "adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com" }, "profiles": [ { "displayName": "databasename_high", "value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_high.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))", "consumerGroup": "HIGH", "protocol": "TCPS", "tlsAuthentication": "MUTUAL", "hostFormat": "FQDN", "sessionMode": "DIRECT", "syntaxFormat": "LONG" }, { "displayName": "databasename_low", "value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_low.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))", "consumerGroup": "LOW", "protocol": "TCPS", "tlsAuthentication": "MUTUAL", "hostFormat": "FQDN", "sessionMode": "DIRECT", "syntaxFormat": "LONG" }, { "displayName": "databasename_medium", "value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_medium.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))", "consumerGroup": "MEDIUM", "protocol": "TCPS", "tlsAuthentication": "MUTUAL", "hostFormat": "FQDN", "sessionMode": "DIRECT", "syntaxFormat": "LONG" } ], "dedicated": null, "high": "adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com", "low": "adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com", "medium": "adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com" } |
connectionUrls | object | The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on [dedicated Exadata infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/index.html). Example: {"sqlDevWebUrl": "https:​//<hostname>/ords...", "apexUrl", "https:​//<hostname>/ords..."} |
cpuCoreCount | integer | 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 AI Database 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/) for shape details. Note: This parameter cannot be used with the ocpuCount parameter. |
customerContacts | array | Customer Contacts. |
dataSafeStatus | string | Status of the Data Safe registration for this Autonomous AI Database. (REGISTERING, REGISTERED, DEREGISTERING, NOT_REGISTERED, FAILED) |
dataStorageSizeInGBs | integer | The quantity of data in the database, in gigabytes. For Autonomous AI Transaction Processing databases using ECPUs on Serverless Infrastructure, this value is always populated. In all the other cases, this value will be null and dataStorageSizeInTBs will be populated instead. |
dataStorageSizeInTBs | integer | The quantity of data in the database, in terabytes. The following points apply to Autonomous AI Databases on Serverless Infrastructure: - This is an integer field whose value remains null when the data size is in GBs and cannot be converted to TBs (by dividing the GB value by 1024) without rounding error. - To get the exact value of data storage size without rounding error, please see dataStorageSizeInGBs of Autonomous AI Database. |
databaseEdition | string | The Oracle AI Database Edition that applies to the Autonomous AI Databases. (STANDARD_EDITION, ENTERPRISE_EDITION) |
databaseManagementStatus | string | Status of Database Management for this Autonomous AI Database. (ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING) |
dataguardRegionType | string | Deprecated. The Autonomous Data Guard region type of the Autonomous AI Database. For Autonomous AI 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. (PRIMARY_DG_REGION, REMOTE_STANDBY_DG_REGION) |
dbName | string | The database name. |
dbToolsDetails | array | 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. (x-default-description: null) |
dbVersion | string | A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. Note Starting December 2026, 23ai will not be supported as a valid value for this parameter. |
dbWorkload | string | The Autonomous AI Database workload type. The following values are valid: - OLTP - indicates an Autonomous AI Transaction Processing database - DW - indicates an Autonomous AI Lakehouse database - AJD - indicates an Autonomous AI JSON Database - APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. - LH - indicates an Oracle Autonomous AI Lakehouse database Note Starting December 2026, DW will not be supported as a valid value for this parameter. When creating an Autonomous AI Database, if this parameter is not specified, the default value is OLTP. 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. (OLTP, DW, AJD, APEX, LH) |
definedTags | object | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
disasterRecoveryRegionType | string | Deprecated. The disaster recovery (DR) region type of the Autonomous AI Database. For Autonomous AI 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. (PRIMARY, REMOTE) |
displayName | string | The user-friendly name for the Autonomous AI Database. The name does not have to be unique. |
encryptionKey | object | Details of the Autonomous AI Database encryption key. |
encryptionKeyHistoryEntry | array | Key History Entry. |
failedDataRecoveryInSeconds | integer | Indicates the number of seconds of data loss for a Data Guard failover. |
freeformTags | 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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
inMemoryAreaInGBs | integer | The area assigned to In-Memory tables in Autonomous AI Database. |
inMemoryPercentage | integer | The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. |
infrastructureType | string | The infrastructure type this resource belongs to. (CLOUD, CLOUD_AT_CUSTOMER) |
isAccessControlEnabled | boolean | 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 whitelistedIps property. While specifying 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 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 AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, whitelistedIps is used. |
isAutoScalingEnabled | boolean | Indicates if auto scaling is enabled for the Autonomous AI Database CPU core count. The default value is TRUE. |
isAutoScalingForStorageEnabled | boolean | Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is FALSE. |
isBackupRetentionLocked | boolean | Indicates if the Autonomous AI Database is backup retention locked. |
isDataGuardEnabled | boolean | Deprecated. Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. |
isDedicated | boolean | True if the database uses [dedicated Exadata infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/index.html). |
isDevTier | boolean | Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. |
isFreeTier | boolean | Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI 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 |
isLocalDataGuardEnabled | boolean | Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. |
isMtlsConnectionRequired | boolean | Specifies if the Autonomous AI 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 AI 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. |
isPreview | boolean | Indicates if the Autonomous AI Database version is a preview version. |
isReconnectCloneEnabled | boolean | Indicates if the refreshable clone can be reconnected to its source database. |
isRefreshableClone | boolean | Indicates if the Autonomous AI 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. |
isRemoteDataGuardEnabled | boolean | Indicates whether the Autonomous AI Database has Cross Region Data Guard enabled. Not applicable to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. |
keyHistoryEntry | array | Key History Entry. |
keyStoreId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. |
keyStoreWalletName | string | The wallet name for Oracle Key Vault. |
kmsKeyId | string | The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. |
kmsKeyLifecycleDetails | string | KMS key lifecycle details. |
kmsKeyVersionId | string | The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. |
licenseModel | string | The Oracle license model that applies to the Oracle Autonomous AI 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 AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI 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 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. (LICENSE_INCLUDED, BRING_YOUR_OWN_LICENSE) |
lifecycleDetails | string | Information about the current lifecycle state. |
lifecycleState | string | The current state of the Autonomous AI Database. (PROVISIONING, AVAILABLE, STOPPING, STOPPED, STARTING, TERMINATING, TERMINATED, UNAVAILABLE, RESTORE_IN_PROGRESS, RESTORE_FAILED, BACKUP_IN_PROGRESS, SCALE_IN_PROGRESS, AVAILABLE_NEEDS_ATTENTION, UPDATING, MAINTENANCE_IN_PROGRESS, RESTARTING, RECREATING, ROLE_CHANGE_IN_PROGRESS, UPGRADING, INACCESSIBLE, STANDBY, TRANSPORTING) |
localAdgAutoFailoverMaxDataLossLimit | integer | 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 |
localDisasterRecoveryType | string | Indicates the local disaster recovery (DR) type of the Autonomous AI 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. (x-obmcs-enumref: #/definitions/DisasterRecoveryConfiguration/disasterRecoveryType) |
localStandbyDb | object | Autonomous Data Guard standby database details. |
longTermBackupSchedule | object | Details for the long-term backup schedule. |
maintenanceTargetComponent | string | The component chosen for maintenance. |
memoryPerOracleComputeUnitInGBs | integer | The amount of memory (in GBs) to be enabled per OCPU or ECPU. |
ncharacterSet | string | The national character set for the Autonomous AI Database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8. |
netServicesArchitecture | string | 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. (DEDICATED, SHARED) |
nextLongTermBackupTimeStamp | string (date-time) | The date and time when the next long-term backup would be created. |
nsgIds | array | The list of [OCIDs](/Content/General/Concepts/identifiers.htm) 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](/Content/Network/Concepts/securityrules.htm). |
ocpuCount | number (float) | The number of OCPU cores to be made available to the database. The following points apply: - For Autonomous AI 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 AI 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 AI Databases on both serverless and dedicated Exadata infrastructure. - For Autonomous AI Database Serverless instances, this parameter is not used. For Autonomous AI 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 cpuCoreCount parameter. |
openMode | string | Indicates the Autonomous AI Database mode. The database can be opened in READ_ONLY or 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. (READ_ONLY, READ_WRITE) (x-default-description: null) |
operationsInsightsStatus | string | Status of Operations Insights for this Autonomous AI Database. (ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING) |
peerDbIds | array | The list of [OCIDs](https:​//docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous AI Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. |
permissionLevel | string | The Autonomous AI 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. (RESTRICTED, UNRESTRICTED) (x-default-description: null) |
privateEndpoint | string | The private endpoint for the resource. |
privateEndpointIp | string | The private endpoint Ip address for the resource. |
privateEndpointLabel | 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. |
provisionableCpus | array | An array of CPU values that an Autonomous AI Database can be scaled to. |
publicConnectionUrls | object | The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on [dedicated Exadata infrastructure](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/index.html). Example: {"sqlDevWebUrl": "https:​//<hostname>/ords...", "apexUrl", "https:​//<hostname>/ords..."} |
publicEndpoint | string | The public endpoint for the private endpoint enabled resource. |
refreshableMode | string | The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous AI Database. (AUTOMATIC, MANUAL) |
refreshableStatus | string | The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous AI Database. (REFRESHING, NOT_REFRESHING) (x-default-description: This property is only valid for refreshable clones and is null for for databases that are not refreshable clones.) |
remoteDisasterRecoveryConfiguration | object | Configurations of a Disaster Recovery. |
resourcePoolLeaderId | string | The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm). |
resourcePoolSummary | object | The configuration details for resource pool |
role | string | The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. (PRIMARY, STANDBY, DISABLED_STANDBY, BACKUP_COPY, SNAPSHOT_STANDBY) |
scheduledOperations | array | 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. |
securityAttributes | object | Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}} |
serviceConsoleUrl | string | The URL of the Service Console for the Autonomous AI Database. |
sourceId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the source Autonomous AI Database that was cloned to create the current Autonomous AI Database. |
sqlWebDeveloperUrl | string | The SQL Web Developer URL for the Oracle Autonomous AI Database. The sqlWebDeveloperUrl is only returned if isSqlWebDeveloperEnabled boolean is set to TRUE. |
standbyDb | object | Autonomous Data Guard standby database details. |
standbyWhitelistedIps | array | The client IP access control list (ACL). This feature is available for [Autonomous AI 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 AI Database instance. If arePrimaryWhitelistedIpsUsed is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called standbywhitelistedips. For Autonomous AI 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’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: ["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"] For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: ["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. |
subnetId | string | The [OCID](/Content/General/Concepts/identifiers.htm) 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 AI 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. |
subscriptionId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. |
supportedRegionsToCloneTo | array | The list of regions that support the creation of an Autonomous AI Database clone or an Autonomous Data Guard standby database. |
systemTags | object | System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
timeCreated | string (date-time) | The date and time the Autonomous AI Database was created. |
timeDataGuardRoleChanged | string (date-time) | The date and time the Autonomous Data Guard role was switched for the Autonomous AI 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. |
timeDeletionOfFreeAutonomousDatabase | string (date-time) | 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. |
timeDisasterRecoveryRoleChanged | string (date-time) | The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. |
timeLocalDataGuardEnabled | string (date-time) | The date and time that Autonomous Data Guard was enabled for an Autonomous AI Database where the standby was provisioned in the same region as the primary database. |
timeMaintenanceBegin | string (date-time) | The date and time when maintenance will begin. |
timeMaintenanceEnd | string (date-time) | The date and time when maintenance will end. |
timeOfAutoRefreshStart | string (date-time) | The the date and time that auto-refreshing will begin for an Autonomous AI 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 autoRefreshFrequencyInSeconds parameter. |
timeOfJoiningResourcePool | string (date-time) | The time the member joined the resource pool. |
timeOfLastFailover | string (date-time) | The timestamp of the last failover operation. |
timeOfLastRefresh | string (date-time) | The date and time when last refresh happened. |
timeOfLastRefreshPoint | string (date-time) | 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. |
timeOfLastSwitchover | string (date-time) | The timestamp of the last switchover operation for the Autonomous AI Database. |
timeOfNextRefresh | string (date-time) | The date and time of next refresh. |
timeReclamationOfFreeAutonomousDatabase | string (date-time) | 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. |
timeUndeleted | string (date-time) | The date and time the Autonomous AI Database was most recently undeleted. |
timeUntilReconnectCloneEnabled | string (date-time) | 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. |
usedDataStorageSizeInGBs | integer | The storage space consumed by Autonomous AI Database in GBs. |
usedDataStorageSizeInTBs | integer | The amount of storage that has been used for Autonomous AI Databases in dedicated infrastructure, in terabytes. |
vaultId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and secretId are required for Customer Managed Keys. |
whitelistedIps | array | The client IP access control list (ACL). This feature is available for [Autonomous AI 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 AI Database instance. If arePrimaryWhitelistedIpsUsed is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called standbywhitelistedips. For Autonomous AI 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’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter. Example: ["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"] For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example: ["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. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | autonomousDatabaseId, region | opc-request-id | Gets the details of the specified Autonomous AI Database.<br /> |
list | select | compartmentId, region | autonomousContainerDatabaseId, limit, page, sortBy, sortOrder, infrastructureType, lifecycleState, lifecycleStateNotEqualTo, dbWorkload, dbVersion, isFreeTier, displayName, opc-request-id, isRefreshableClone, isDataGuardEnabled, isResourcePoolLeader, resourcePoolLeaderId | Gets a list of Autonomous AI Databases based on the query parameters specified.<br /> |
create | insert | region, compartmentId | opc-retry-token, opc-request-id | Creates a new Autonomous AI Database.<br /> |
update | update | autonomousDatabaseId, region | if-match, opc-request-id | Updates one or more attributes of the specified Autonomous AI Database. See the UpdateAutonomousDatabaseDetails resource for a full list of attributes that can be updated.<br /> |
delete | delete | autonomousDatabaseId, region | if-match, opc-request-id, mustDeleteAssociatedLongTermBackups | Deletes the specified Autonomous AI Database.<br /> |
resource_pool_shapes | exec | region | if-match, opc-retry-token, limit, page, opc-request-id | Lists available resource pools shapes. |
change_compartment | exec | autonomousDatabaseId, region, compartmentId | opc-retry-token, opc-request-id, if-match | Move the Autonomous AI Database and its dependent resources to the specified compartment.<br />For more information about moving Autonomous AI Databases, see<br />[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).<br /> |
change_disaster_recovery_configuration | exec | autonomousDatabaseId, region | if-match, opc-request-id | This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database, and must be run on the standby side. |
change_autonomous_database_subscription | exec | autonomousDatabaseId, region | opc-retry-token, opc-request-id, if-match | Associate an Autonomous AI Database with a different subscription.<br /> |
configure_autonomous_database_vault_key | exec | autonomousDatabaseId, region | if-match, opc-request-id, opc-retry-token | Configures the Autonomous AI Database Vault service [key](/Content/KeyManagement/Concepts/keyoverview.htm#concepts).<br /> |
configure_saas_admin_user | exec | autonomousDatabaseId, region | if-match, opc-request-id | This operation updates SaaS administrative user configuration of the Autonomous AI Database. |
deregister_autonomous_database_data_safe | exec | autonomousDatabaseId, region, pdbAdminPassword | opc-request-id | Asynchronously deregisters this Autonomous AI Database with Data Safe.<br /> |
disable_autonomous_database_management | exec | autonomousDatabaseId, region | opc-request-id | Disables Database Management for the Autonomous AI Database resource.<br /> |
disable_autonomous_database_operations_insights | exec | autonomousDatabaseId, region | opc-request-id | Disables Operations Insights for the Autonomous AI Database resource.<br /> |
enable_autonomous_database_management | exec | autonomousDatabaseId, region | opc-request-id | Enables Database Management for Autonomous AI Database.<br /> |
enable_autonomous_database_operations_insights | exec | autonomousDatabaseId, region | opc-request-id | Enables the specified Autonomous AI Database with Operations Insights.<br /> |
fail_over_autonomous_database | exec | autonomousDatabaseId, region | if-match, opc-retry-token, opc-request-id, peerDbId | Initiates a failover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled.<br />This API should be called in the remote region where the peer database resides.<br />Below parameter is optional:<br /> - peerDbId<br /> Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database.<br /> If this parameter is not provided, the failover will happen in the same region.<br /> |
generate_autonomous_database_wallet | exec | autonomousDatabaseId, region, password | opc-request-id, opc-retry-token | Creates and downloads a wallet for the specified Autonomous AI Database.<br /> |
saas_admin_user_status | exec | autonomousDatabaseId, region | opc-request-id | This operation gets SaaS administrative user status of the Autonomous AI Database. |
import_transportable_tablespace | exec | autonomousDatabaseId, region, ttsBundleUrl | if-match, opc-retry-token, opc-request-id | Imports transportable tablespace for the specified Autonomous AI Database.<br /> |
autonomous_database_manual_refresh | exec | autonomousDatabaseId, region | if-match, opc-retry-token, opc-request-id | Initiates a data refresh for an Autonomous AI Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.<br /> |
register_autonomous_database_data_safe | exec | autonomousDatabaseId, region, pdbAdminPassword | opc-request-id | Asynchronously registers this Autonomous AI Database with Data Safe.<br /> |
restart_autonomous_database | exec | autonomousDatabaseId, region | if-match, isOnlineRestart | Restarts the specified Autonomous AI Database.<br /> |
restore_autonomous_database | exec | autonomousDatabaseId, region | if-match | Restores an Autonomous AI Database based on the provided request parameters.<br /> |
rotate_autonomous_database_encryption_key | exec | autonomousDatabaseId, region | if-match, opc-retry-token, opc-request-id | Rotate existing AutonomousDatabase [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key. |
shrink_autonomous_database | exec | autonomousDatabaseId, region | if-match | This operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). The if the base storage value for the database (dataStorageSizeInTBs) is larger than the actualUsedDataStorageSizeInTBs value, you are billed for the base storage value.<br /> |
start_autonomous_database | exec | autonomousDatabaseId, region | if-match | Starts the specified Autonomous AI Database.<br /> |
stop_autonomous_database | exec | autonomousDatabaseId, region | if-match, opc-request-id | Stops the specified Autonomous AI Database.<br /> |
switchover_autonomous_database | exec | autonomousDatabaseId, region | if-match, opc-retry-token, opc-request-id, peerDbId | Initiates a switchover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled.<br />This API should be called in the remote region where the peer database resides.<br />Below parameter is optional:<br /> - peerDbId<br /> Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database.<br /> If this parameter is not provided, the switchover will happen in the same region.<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
autonomousDatabaseId | string | The database [OCID](/Content/General/Concepts/identifiers.htm). |
compartmentId | string | The compartment [OCID](/Content/General/Concepts/identifiers.htm). |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
autonomousContainerDatabaseId | string | The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). |
dbVersion | string | A filter to return only Autonomous AI Database resources that match the specified dbVersion. |
dbWorkload | string | A filter to return only Autonomous AI Database resources that match the specified workload type. |
displayName | string | A filter to return only resources that match the entire display name given. The match is not case sensitive. |
if-match | string | For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
infrastructureType | string | A filter to return only resources that match the given Infrastructure Type. |
isDataGuardEnabled | boolean | A filter to return only resources that have Data Guard enabled. |
isFreeTier | boolean | Filter on the value of the resource's 'isFreeTier' property. A value of true returns only Always Free resources. A value of false excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources. |
isOnlineRestart | boolean | If provided, an online restart will be triggered. |
isRefreshableClone | boolean | Filter on the value of the resource's 'isRefreshableClone' property. A value of true returns only refreshable clones. A value of false excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones. |
isResourcePoolLeader | boolean | Filter if the resource is the resource pool leader. A value of true returns only resource pool leader. |
lifecycleState | string | A filter to return only resources that match the given lifecycle state exactly. |
lifecycleStateNotEqualTo | string | A filter to return only resources that not match the given lifecycle state. |
limit | integer | The maximum number of items to return per page. |
mustDeleteAssociatedLongTermBackups | boolean | If set to true, terminating the Autonomous AI Database also deletes its associated long-term backups if the retention lock is not enabled. |
opc-request-id | string | Unique identifier for the request. |
opc-retry-token | string | A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). |
page | string | The pagination token to continue listing from. |
peerDbId | string | The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database. |
resourcePoolLeaderId | string | The database [OCID](/Content/General/Concepts/identifiers.htm) of the resourcepool Leader Autonomous AI Database. |
sortBy | string | The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. |
sortOrder | string | The sort order to use, either ascending (ASC) or descending (DESC). |
SELECT examples​
- get
- list
Gets the details of the specified Autonomous AI Database.<br />
SELECT
id,
accessTypes,
actualUsedDataStorageSizeInTBs,
allocatedStorageSizeInTBs,
apexDetails,
arePrimaryWhitelistedIpsUsed,
autoRefreshFrequencyInSeconds,
autoRefreshPointLagInSeconds,
autonomousContainerDatabaseId,
autonomousMaintenanceScheduleType,
availabilityDomain,
availableUpgradeVersions,
backupConfig,
byolComputeCountLimit,
characterSet,
cloneTableSpaceList,
cloneType,
clusterPlacementGroupId,
compartmentId,
computeCount,
computeModel,
connectionStrings,
connectionUrls,
cpuCoreCount,
customerContacts,
dataSafeStatus,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
databaseEdition,
databaseManagementStatus,
dataguardRegionType,
dbName,
dbToolsDetails,
dbVersion,
dbWorkload,
definedTags,
disasterRecoveryRegionType,
displayName,
encryptionKey,
encryptionKeyHistoryEntry,
failedDataRecoveryInSeconds,
freeformTags,
inMemoryAreaInGBs,
inMemoryPercentage,
infrastructureType,
isAccessControlEnabled,
isAutoScalingEnabled,
isAutoScalingForStorageEnabled,
isBackupRetentionLocked,
isDataGuardEnabled,
isDedicated,
isDevTier,
isFreeTier,
isLocalDataGuardEnabled,
isMtlsConnectionRequired,
isPreview,
isReconnectCloneEnabled,
isRefreshableClone,
isRemoteDataGuardEnabled,
keyHistoryEntry,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyLifecycleDetails,
kmsKeyVersionId,
licenseModel,
lifecycleDetails,
lifecycleState,
localAdgAutoFailoverMaxDataLossLimit,
localDisasterRecoveryType,
localStandbyDb,
longTermBackupSchedule,
maintenanceTargetComponent,
memoryPerOracleComputeUnitInGBs,
ncharacterSet,
netServicesArchitecture,
nextLongTermBackupTimeStamp,
nsgIds,
ocpuCount,
openMode,
operationsInsightsStatus,
peerDbIds,
permissionLevel,
privateEndpoint,
privateEndpointIp,
privateEndpointLabel,
provisionableCpus,
publicConnectionUrls,
publicEndpoint,
refreshableMode,
refreshableStatus,
remoteDisasterRecoveryConfiguration,
resourcePoolLeaderId,
resourcePoolSummary,
role,
scheduledOperations,
securityAttributes,
serviceConsoleUrl,
sourceId,
sqlWebDeveloperUrl,
standbyDb,
standbyWhitelistedIps,
subnetId,
subscriptionId,
supportedRegionsToCloneTo,
systemTags,
timeCreated,
timeDataGuardRoleChanged,
timeDeletionOfFreeAutonomousDatabase,
timeDisasterRecoveryRoleChanged,
timeLocalDataGuardEnabled,
timeMaintenanceBegin,
timeMaintenanceEnd,
timeOfAutoRefreshStart,
timeOfJoiningResourcePool,
timeOfLastFailover,
timeOfLastRefresh,
timeOfLastRefreshPoint,
timeOfLastSwitchover,
timeOfNextRefresh,
timeReclamationOfFreeAutonomousDatabase,
timeUndeleted,
timeUntilReconnectCloneEnabled,
usedDataStorageSizeInGBs,
usedDataStorageSizeInTBs,
vaultId,
whitelistedIps
FROM oci.database.autonomous_databases
WHERE autonomousDatabaseId = '{{ autonomousDatabaseId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;
Gets a list of Autonomous AI Databases based on the query parameters specified.<br />
SELECT
id,
accessTypes,
actualUsedDataStorageSizeInTBs,
allocatedStorageSizeInTBs,
apexDetails,
arePrimaryWhitelistedIpsUsed,
autoRefreshFrequencyInSeconds,
autoRefreshPointLagInSeconds,
autonomousContainerDatabaseId,
autonomousMaintenanceScheduleType,
availabilityDomain,
availableUpgradeVersions,
backupConfig,
byolComputeCountLimit,
characterSet,
cloneTableSpaceList,
cloneType,
clusterPlacementGroupId,
compartmentId,
computeCount,
computeModel,
connectionStrings,
connectionUrls,
cpuCoreCount,
customerContacts,
dataSafeStatus,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
databaseEdition,
databaseManagementStatus,
dataguardRegionType,
dbName,
dbToolsDetails,
dbVersion,
dbWorkload,
definedTags,
disasterRecoveryRegionType,
displayName,
encryptionKey,
encryptionKeyHistoryEntry,
failedDataRecoveryInSeconds,
freeformTags,
inMemoryAreaInGBs,
inMemoryPercentage,
infrastructureType,
isAccessControlEnabled,
isAutoScalingEnabled,
isAutoScalingForStorageEnabled,
isBackupRetentionLocked,
isDataGuardEnabled,
isDedicated,
isDevTier,
isFreeTier,
isLocalDataGuardEnabled,
isMtlsConnectionRequired,
isPreview,
isReconnectCloneEnabled,
isRefreshableClone,
isRemoteDataGuardEnabled,
keyHistoryEntry,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyLifecycleDetails,
kmsKeyVersionId,
licenseModel,
lifecycleDetails,
lifecycleState,
localAdgAutoFailoverMaxDataLossLimit,
localDisasterRecoveryType,
localStandbyDb,
longTermBackupSchedule,
maintenanceTargetComponent,
memoryPerOracleComputeUnitInGBs,
ncharacterSet,
netServicesArchitecture,
nextLongTermBackupTimeStamp,
nsgIds,
ocpuCount,
openMode,
operationsInsightsStatus,
peerDbIds,
permissionLevel,
privateEndpoint,
privateEndpointIp,
privateEndpointLabel,
provisionableCpus,
publicConnectionUrls,
publicEndpoint,
refreshableMode,
refreshableStatus,
remoteDisasterRecoveryConfiguration,
resourcePoolLeaderId,
resourcePoolSummary,
role,
scheduledOperations,
securityAttributes,
serviceConsoleUrl,
sourceId,
sqlWebDeveloperUrl,
standbyDb,
standbyWhitelistedIps,
subnetId,
subscriptionId,
supportedRegionsToCloneTo,
systemTags,
timeCreated,
timeDataGuardRoleChanged,
timeDeletionOfFreeAutonomousDatabase,
timeDisasterRecoveryRoleChanged,
timeLocalDataGuardEnabled,
timeMaintenanceBegin,
timeMaintenanceEnd,
timeOfAutoRefreshStart,
timeOfJoiningResourcePool,
timeOfLastFailover,
timeOfLastRefresh,
timeOfLastRefreshPoint,
timeOfLastSwitchover,
timeOfNextRefresh,
timeReclamationOfFreeAutonomousDatabase,
timeUndeleted,
timeUntilReconnectCloneEnabled,
usedDataStorageSizeInGBs,
usedDataStorageSizeInTBs,
vaultId,
whitelistedIps
FROM oci.database.autonomous_databases
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND autonomousContainerDatabaseId = '{{ autonomousContainerDatabaseId }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND infrastructureType = '{{ infrastructureType }}'
AND lifecycleState = '{{ lifecycleState }}'
AND lifecycleStateNotEqualTo = '{{ lifecycleStateNotEqualTo }}'
AND dbWorkload = '{{ dbWorkload }}'
AND dbVersion = '{{ dbVersion }}'
AND isFreeTier = '{{ isFreeTier }}'
AND displayName = '{{ displayName }}'
AND opc-request-id = '{{ opc-request-id }}'
AND isRefreshableClone = '{{ isRefreshableClone }}'
AND isDataGuardEnabled = '{{ isDataGuardEnabled }}'
AND isResourcePoolLeader = '{{ isResourcePoolLeader }}'
AND resourcePoolLeaderId = '{{ resourcePoolLeaderId }}'
;
INSERT examples​
- create
- Manifest
Creates a new Autonomous AI Database.<br />
INSERT INTO oci.database.autonomous_databases (
adminPassword,
arePrimaryWhitelistedIpsUsed,
autonomousContainerDatabaseId,
autonomousMaintenanceScheduleType,
byolComputeCountLimit,
characterSet,
compartmentId,
computeCount,
computeModel,
cpuCoreCount,
customerContacts,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
databaseEdition,
dbName,
dbToolsDetails,
dbVersion,
dbWorkload,
definedTags,
displayName,
encryptionKey,
freeformTags,
inMemoryPercentage,
isAccessControlEnabled,
isAutoScalingEnabled,
isAutoScalingForStorageEnabled,
isBackupRetentionLocked,
isDataGuardEnabled,
isDedicated,
isDevTier,
isFreeTier,
isLocalDataGuardEnabled,
isMtlsConnectionRequired,
isPreviewVersionWithServiceTermsAccepted,
kmsKeyId,
licenseModel,
ncharacterSet,
nsgIds,
ocpuCount,
privateEndpointIp,
privateEndpointLabel,
resourcePoolLeaderId,
resourcePoolSummary,
scheduledOperations,
secretId,
secretVersionNumber,
securityAttributes,
source,
standbyWhitelistedIps,
subnetId,
subscriptionId,
transportableTablespace,
vaultId,
whitelistedIps,
region,
opc-retry-token,
opc-request-id
)
SELECT
'{{ adminPassword }}',
{{ arePrimaryWhitelistedIpsUsed }},
'{{ autonomousContainerDatabaseId }}',
'{{ autonomousMaintenanceScheduleType }}',
{{ byolComputeCountLimit }},
'{{ characterSet }}',
'{{ compartmentId }}' /* required */,
{{ computeCount }},
'{{ computeModel }}',
{{ cpuCoreCount }},
'{{ customerContacts }}',
{{ dataStorageSizeInGBs }},
{{ dataStorageSizeInTBs }},
'{{ databaseEdition }}',
'{{ dbName }}',
'{{ dbToolsDetails }}',
'{{ dbVersion }}',
'{{ dbWorkload }}',
'{{ definedTags }}',
'{{ displayName }}',
'{{ encryptionKey }}',
'{{ freeformTags }}',
{{ inMemoryPercentage }},
{{ isAccessControlEnabled }},
{{ isAutoScalingEnabled }},
{{ isAutoScalingForStorageEnabled }},
{{ isBackupRetentionLocked }},
{{ isDataGuardEnabled }},
{{ isDedicated }},
{{ isDevTier }},
{{ isFreeTier }},
{{ isLocalDataGuardEnabled }},
{{ isMtlsConnectionRequired }},
{{ isPreviewVersionWithServiceTermsAccepted }},
'{{ kmsKeyId }}',
'{{ licenseModel }}',
'{{ ncharacterSet }}',
'{{ nsgIds }}',
{{ ocpuCount }},
'{{ privateEndpointIp }}',
'{{ privateEndpointLabel }}',
'{{ resourcePoolLeaderId }}',
'{{ resourcePoolSummary }}',
'{{ scheduledOperations }}',
'{{ secretId }}',
{{ secretVersionNumber }},
'{{ securityAttributes }}',
'{{ source }}',
'{{ standbyWhitelistedIps }}',
'{{ subnetId }}',
'{{ subscriptionId }}',
'{{ transportableTablespace }}',
'{{ vaultId }}',
'{{ whitelistedIps }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
accessTypes,
actualUsedDataStorageSizeInTBs,
allocatedStorageSizeInTBs,
apexDetails,
arePrimaryWhitelistedIpsUsed,
autoRefreshFrequencyInSeconds,
autoRefreshPointLagInSeconds,
autonomousContainerDatabaseId,
autonomousMaintenanceScheduleType,
availabilityDomain,
availableUpgradeVersions,
backupConfig,
byolComputeCountLimit,
characterSet,
cloneTableSpaceList,
cloneType,
clusterPlacementGroupId,
compartmentId,
computeCount,
computeModel,
connectionStrings,
connectionUrls,
cpuCoreCount,
customerContacts,
dataSafeStatus,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
databaseEdition,
databaseManagementStatus,
dataguardRegionType,
dbName,
dbToolsDetails,
dbVersion,
dbWorkload,
definedTags,
disasterRecoveryRegionType,
displayName,
encryptionKey,
encryptionKeyHistoryEntry,
failedDataRecoveryInSeconds,
freeformTags,
inMemoryAreaInGBs,
inMemoryPercentage,
infrastructureType,
isAccessControlEnabled,
isAutoScalingEnabled,
isAutoScalingForStorageEnabled,
isBackupRetentionLocked,
isDataGuardEnabled,
isDedicated,
isDevTier,
isFreeTier,
isLocalDataGuardEnabled,
isMtlsConnectionRequired,
isPreview,
isReconnectCloneEnabled,
isRefreshableClone,
isRemoteDataGuardEnabled,
keyHistoryEntry,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyLifecycleDetails,
kmsKeyVersionId,
licenseModel,
lifecycleDetails,
lifecycleState,
localAdgAutoFailoverMaxDataLossLimit,
localDisasterRecoveryType,
localStandbyDb,
longTermBackupSchedule,
maintenanceTargetComponent,
memoryPerOracleComputeUnitInGBs,
ncharacterSet,
netServicesArchitecture,
nextLongTermBackupTimeStamp,
nsgIds,
ocpuCount,
openMode,
operationsInsightsStatus,
peerDbIds,
permissionLevel,
privateEndpoint,
privateEndpointIp,
privateEndpointLabel,
provisionableCpus,
publicConnectionUrls,
publicEndpoint,
refreshableMode,
refreshableStatus,
remoteDisasterRecoveryConfiguration,
resourcePoolLeaderId,
resourcePoolSummary,
role,
scheduledOperations,
securityAttributes,
serviceConsoleUrl,
sourceId,
sqlWebDeveloperUrl,
standbyDb,
standbyWhitelistedIps,
subnetId,
subscriptionId,
supportedRegionsToCloneTo,
systemTags,
timeCreated,
timeDataGuardRoleChanged,
timeDeletionOfFreeAutonomousDatabase,
timeDisasterRecoveryRoleChanged,
timeLocalDataGuardEnabled,
timeMaintenanceBegin,
timeMaintenanceEnd,
timeOfAutoRefreshStart,
timeOfJoiningResourcePool,
timeOfLastFailover,
timeOfLastRefresh,
timeOfLastRefreshPoint,
timeOfLastSwitchover,
timeOfNextRefresh,
timeReclamationOfFreeAutonomousDatabase,
timeUndeleted,
timeUntilReconnectCloneEnabled,
usedDataStorageSizeInGBs,
usedDataStorageSizeInTBs,
vaultId,
whitelistedIps
;
# Description fields are for documentation purposes
- name: autonomous_databases
props:
- name: region
value: "{{ region }}"
description: Required parameter for the autonomous_databases resource.
- name: adminPassword
value: "{{ adminPassword }}"
description: |
**Important** The `adminPassword` or `secretId` must be specified for all Autonomous AI Databases except for refreshable clones. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing.
This cannot be used in conjunction with with OCI vault secrets (secretId).
- name: arePrimaryWhitelistedIpsUsed
value: {{ arePrimaryWhitelistedIpsUsed }}
description: |
This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled.
It's value would be `TRUE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses primary IP access control list (ACL) for standby.
It's value would be `FALSE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses different IP access control list (ACL) for standby compared to primary.
- name: autonomousContainerDatabaseId
value: "{{ autonomousContainerDatabaseId }}"
description: |
The Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm). Used only by Autonomous AI Database on Dedicated Exadata Infrastructure.
- name: autonomousMaintenanceScheduleType
value: "{{ autonomousMaintenanceScheduleType }}"
description: |
The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule
follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle
valid_values: ['EARLY', 'REGULAR']
- name: byolComputeCountLimit
value: {{ byolComputeCountLimit }}
description: |
The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed.
- name: characterSet
value: "{{ characterSet }}"
description: |
The character set for the Autonomous AI Database. The default is AL32UTF8. Allowed values for an Autonomous AI Database Serverless instance as as returned by [List Autonomous AI Database Character Sets](https://docs.oracle.com/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html)
For an Autonomous AI Database on dedicated infrastructure, the 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
- name: compartmentId
value: "{{ compartmentId }}"
description: |
The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment of the Autonomous AI Database.
- name: computeCount
value: {{ computeCount }}
description: |
The compute amount (CPUs) available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure.
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 `computeModel` parameter. When using `cpuCoreCount` parameter, it is an error to specify computeCount to a non-null value. Providing `computeModel` and `computeCount` is the preferred method for both OCPU and ECPU.
- name: computeModel
value: "{{ computeModel }}"
description: |
The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database.
valid_values: ['ECPU', 'OCPU']
- name: cpuCoreCount
value: {{ cpuCoreCount }}
description: |
The number of CPU cores to be made available to the database. For Autonomous AI 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/) for shape details.
**Note:** This parameter cannot be used with the `ocpuCount` parameter.
- name: customerContacts
description: |
Customer Contacts.
value:
- email: "{{ email }}"
- name: dataStorageSizeInGBs
value: {{ dataStorageSizeInGBs }}
description: |
The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details.
**Notes**
- This parameter is only supported for dedicated Exadata infrastructure.
- This parameter cannot be used with the `dataStorageSizeInTBs` parameter.
- name: dataStorageSizeInTBs
value: {{ dataStorageSizeInTBs }}
description: |
The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous AI Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details.
A full Exadata service is allocated when the Autonomous AI Database size is set to the upper limit (384 TB).
**Note:** This parameter cannot be used with the `dataStorageSizeInGBs` parameter.
- name: databaseEdition
value: "{{ databaseEdition }}"
description: |
The Oracle AI Database Edition that applies to the Autonomous AI Databases. This parameter accepts options `STANDARD_EDITION` and `ENTERPRISE_EDITION`.
- name: dbName
value: "{{ dbName }}"
description: |
The database name. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.
- name: dbToolsDetails
description: |
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.
value:
- isEnabled: {{ isEnabled }}
name: "{{ name }}"
- name: dbVersion
value: "{{ dbVersion }}"
description: |
A valid Oracle AI Database version for Autonomous AI Database.
When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai.
When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected.
For new databases, it is recommended to use either 19c or 26ai.
**Note** Starting December 2026, 23ai will not be supported as a valid value for this parameter.
- name: dbWorkload
value: "{{ dbWorkload }}"
description: |
The Autonomous AI Database workload type. The following values are valid:
- OLTP - indicates an Autonomous AI Transaction Processing database
- DW - indicates an Autonomous AI Lakehouse database
- AJD - indicates an Autonomous AI JSON Database
- APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type.
- LH - indicates an Oracle Autonomous AI Lakehouse database
**Note** Starting December 2026, DW will not be supported as a valid value for this parameter.
When creating an Autonomous AI Database, if this parameter is not specified, the default value is `OLTP`.
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.
valid_values: ['OLTP', 'DW', 'AJD', 'APEX', 'LH']
- name: definedTags
value: "{{ definedTags }}"
description: |
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
- name: displayName
value: "{{ displayName }}"
description: |
The user-friendly name for the Autonomous AI Database. The name does not have to be unique.
- name: encryptionKey
description: |
Details of the Autonomous AI Database encryption key.
value:
provider: "{{ provider }}"
- name: freeformTags
value: "{{ freeformTags }}"
description: |
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](/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
- name: inMemoryPercentage
value: {{ inMemoryPercentage }}
description: |
The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform.
default: 0
- name: isAccessControlEnabled
value: {{ isAccessControlEnabled }}
description: |
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 `whitelistedIps` property. While specifying `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 `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 AI Databases on the Exadata Cloud@Customer platform. For Autonomous AI Database Serverless instances, `whitelistedIps` is used.
- name: isAutoScalingEnabled
value: {{ isAutoScalingEnabled }}
description: |
Indicates if auto scaling is enabled for the Autonomous AI Database CPU core count. The default value is `TRUE`.
default: false
- name: isAutoScalingForStorageEnabled
value: {{ isAutoScalingForStorageEnabled }}
description: |
Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is `FALSE`.
- name: isBackupRetentionLocked
value: {{ isBackupRetentionLocked }}
description: |
True if the Autonomous AI Database is backup retention locked.
- name: isDataGuardEnabled
value: {{ isDataGuardEnabled }}
description: |
**Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- name: isDedicated
value: {{ isDedicated }}
description: |
True if the database is on [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html).
- name: isDevTier
value: {{ isDevTier }}
description: |
Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database.
default: false
- name: isFreeTier
value: {{ isFreeTier }}
description: |
Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI 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
default: false
- name: isLocalDataGuardEnabled
value: {{ isLocalDataGuardEnabled }}
description: |
Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- name: isMtlsConnectionRequired
value: {{ isMtlsConnectionRequired }}
description: |
Specifies if the Autonomous AI 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 AI 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.
- name: isPreviewVersionWithServiceTermsAccepted
value: {{ isPreviewVersionWithServiceTermsAccepted }}
description: |
If set to `TRUE`, indicates that an Autonomous AI Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for Autonomous AI Database Serverless instances (https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/).
default: false
- name: kmsKeyId
value: "{{ kmsKeyId }}"
description: |
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- name: licenseModel
value: "{{ licenseModel }}"
description: |
The Oracle license model that applies to the Oracle Autonomous AI 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 AI Database software licenses and the Oracle AI Database service.
Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the
Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI 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 `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.
valid_values: ['LICENSE_INCLUDED', 'BRING_YOUR_OWN_LICENSE']
- name: ncharacterSet
value: "{{ ncharacterSet }}"
description: |
The character set for the Autonomous AI Database. The default is AL32UTF8. Use [List Autonomous AI Database Character Sets](https://docs.oracle.com/iaas/autonomous-database-serverless/doc/autonomous-character-set-selection.html) to list the allowed values for an Autonomous AI Database Serverless instance.
For an Autonomous AI Database on dedicated Exadata infrastructure, the allowed values are:
AL16UTF16 or UTF8.
- name: nsgIds
value:
- "{{ nsgIds }}"
description: |
The list of [OCIDs](/Content/General/Concepts/identifiers.htm) 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](/Content/Network/Concepts/securityrules.htm).
- name: ocpuCount
value: {{ ocpuCount }}
description: |
The number of OCPU cores to be made available to the database.
The following points apply:
- For Autonomous AI 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 AI Database Serverless instances.)
- To provision 1 or more cores, you must 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 an Autonomous AI Database Serverless instance or an Autonomous AI Database on Dedicated Exadata Infrastructure.
- For Autonomous AI Database Serverless instances, this parameter is not used.
For Autonomous AI 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/) for shape details.
**Note:** This parameter cannot be used with the `cpuCoreCount` parameter.
- name: privateEndpointIp
value: "{{ privateEndpointIp }}"
description: |
The private endpoint Ip address for the resource.
- name: privateEndpointLabel
value: "{{ privateEndpointLabel }}"
description: |
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.
- name: resourcePoolLeaderId
value: "{{ resourcePoolLeaderId }}"
description: |
The unique identifier for leader Autonomous AI Database OCID [OCID](/Content/General/Concepts/identifiers.htm).
- name: resourcePoolSummary
description: |
The configuration details for resource pool
value:
availableComputeCapacity: {{ availableComputeCapacity }}
isDisabled: {{ isDisabled }}
poolSize: {{ poolSize }}
totalComputeCapacity: {{ totalComputeCapacity }}
- name: scheduledOperations
description: |
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.
value:
- dayOfWeek:
name: "{{ name }}"
scheduledStartTime: "{{ scheduledStartTime }}"
scheduledStopTime: "{{ scheduledStopTime }}"
- name: secretId
value: "{{ secretId }}"
description: |
The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
- name: secretVersionNumber
value: {{ secretVersionNumber }}
description: |
The version of the vault secret. If no version is specified, the latest version will be used.
- name: securityAttributes
value: "{{ securityAttributes }}"
description: |
Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
- name: source
value: "{{ source }}"
description: |
The source of the database: Use `NONE` for creating a new Autonomous AI Database. Use `DATABASE` for creating a new Autonomous AI Database by cloning an existing Autonomous AI Database. Use `CROSS_REGION_DATAGUARD` to create a standby Data Guard database in another region.
For [Autonomous AI Database Serverless instances](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/), the following cloning options are available: Use `BACKUP_FROM_ID` for creating a new Autonomous AI Database from a specified backup. Use `BACKUP_FROM_TIMESTAMP` for creating a point-in-time Autonomous AI Database clone using backups. For more information, see [Cloning and Moving an Autonomous AI Database](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/clone-autonomous-database.html#GUID-D771796F-5081-4CFB-A7FF-0F893EABD7BC).
valid_values: ['NONE', 'DATABASE', 'BACKUP_FROM_ID', 'BACKUP_FROM_TIMESTAMP', 'UNDELETE_ADB', 'CLONE_TO_REFRESHABLE', 'CROSS_REGION_DATAGUARD', 'CROSS_REGION_DISASTER_RECOVERY']
default: NONE
- name: standbyWhitelistedIps
value:
- "{{ standbyWhitelistedIps }}"
description: |
The client IP access control list (ACL). This feature is available for [Autonomous AI 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 AI Database instance.
If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`.
For Autonomous AI 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’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter.
Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]`
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations.
Example: `["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.
- name: subnetId
value: "{{ subnetId }}"
description: |
The [OCID](/Content/General/Concepts/identifiers.htm) 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 AI 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.
- name: subscriptionId
value: "{{ subscriptionId }}"
description: |
The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
- name: transportableTablespace
description: |
Details for importing transportable tablespace for an Autonomous AI Database.
value:
ttsBundleUrl: "{{ ttsBundleUrl }}"
- name: vaultId
value: "{{ vaultId }}"
description: |
The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys.
- name: whitelistedIps
value:
- "{{ whitelistedIps }}"
description: |
The client IP access control list (ACL). This feature is available for [Autonomous AI 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 AI Database instance.
If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`.
For Autonomous AI 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’s other configurations that need multiple pieces of information then its each piece is connected with semicolon (;) as a delimiter.
Example: `["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]`
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations.
Example: `["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.
- name: opc-retry-token
value: "{{ opc-retry-token }}"
description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
- name: opc-request-id
value: "{{ opc-request-id }}"
description: Unique identifier for the request.
description: Unique identifier for the request.
UPDATE examples​
- update
Updates one or more attributes of the specified Autonomous AI Database. See the UpdateAutonomousDatabaseDetails resource for a full list of attributes that can be updated.<br />
UPDATE oci.database.autonomous_databases
SET
adminPassword = '{{ adminPassword }}',
arePrimaryWhitelistedIpsUsed = {{ arePrimaryWhitelistedIpsUsed }},
autoRefreshFrequencyInSeconds = {{ autoRefreshFrequencyInSeconds }},
autoRefreshPointLagInSeconds = {{ autoRefreshPointLagInSeconds }},
autonomousMaintenanceScheduleType = '{{ autonomousMaintenanceScheduleType }}',
backupRetentionPeriodInDays = {{ backupRetentionPeriodInDays }},
byolComputeCountLimit = {{ byolComputeCountLimit }},
computeCount = {{ computeCount }},
computeModel = '{{ computeModel }}',
cpuCoreCount = {{ cpuCoreCount }},
customerContacts = '{{ customerContacts }}',
dataStorageSizeInGBs = {{ dataStorageSizeInGBs }},
dataStorageSizeInTBs = {{ dataStorageSizeInTBs }},
databaseEdition = '{{ databaseEdition }}',
dbName = '{{ dbName }}',
dbToolsDetails = '{{ dbToolsDetails }}',
dbVersion = '{{ dbVersion }}',
dbWorkload = '{{ dbWorkload }}',
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
encryptionKey = '{{ encryptionKey }}',
freeformTags = '{{ freeformTags }}',
inMemoryPercentage = {{ inMemoryPercentage }},
isAccessControlEnabled = {{ isAccessControlEnabled }},
isAutoScalingEnabled = {{ isAutoScalingEnabled }},
isAutoScalingForStorageEnabled = {{ isAutoScalingForStorageEnabled }},
isBackupRetentionLocked = {{ isBackupRetentionLocked }},
isDataGuardEnabled = {{ isDataGuardEnabled }},
isDevTier = {{ isDevTier }},
isDisconnectPeer = {{ isDisconnectPeer }},
isFreeTier = {{ isFreeTier }},
isLocalDataGuardEnabled = {{ isLocalDataGuardEnabled }},
isMtlsConnectionRequired = {{ isMtlsConnectionRequired }},
isRefreshableClone = {{ isRefreshableClone }},
isSqlWebDeveloperEnabled = {{ isSqlWebDeveloperEnabled }},
licenseModel = '{{ licenseModel }}',
localAdgAutoFailoverMaxDataLossLimit = {{ localAdgAutoFailoverMaxDataLossLimit }},
longTermBackupSchedule = '{{ longTermBackupSchedule }}',
nsgIds = '{{ nsgIds }}',
ocpuCount = {{ ocpuCount }},
openMode = '{{ openMode }}',
peerDbId = '{{ peerDbId }}',
permissionLevel = '{{ permissionLevel }}',
privateEndpointIp = '{{ privateEndpointIp }}',
privateEndpointLabel = '{{ privateEndpointLabel }}',
refreshableMode = '{{ refreshableMode }}',
resourcePoolLeaderId = '{{ resourcePoolLeaderId }}',
resourcePoolSummary = '{{ resourcePoolSummary }}',
scheduledOperations = '{{ scheduledOperations }}',
secretId = '{{ secretId }}',
secretVersionNumber = {{ secretVersionNumber }},
securityAttributes = '{{ securityAttributes }}',
standbyWhitelistedIps = '{{ standbyWhitelistedIps }}',
subnetId = '{{ subnetId }}',
timeOfAutoRefreshStart = '{{ timeOfAutoRefreshStart }}',
whitelistedIps = '{{ whitelistedIps }}'
WHERE
autonomousDatabaseId = '{{ autonomousDatabaseId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
accessTypes,
actualUsedDataStorageSizeInTBs,
allocatedStorageSizeInTBs,
apexDetails,
arePrimaryWhitelistedIpsUsed,
autoRefreshFrequencyInSeconds,
autoRefreshPointLagInSeconds,
autonomousContainerDatabaseId,
autonomousMaintenanceScheduleType,
availabilityDomain,
availableUpgradeVersions,
backupConfig,
byolComputeCountLimit,
characterSet,
cloneTableSpaceList,
cloneType,
clusterPlacementGroupId,
compartmentId,
computeCount,
computeModel,
connectionStrings,
connectionUrls,
cpuCoreCount,
customerContacts,
dataSafeStatus,
dataStorageSizeInGBs,
dataStorageSizeInTBs,
databaseEdition,
databaseManagementStatus,
dataguardRegionType,
dbName,
dbToolsDetails,
dbVersion,
dbWorkload,
definedTags,
disasterRecoveryRegionType,
displayName,
encryptionKey,
encryptionKeyHistoryEntry,
failedDataRecoveryInSeconds,
freeformTags,
inMemoryAreaInGBs,
inMemoryPercentage,
infrastructureType,
isAccessControlEnabled,
isAutoScalingEnabled,
isAutoScalingForStorageEnabled,
isBackupRetentionLocked,
isDataGuardEnabled,
isDedicated,
isDevTier,
isFreeTier,
isLocalDataGuardEnabled,
isMtlsConnectionRequired,
isPreview,
isReconnectCloneEnabled,
isRefreshableClone,
isRemoteDataGuardEnabled,
keyHistoryEntry,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyLifecycleDetails,
kmsKeyVersionId,
licenseModel,
lifecycleDetails,
lifecycleState,
localAdgAutoFailoverMaxDataLossLimit,
localDisasterRecoveryType,
localStandbyDb,
longTermBackupSchedule,
maintenanceTargetComponent,
memoryPerOracleComputeUnitInGBs,
ncharacterSet,
netServicesArchitecture,
nextLongTermBackupTimeStamp,
nsgIds,
ocpuCount,
openMode,
operationsInsightsStatus,
peerDbIds,
permissionLevel,
privateEndpoint,
privateEndpointIp,
privateEndpointLabel,
provisionableCpus,
publicConnectionUrls,
publicEndpoint,
refreshableMode,
refreshableStatus,
remoteDisasterRecoveryConfiguration,
resourcePoolLeaderId,
resourcePoolSummary,
role,
scheduledOperations,
securityAttributes,
serviceConsoleUrl,
sourceId,
sqlWebDeveloperUrl,
standbyDb,
standbyWhitelistedIps,
subnetId,
subscriptionId,
supportedRegionsToCloneTo,
systemTags,
timeCreated,
timeDataGuardRoleChanged,
timeDeletionOfFreeAutonomousDatabase,
timeDisasterRecoveryRoleChanged,
timeLocalDataGuardEnabled,
timeMaintenanceBegin,
timeMaintenanceEnd,
timeOfAutoRefreshStart,
timeOfJoiningResourcePool,
timeOfLastFailover,
timeOfLastRefresh,
timeOfLastRefreshPoint,
timeOfLastSwitchover,
timeOfNextRefresh,
timeReclamationOfFreeAutonomousDatabase,
timeUndeleted,
timeUntilReconnectCloneEnabled,
usedDataStorageSizeInGBs,
usedDataStorageSizeInTBs,
vaultId,
whitelistedIps;
DELETE examples​
- delete
Deletes the specified Autonomous AI Database.<br />
DELETE FROM oci.database.autonomous_databases
WHERE autonomousDatabaseId = '{{ autonomousDatabaseId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
AND mustDeleteAssociatedLongTermBackups = '{{ mustDeleteAssociatedLongTermBackups }}'
;
Lifecycle Methods​
- resource_pool_shapes
- change_compartment
- change_disaster_recovery_configuration
- change_autonomous_database_subscription
- configure_autonomous_database_vault_key
- configure_saas_admin_user
- deregister_autonomous_database_data_safe
- disable_autonomous_database_management
- disable_autonomous_database_operations_insights
- enable_autonomous_database_management
- enable_autonomous_database_operations_insights
- fail_over_autonomous_database
- generate_autonomous_database_wallet
- saas_admin_user_status
- import_transportable_tablespace
- autonomous_database_manual_refresh
- register_autonomous_database_data_safe
- restart_autonomous_database
- restore_autonomous_database
- rotate_autonomous_database_encryption_key
- shrink_autonomous_database
- start_autonomous_database
- stop_autonomous_database
- switchover_autonomous_database
Lists available resource pools shapes.
EXEC oci.database.autonomous_databases.resource_pool_shapes
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-retry-token='{{ opc-retry-token }}',
@limit='{{ limit }}',
@page='{{ page }}',
@opc-request-id='{{ opc-request-id }}'
;
Move the Autonomous AI Database and its dependent resources to the specified compartment.<br />For more information about moving Autonomous AI Databases, see<br />[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).<br />
EXEC oci.database.autonomous_databases.change_compartment
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@if-match='{{ if-match }}'
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;
This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous AI Database Serverless database, and must be run on the standby side.
EXEC oci.database.autonomous_databases.change_disaster_recovery_configuration
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-request-id='{{ opc-request-id }}'
@@json=
'{
"disasterRecoveryType": "{{ disasterRecoveryType }}",
"isReplicateAutomaticBackups": {{ isReplicateAutomaticBackups }},
"isSnapshotStandby": {{ isSnapshotStandby }},
"timeSnapshotStandbyEnabledTill": "{{ timeSnapshotStandbyEnabledTill }}"
}'
;
Associate an Autonomous AI Database with a different subscription.<br />
EXEC oci.database.autonomous_databases.change_autonomous_database_subscription
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@if-match='{{ if-match }}'
@@json=
'{
"isDefault": {{ isDefault }},
"subscriptionId": "{{ subscriptionId }}"
}'
;
Configures the Autonomous AI Database Vault service [key](/Content/KeyManagement/Concepts/keyoverview.htm#concepts).<br />
EXEC oci.database.autonomous_databases.configure_autonomous_database_vault_key
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-request-id='{{ opc-request-id }}',
@opc-retry-token='{{ opc-retry-token }}'
@@json=
'{
"isUsingOracleManagedKeys": {{ isUsingOracleManagedKeys }},
"kmsKeyId": "{{ kmsKeyId }}",
"vaultId": "{{ vaultId }}"
}'
;
This operation updates SaaS administrative user configuration of the Autonomous AI Database.
EXEC oci.database.autonomous_databases.configure_saas_admin_user
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-request-id='{{ opc-request-id }}'
@@json=
'{
"accessType": "{{ accessType }}",
"isEnabled": {{ isEnabled }},
"timeSaasAdminUserEnabled": "{{ timeSaasAdminUserEnabled }}",
"duration": {{ duration }},
"password": "{{ password }}",
"secretId": "{{ secretId }}",
"secretVersionNumber": {{ secretVersionNumber }}
}'
;
Asynchronously deregisters this Autonomous AI Database with Data Safe.<br />
EXEC oci.database.autonomous_databases.deregister_autonomous_database_data_safe
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}'
@@json=
'{
"pdbAdminPassword": "{{ pdbAdminPassword }}"
}'
;
Disables Database Management for the Autonomous AI Database resource.<br />
EXEC oci.database.autonomous_databases.disable_autonomous_database_management
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}'
;
Disables Operations Insights for the Autonomous AI Database resource.<br />
EXEC oci.database.autonomous_databases.disable_autonomous_database_operations_insights
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}'
;
Enables Database Management for Autonomous AI Database.<br />
EXEC oci.database.autonomous_databases.enable_autonomous_database_management
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}'
;
Enables the specified Autonomous AI Database with Operations Insights.<br />
EXEC oci.database.autonomous_databases.enable_autonomous_database_operations_insights
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}'
;
Initiates a failover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled.<br />This API should be called in the remote region where the peer database resides.<br />Below parameter is optional:<br /> - peerDbId<br /> Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database.<br /> If this parameter is not provided, the failover will happen in the same region.<br />
EXEC oci.database.autonomous_databases.fail_over_autonomous_database
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@peerDbId='{{ peerDbId }}'
;
Creates and downloads a wallet for the specified Autonomous AI Database.<br />
EXEC oci.database.autonomous_databases.generate_autonomous_database_wallet
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}',
@opc-retry-token='{{ opc-retry-token }}'
@@json=
'{
"generateType": "{{ generateType }}",
"isRegional": {{ isRegional }},
"password": "{{ password }}"
}'
;
This operation gets SaaS administrative user status of the Autonomous AI Database.
EXEC oci.database.autonomous_databases.saas_admin_user_status
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}'
;
Imports transportable tablespace for the specified Autonomous AI Database.<br />
EXEC oci.database.autonomous_databases.import_transportable_tablespace
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}'
@@json=
'{
"ttsBundleUrl": "{{ ttsBundleUrl }}"
}'
;
Initiates a data refresh for an Autonomous AI Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.<br />
EXEC oci.database.autonomous_databases.autonomous_database_manual_refresh
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}'
@@json=
'{
"timeRefreshCutoff": "{{ timeRefreshCutoff }}"
}'
;
Asynchronously registers this Autonomous AI Database with Data Safe.<br />
EXEC oci.database.autonomous_databases.register_autonomous_database_data_safe
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}'
@@json=
'{
"pdbAdminPassword": "{{ pdbAdminPassword }}"
}'
;
Restarts the specified Autonomous AI Database.<br />
EXEC oci.database.autonomous_databases.restart_autonomous_database
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@isOnlineRestart={{ isOnlineRestart }}
@@json=
'{
"isForceRestart": {{ isForceRestart }}
}'
;
Restores an Autonomous AI Database based on the provided request parameters.<br />
EXEC oci.database.autonomous_databases.restore_autonomous_database
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}'
@@json=
'{
"databaseSCN": "{{ databaseSCN }}",
"latest": {{ latest }},
"timestamp": "{{ timestamp }}"
}'
;
Rotate existing AutonomousDatabase Vault service key.
EXEC oci.database.autonomous_databases.rotate_autonomous_database_encryption_key
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}'
@@json=
'{
"keyVersionId": "{{ keyVersionId }}"
}'
;
This operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). The if the base storage value for the database (dataStorageSizeInTBs) is larger than the actualUsedDataStorageSizeInTBs value, you are billed for the base storage value.<br />
EXEC oci.database.autonomous_databases.shrink_autonomous_database
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}'
;
Starts the specified Autonomous AI Database.<br />
EXEC oci.database.autonomous_databases.start_autonomous_database
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}'
;
Stops the specified Autonomous AI Database.<br />
EXEC oci.database.autonomous_databases.stop_autonomous_database
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-request-id='{{ opc-request-id }}'
@@json=
'{
"isForceStop": {{ isForceStop }}
}'
;
Initiates a switchover of the specified Autonomous AI Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled.<br />This API should be called in the remote region where the peer database resides.<br />Below parameter is optional:<br /> - peerDbId<br /> Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database.<br /> If this parameter is not provided, the switchover will happen in the same region.<br />
EXEC oci.database.autonomous_databases.switchover_autonomous_database
@autonomousDatabaseId='{{ autonomousDatabaseId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@peerDbId='{{ peerDbId }}'
;