autonomous_container_databases

Creates, updates, deletes, gets or lists an autonomous_container_databases resource.

Overview

Name	`autonomous_container_databases`
Type	Resource
Id	`oci.database.autonomous_container_databases`

Fields

The following fields are returned by SELECT queries:

get
list

The Autonomous Container Database.

Name	Datatype	Description
`id`	`string`	The OCID of the Autonomous Container Database.
`associatedBackupConfigurationDetails`	`array`	A backup config object holds information about preferred backup destinations only. This object holds information about the associated backup destinations, such as secondary backup destinations created for local backups or remote replicated backups.
`autonomousExadataInfrastructureId`	`string`	No longer used. For Autonomous AI Database on dedicated Exadata infrastructure, the container database is created within a specified `cloudAutonomousVmCluster`.
`autonomousVmClusterId`	`string`	The OCID of the Autonomous VM Cluster.
`availabilityDomain`	`string`	The availability domain of the Autonomous Container Database.
`availableCpus`	`number (float)`	Sum of CPUs available on the Autonomous VM Cluster + Sum of reclaimable CPUs available in the Autonomous Container Database.
`backupConfig`	`object`	Backup options for the Autonomous Container Database.
`backupDestinationPropertiesList`	`array`	This list describes the backup destination properties associated with the Autonomous Container Database (ACD) 's preferred backup destination. The object at a given index is associated with the destination present at the same index in the backup destination details list of the ACD Backup Configuration.
`cloudAutonomousVmClusterId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster.
`compartmentId`	`string`	The OCID of the compartment.
`computeModel`	`string`	The compute model of the Autonomous Container Database. For Autonomous AI Database on Dedicated Exadata Infrastructure, the CPU type (ECPUs or OCPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous AI Database on Dedicated Exadata Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. (ECPU, OCPU)
`customerContacts`	`array`	Customer Contacts. Setting this to an empty list removes all customer contacts.
`dataguard`	`object`	The properties that define Autonomous Container Databases Dataguard.
`dataguardGroupMembers`	`array`	Array of Dg associations.
`dbName`	`string`	The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters.
`dbSplitThreshold`	`integer`	The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs.
`dbUniqueName`	`string`	Deprecated. The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.
`dbVersion`	`string`	Oracle AI Database version of the Autonomous Container Database.
`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).
`displayName`	`string`	The user-provided name for the Autonomous Container Database.
`distributionAffinity`	`string`	Determines whether an Autonomous AI Database must be opened across the maximum number of nodes or the least number of nodes. By default, Minimum nodes is selected. (MINIMUM_DISTRIBUTION, MAXIMUM_DISTRIBUTION)
`dstFileVersion`	`string`	DST Time-Zone File version of the Autonomous Container Database.
`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"}`
`infrastructureType`	`string`	The infrastructure type this resource belongs to. (CLOUD, CLOUD_AT_CUSTOMER)
`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.
`isDstFileUpdateEnabled`	`boolean`	Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner.
`isMultipleStandby`	`boolean`	Indicates if it is multiple standby Autonomous Dataguard
`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.
`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.
`largestProvisionableAutonomousDatabaseInCpus`	`number (float)`	The largest Autonomous AI Database (CPU) that can be created in a new Autonomous Container Database.
`lastMaintenanceRunId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run.
`lifecycleDetails`	`string`	Additional information about the current lifecycle state.
`lifecycleState`	`string`	The current state of the Autonomous Container Database. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, BACKUP_IN_PROGRESS, RESTORING, RESTORE_FAILED, RESTARTING, MAINTENANCE_IN_PROGRESS, ROLE_CHANGE_IN_PROGRESS, ENABLING_AUTONOMOUS_DATA_GUARD, UNAVAILABLE)
`listOneOffPatches`	`array`	List of One-Off patches that has been successfully applied to Autonomous Container Database
`maintenanceWindow`	`object`	The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
`memoryPerOracleComputeUnitInGBs`	`integer`	The amount of memory (in GBs) enabled per ECPU or OCPU in the Autonomous VM Cluster.
`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, DRCP) (default: DEDICATED)
`nextMaintenanceRunId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run.
`okvEndPointGroupName`	`string`	The OKV End Point Group name for the Autonomous Container Database.
`patchId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch applied on the system.
`patchModel`	`string`	Database patch model preference. (RELEASE_UPDATES, RELEASE_UPDATE_REVISIONS)
`provisionableCpus`	`array`	An array of CPU values that can be used to successfully provision a single Autonomous AI Database.
`provisionedCpus`	`number (float)`	The number of CPUs provisioned in an Autonomous Container Database.
`reclaimableCpus`	`number (float)`	CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database.
`recoveryApplianceDetails`	`object`	Information about the recovery appliance configuration associated with the Autonomous Container Database.
`reservedCpus`	`number (float)`	The number of CPUs reserved in an Autonomous Container Database.
`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)
`serviceLevelAgreementType`	`string`	The service level agreement type of the container database. The default is STANDARD. (STANDARD, MISSION_CRITICAL, AUTONOMOUS_DATAGUARD)
`standbyMaintenanceBufferInDays`	`integer`	The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary 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 Container Database was created.
`timeOfLastBackup`	`string (date-time)`	The timestamp of last successful backup. Here NULL value represents either there are no successful backups or backups are not configured for this Autonomous Container Database.
`timeSnapshotStandbyRevert`	`string (date-time)`	The date and time the Autonomous Container Database will be reverted to Standby from Snapshot Standby.
`totalCpus`	`integer`	The number of CPUs allocated to the Autonomous VM cluster.
`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.
`versionPreference`	`string`	The next maintenance version preference. (NEXT_RELEASE_UPDATE, LATEST_RELEASE_UPDATE) (default: NEXT_RELEASE_UPDATE)
`vmFailoverReservation`	`integer`	The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option.

An Autonomous Container Database is a container database service that enables the customer to host one or more databases within the container database. A basic container database runs on a single Autonomous Exadata Infrastructure from an availability domain without the Extreme Availability features enabled.

Name	Datatype	Description
`id`	`string`	The OCID of the Autonomous Container Database.
`associatedBackupConfigurationDetails`	`array`	A backup config object holds information about preferred backup destinations only. This object holds information about the associated backup destinations, such as secondary backup destinations created for local backups or remote replicated backups.
`autonomousExadataInfrastructureId`	`string`	No longer used. For Autonomous AI Database on dedicated Exadata infrastructure, the container database is created within a specified `cloudAutonomousVmCluster`.
`autonomousVmClusterId`	`string`	The OCID of the Autonomous VM Cluster.
`availabilityDomain`	`string`	The availability domain of the Autonomous Container Database.
`availableCpus`	`number (float)`	Sum of CPUs available on the Autonomous VM Cluster + Sum of reclaimable CPUs available in the Autonomous Container Database.
`backupConfig`	`object`	Backup options for the Autonomous Container Database.
`backupDestinationPropertiesList`	`array`	This list describes the backup destination properties associated with the Autonomous Container Database (ACD) 's preferred backup destination. The object at a given index is associated with the destination present at the same index in the backup destination details list of the ACD Backup Configuration.
`cloudAutonomousVmClusterId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster.
`compartmentId`	`string`	The OCID of the compartment.
`computeModel`	`string`	The compute model of the Autonomous Container Database. For Autonomous AI Database on Dedicated Exadata Infrastructure, the CPU type (ECPUs or OCPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous AI Database on Dedicated Exadata Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. (ECPU, OCPU)
`customerContacts`	`array`	Customer Contacts. Setting this to an empty list removes all customer contacts.
`dataguard`	`object`	The properties that define Autonomous Container Databases Dataguard.
`dataguardGroupMembers`	`array`	Array of Dg associations.
`dbName`	`string`	The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters.
`dbSplitThreshold`	`integer`	The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs.
`dbUniqueName`	`string`	Deprecated. The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.
`dbVersion`	`string`	Oracle AI Database version of the Autonomous Container Database.
`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).
`displayName`	`string`	The user-provided name for the Autonomous Container Database.
`distributionAffinity`	`string`	Determines whether an Autonomous AI Database must be opened across the maximum number of nodes or the least number of nodes. By default, Minimum nodes is selected. (MINIMUM_DISTRIBUTION, MAXIMUM_DISTRIBUTION)
`dstFileVersion`	`string`	DST Time-Zone File version of the Autonomous Container Database.
`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"}`
`infrastructureType`	`string`	The infrastructure type this resource belongs to. (CLOUD, CLOUD_AT_CUSTOMER)
`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.
`isDstFileUpdateEnabled`	`boolean`	Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner.
`isMultipleStandby`	`boolean`	Indicates if it is multiple standby Autonomous Dataguard
`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.
`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.
`largestProvisionableAutonomousDatabaseInCpus`	`number (float)`	The largest Autonomous AI Database (CPU) that can be created in a new Autonomous Container Database.
`lastMaintenanceRunId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run.
`lifecycleDetails`	`string`	Additional information about the current lifecycle state.
`lifecycleState`	`string`	The current state of the Autonomous Container Database. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, BACKUP_IN_PROGRESS, RESTORING, RESTORE_FAILED, RESTARTING, MAINTENANCE_IN_PROGRESS, ROLE_CHANGE_IN_PROGRESS, ENABLING_AUTONOMOUS_DATA_GUARD, UNAVAILABLE)
`listOneOffPatches`	`array`	List of One-Off patches that has been successfully applied to Autonomous Container Database
`maintenanceWindow`	`object`	The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
`memoryPerOracleComputeUnitInGBs`	`integer`	The amount of memory (in GBs) enabled per ECPU or OCPU in the Autonomous VM Cluster.
`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, DRCP) (default: DEDICATED)
`nextMaintenanceRunId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run.
`okvEndPointGroupName`	`string`	The OKV End Point Group name for the Autonomous Container Database.
`patchId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch applied on the system.
`patchModel`	`string`	Database patch model preference. (RELEASE_UPDATES, RELEASE_UPDATE_REVISIONS)
`provisionableCpus`	`array`	An array of CPU values that can be used to successfully provision a single Autonomous AI Database.
`provisionedCpus`	`number (float)`	The number of CPUs provisioned in an Autonomous Container Database.
`reclaimableCpus`	`number (float)`	CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database.
`recoveryApplianceDetails`	`object`	Information about the recovery appliance configuration associated with the Autonomous Container Database.
`reservedCpus`	`number (float)`	The number of CPUs reserved in an Autonomous Container Database.
`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)
`serviceLevelAgreementType`	`string`	The service level agreement type of the container database. The default is STANDARD. (STANDARD, MISSION_CRITICAL, AUTONOMOUS_DATAGUARD)
`standbyMaintenanceBufferInDays`	`integer`	The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary 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 Container Database was created.
`timeOfLastBackup`	`string (date-time)`	The timestamp of last successful backup. Here NULL value represents either there are no successful backups or backups are not configured for this Autonomous Container Database.
`timeSnapshotStandbyRevert`	`string (date-time)`	The date and time the Autonomous Container Database will be reverted to Standby from Snapshot Standby.
`totalCpus`	`integer`	The number of CPUs allocated to the Autonomous VM cluster.
`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.
`versionPreference`	`string`	The next maintenance version preference. (NEXT_RELEASE_UPDATE, LATEST_RELEASE_UPDATE) (default: NEXT_RELEASE_UPDATE)
`vmFailoverReservation`	`integer`	The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`autonomousContainerDatabaseId`, `region`		Gets information about the specified Autonomous Container Database.
`list`	`select`	`compartmentId`, `region`	`autonomousExadataInfrastructureId`, `autonomousVmClusterId`, `infrastructureType`, `limit`, `page`, `sortBy`, `sortOrder`, `lifecycleState`, `availabilityDomain`, `displayName`, `serviceLevelAgreementType`, `cloudAutonomousVmClusterId`	Gets a list of the Autonomous Container Databases in the specified compartment.<br />
`create`	`insert`	`region`, `displayName`, `patchModel`	`opc-retry-token`	Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.<br />
`update`	`update`	`autonomousContainerDatabaseId`, `region`	`if-match`	Updates the properties of an Autonomous Container Database, such as display name, maintenance preference, backup retention, and tags.
`terminate`	`delete`	`autonomousContainerDatabaseId`, `region`	`if-match`	Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it.
`add_standby_autonomous_container_database`	`exec`	`autonomousContainerDatabaseId`, `region`	`opc-request-id`, `opc-retry-token`, `if-match`	Add a standby Autonomous Container Database. For more information about Autonomous Data Guard,see<br />[Protect Critical Databases from Failures and Disasters Using Autonomous Data Guard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbau/GUID-C57B9A6E-7471-4CDC-8F10-B8386538E31C).<br />
`change_compartment`	`exec`	`autonomousContainerDatabaseId`, `region`, `compartmentId`	`opc-retry-token`, `opc-request-id`, `if-match`	Move the Autonomous Container Database and its dependent resources to the specified compartment.<br />For more information about moving Autonomous Container Databases, see<br />[Moving Database Resources to a Different Compartment](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/raqyy/#articletitle.html).<br />
`change_dataguard_role`	`exec`	`autonomousContainerDatabaseId`, `region`, `role`, `autonomousContainerDatabaseDataguardAssociationId`	`opc-request-id`, `opc-retry-token`, `if-match`	Deprecated. Use the [ConvertStandbyAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/ConvertStandbyAutonomousContainerDatabase) operation to switch the Autonomous Container Database (ACD) role between Standby and Snapshot Standby.<br />For more information about changing ACD Role, see<br />[Convert Physical Standby to Snapshot Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-D3B503F1-0032-4B0D-9F00-ACAE8151AB80) and [Convert Snapshot Standby to Physical Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-E8D7E0EE-8244-467D-B33A-1BC6F969A0A4).<br />
`edit_autonomous_container_database_dataguard`	`exec`	`autonomousContainerDatabaseId`, `region`	`opc-request-id`, `opc-retry-token`, `if-match`	Modify Autonomous Container Database Data Guard settings such as protection mode, automatic failover, and fast start failover lag limit. For more information, see<br />[Update Autonomous Container Database Dataguard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-3A936EC7-7A49-4FD2-9F39-8DB6B22011CE).<br />
`failover_autonomous_container_database_dataguard`	`exec`	`autonomousContainerDatabaseId`, `region`	`if-match`, `opc-request-id`	Performs failover to a standby Autonomous Container Database (ACD) identified by the autonomousContainerDatabaseId parameter. This standby ACD will become the new primary ACD when the failover completes successfully. For more information, see<br />[Fail Over to the Standby in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-C8FFA343-223C-4F41-9656-AEC356AD90A0). <br />
`reinstate_autonomous_container_database_dataguard`	`exec`	`autonomousContainerDatabaseId`, `region`	`if-match`, `opc-request-id`	Reinstates a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter to an active standby ACD. For more information, see<br />[Reinstate the Disabled Standby in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-B5C6A90D-72E3-4F32-988D-8AECC0A2D947).<br />
`restart_autonomous_container_database`	`exec`	`autonomousContainerDatabaseId`, `region`	`if-match`, `opc-request-id`	Rolling restarts the specified Autonomous Container Database.<br />
`rotate_autonomous_container_database_encryption_key`	`exec`	`autonomousContainerDatabaseId`, `region`	`if-match`, `opc-retry-token`, `opc-request-id`	Creates a new version of an existing [Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) key.
`convert_standby_autonomous_container_database`	`exec`	`autonomousContainerDatabaseId`, `region`, `role`	`opc-request-id`, `opc-retry-token`, `if-match`	Convert the standby Autonomous Container Database (ACD) between physical standby and snapshot standby ACD. For more information about converting standby ACDs, see<br />[Convert Physical Standby to Snapshot Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-D3B503F1-0032-4B0D-9F00-ACAE8151AB80) and [Convert Snapshot Standby to Physical Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-E8D7E0EE-8244-467D-B33A-1BC6F969A0A4).<br />
`switchover_autonomous_container_database_dataguard`	`exec`	`autonomousContainerDatabaseId`, `region`	`if-match`, `opc-request-id`	Switchover an Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD. This standby ACD will become the new primary ACD when the switchover completes successfully. For more information, see<br />[Switch Roles in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-A2AB31F6-D52D-493C-9BA7-D87A0F17078F). <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
`autonomousContainerDatabaseId`	`string`	The Autonomous Container 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)
`autonomousExadataInfrastructureId`	`string`	The Autonomous Exadata Infrastructure [OCID](/Content/General/Concepts/identifiers.htm).
`autonomousVmClusterId`	`string`	The Autonomous VM Cluster [OCID](/Content/General/Concepts/identifiers.htm).
`availabilityDomain`	`string`	A filter to return only resources that match the given availability domain exactly.
`cloudAutonomousVmClusterId`	`string`	The cloud Autonomous VM Cluster [OCID](/Content/General/Concepts/identifiers.htm).
`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.
`lifecycleState`	`string`	A filter to return only resources that match the given lifecycle state exactly.
`limit`	`integer`	The maximum number of items to return per page.
`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.
`serviceLevelAgreementType`	`string`	A filter to return only resources that match the given service-level agreement type exactly.
`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 information about the specified Autonomous Container Database.

SELECT
id,
associatedBackupConfigurationDetails,
autonomousExadataInfrastructureId,
autonomousVmClusterId,
availabilityDomain,
availableCpus,
backupConfig,
backupDestinationPropertiesList,
cloudAutonomousVmClusterId,
compartmentId,
computeModel,
customerContacts,
dataguard,
dataguardGroupMembers,
dbName,
dbSplitThreshold,
dbUniqueName,
dbVersion,
definedTags,
displayName,
distributionAffinity,
dstFileVersion,
freeformTags,
infrastructureType,
isDataGuardEnabled,
isDstFileUpdateEnabled,
isMultipleStandby,
keyHistoryEntry,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyVersionId,
largestProvisionableAutonomousDatabaseInCpus,
lastMaintenanceRunId,
lifecycleDetails,
lifecycleState,
listOneOffPatches,
maintenanceWindow,
memoryPerOracleComputeUnitInGBs,
netServicesArchitecture,
nextMaintenanceRunId,
okvEndPointGroupName,
patchId,
patchModel,
provisionableCpus,
provisionedCpus,
reclaimableCpus,
recoveryApplianceDetails,
reservedCpus,
role,
serviceLevelAgreementType,
standbyMaintenanceBufferInDays,
systemTags,
timeCreated,
timeOfLastBackup,
timeSnapshotStandbyRevert,
totalCpus,
vaultId,
versionPreference,
vmFailoverReservation
FROM oci.database.autonomous_container_databases
WHERE autonomousContainerDatabaseId = '{{ autonomousContainerDatabaseId }}' -- required
AND region = '{{ region }}' -- required
;

Gets a list of the Autonomous Container Databases in the specified compartment.

SELECT
id,
associatedBackupConfigurationDetails,
autonomousExadataInfrastructureId,
autonomousVmClusterId,
availabilityDomain,
availableCpus,
backupConfig,
backupDestinationPropertiesList,
cloudAutonomousVmClusterId,
compartmentId,
computeModel,
customerContacts,
dataguard,
dataguardGroupMembers,
dbName,
dbSplitThreshold,
dbUniqueName,
dbVersion,
definedTags,
displayName,
distributionAffinity,
dstFileVersion,
freeformTags,
infrastructureType,
isDataGuardEnabled,
isDstFileUpdateEnabled,
isMultipleStandby,
keyHistoryEntry,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyVersionId,
largestProvisionableAutonomousDatabaseInCpus,
lastMaintenanceRunId,
lifecycleDetails,
lifecycleState,
listOneOffPatches,
maintenanceWindow,
memoryPerOracleComputeUnitInGBs,
netServicesArchitecture,
nextMaintenanceRunId,
okvEndPointGroupName,
patchId,
patchModel,
provisionableCpus,
provisionedCpus,
reclaimableCpus,
recoveryApplianceDetails,
reservedCpus,
role,
serviceLevelAgreementType,
standbyMaintenanceBufferInDays,
systemTags,
timeCreated,
timeOfLastBackup,
timeSnapshotStandbyRevert,
totalCpus,
vaultId,
versionPreference,
vmFailoverReservation
FROM oci.database.autonomous_container_databases
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND autonomousExadataInfrastructureId = '{{ autonomousExadataInfrastructureId }}'
AND autonomousVmClusterId = '{{ autonomousVmClusterId }}'
AND infrastructureType = '{{ infrastructureType }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND availabilityDomain = '{{ availabilityDomain }}'
AND displayName = '{{ displayName }}'
AND serviceLevelAgreementType = '{{ serviceLevelAgreementType }}'
AND cloudAutonomousVmClusterId = '{{ cloudAutonomousVmClusterId }}'
;

`INSERT` examples

create
Manifest

Creates an Autonomous Container Database in the specified Autonomous Exadata Infrastructure.

INSERT INTO oci.database.autonomous_container_databases (
autonomousExadataInfrastructureId,
autonomousVmClusterId,
backupConfig,
cloudAutonomousVmClusterId,
compartmentId,
customerContacts,
databaseSoftwareImageId,
dbName,
dbSplitThreshold,
dbUniqueName,
dbVersion,
definedTags,
displayName,
distributionAffinity,
fastStartFailOverLagLimitInSeconds,
freeformTags,
isAutomaticFailoverEnabled,
isDstFileUpdateEnabled,
keyStoreId,
kmsKeyId,
kmsKeyVersionId,
maintenanceWindowDetails,
netServicesArchitecture,
okvEndPointGroupName,
patchModel,
peerAutonomousContainerDatabaseBackupConfig,
peerAutonomousContainerDatabaseCompartmentId,
peerAutonomousContainerDatabaseDisplayName,
peerAutonomousExadataInfrastructureId,
peerAutonomousVmClusterId,
peerCloudAutonomousVmClusterId,
peerDbUniqueName,
protectionMode,
serviceLevelAgreementType,
source,
standbyMaintenanceBufferInDays,
vaultId,
versionPreference,
vmFailoverReservation,
region,
opc-retry-token
)
SELECT 
'{{ autonomousExadataInfrastructureId }}',
'{{ autonomousVmClusterId }}',
'{{ backupConfig }}',
'{{ cloudAutonomousVmClusterId }}',
'{{ compartmentId }}',
'{{ customerContacts }}',
'{{ databaseSoftwareImageId }}',
'{{ dbName }}',
{{ dbSplitThreshold }},
'{{ dbUniqueName }}',
'{{ dbVersion }}',
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ distributionAffinity }}',
{{ fastStartFailOverLagLimitInSeconds }},
'{{ freeformTags }}',
{{ isAutomaticFailoverEnabled }},
{{ isDstFileUpdateEnabled }},
'{{ keyStoreId }}',
'{{ kmsKeyId }}',
'{{ kmsKeyVersionId }}',
'{{ maintenanceWindowDetails }}',
'{{ netServicesArchitecture }}',
'{{ okvEndPointGroupName }}',
'{{ patchModel }}' /* required */,
'{{ peerAutonomousContainerDatabaseBackupConfig }}',
'{{ peerAutonomousContainerDatabaseCompartmentId }}',
'{{ peerAutonomousContainerDatabaseDisplayName }}',
'{{ peerAutonomousExadataInfrastructureId }}',
'{{ peerAutonomousVmClusterId }}',
'{{ peerCloudAutonomousVmClusterId }}',
'{{ peerDbUniqueName }}',
'{{ protectionMode }}',
'{{ serviceLevelAgreementType }}',
'{{ source }}',
{{ standbyMaintenanceBufferInDays }},
'{{ vaultId }}',
'{{ versionPreference }}',
{{ vmFailoverReservation }},
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
associatedBackupConfigurationDetails,
autonomousExadataInfrastructureId,
autonomousVmClusterId,
availabilityDomain,
availableCpus,
backupConfig,
backupDestinationPropertiesList,
cloudAutonomousVmClusterId,
compartmentId,
computeModel,
customerContacts,
dataguard,
dataguardGroupMembers,
dbName,
dbSplitThreshold,
dbUniqueName,
dbVersion,
definedTags,
displayName,
distributionAffinity,
dstFileVersion,
freeformTags,
infrastructureType,
isDataGuardEnabled,
isDstFileUpdateEnabled,
isMultipleStandby,
keyHistoryEntry,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyVersionId,
largestProvisionableAutonomousDatabaseInCpus,
lastMaintenanceRunId,
lifecycleDetails,
lifecycleState,
listOneOffPatches,
maintenanceWindow,
memoryPerOracleComputeUnitInGBs,
netServicesArchitecture,
nextMaintenanceRunId,
okvEndPointGroupName,
patchId,
patchModel,
provisionableCpus,
provisionedCpus,
reclaimableCpus,
recoveryApplianceDetails,
reservedCpus,
role,
serviceLevelAgreementType,
standbyMaintenanceBufferInDays,
systemTags,
timeCreated,
timeOfLastBackup,
timeSnapshotStandbyRevert,
totalCpus,
vaultId,
versionPreference,
vmFailoverReservation
;

# Description fields are for documentation purposes
- name: autonomous_container_databases
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the autonomous_container_databases resource.
  - name: autonomousExadataInfrastructureId
    value: "{{ autonomousExadataInfrastructureId }}"
    description: |
      **No longer used.** This parameter is no longer used for Autonomous AI Database on dedicated Exadata infrasture. Specify a `cloudAutonomousVmClusterId` instead. Using this parameter will cause the operation to fail.
  - name: autonomousVmClusterId
    value: "{{ autonomousVmClusterId }}"
    description: |
      The OCID of the Autonomous VM Cluster.
  - name: backupConfig
    description: |
      Backup options for the Autonomous Container Database.
    value:
      backupDestinationDetails:
        - backupRetentionPolicyOnTerminate: "{{ backupRetentionPolicyOnTerminate }}"
          dbrsPolicyId: "{{ dbrsPolicyId }}"
          id: "{{ id }}"
          internetProxy: "{{ internetProxy }}"
          isRemote: {{ isRemote }}
          isRetentionLockEnabled: {{ isRetentionLockEnabled }}
          remoteRegion: "{{ remoteRegion }}"
          type: "{{ type }}"
          vpcPassword: "{{ vpcPassword }}"
          vpcUser: "{{ vpcUser }}"
      recoveryWindowInDays: {{ recoveryWindowInDays }}
  - name: cloudAutonomousVmClusterId
    value: "{{ cloudAutonomousVmClusterId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Autonomous Container Database.
  - name: customerContacts
    description: |
      Customer Contacts. Setting this to an empty list removes all customer contacts.
    value:
      - email: "{{ email }}"
  - name: databaseSoftwareImageId
    value: "{{ databaseSoftwareImageId }}"
    description: |
      The Autonomous AI Database Software Image [OCID](/Content/General/Concepts/identifiers.htm).
  - name: dbName
    value: "{{ dbName }}"
    description: |
      The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters.
  - name: dbSplitThreshold
    value: {{ dbSplitThreshold }}
    description: |
      The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs.
  - name: dbUniqueName
    value: "{{ dbUniqueName }}"
    description: |
      **Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure.  Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.
  - name: dbVersion
    value: "{{ dbVersion }}"
    description: |
      The base version for the Autonomous Container Database.
  - 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 display name for the Autonomous Container Database.
  - name: distributionAffinity
    value: "{{ distributionAffinity }}"
    description: |
      Determines whether an Autonomous AI Database must be opened across a minimum or maximum of nodes. By default, Minimum nodes is selected.
    valid_values: ['MINIMUM_DISTRIBUTION', 'MAXIMUM_DISTRIBUTION']
  - name: fastStartFailOverLagLimitInSeconds
    value: {{ fastStartFailOverLagLimitInSeconds }}
    description: |
      The lag time for my preference based on data loss tolerance in seconds.
  - 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: isAutomaticFailoverEnabled
    value: {{ isAutomaticFailoverEnabled }}
    description: |
      Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association
  - name: isDstFileUpdateEnabled
    value: {{ isDstFileUpdateEnabled }}
    description: |
      Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner.
  - name: keyStoreId
    value: "{{ keyStoreId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault.
  - 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: kmsKeyVersionId
    value: "{{ kmsKeyVersionId }}"
    description: |
      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.
  - name: maintenanceWindowDetails
    description: |
      The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
    value:
      customActionTimeoutInMins: {{ customActionTimeoutInMins }}
      daysOfWeek:
        - name: "{{ name }}"
      hoursOfDay:
        - {{ hoursOfDay }}
      isCustomActionTimeoutEnabled: {{ isCustomActionTimeoutEnabled }}
      leadTimeInWeeks: {{ leadTimeInWeeks }}
      months:
        - name: "{{ name }}"
      patchingMode: "{{ patchingMode }}"
      preference: "{{ preference }}"
      skipRu:
        - {{ skipRu }}
      weeksOfMonth:
        - {{ weeksOfMonth }}
  - name: netServicesArchitecture
    value: "{{ netServicesArchitecture }}"
    description: |
      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.
    valid_values: ['DEDICATED', 'SHARED', 'DRCP']
    default: DEDICATED
  - name: okvEndPointGroupName
    value: "{{ okvEndPointGroupName }}"
    description: |
      The OKV End Point Group name for the Autonomous Container Database.
  - name: patchModel
    value: "{{ patchModel }}"
    description: |
      Database Patch model preference.
    valid_values: ['RELEASE_UPDATES', 'RELEASE_UPDATE_REVISIONS']
  - name: peerAutonomousContainerDatabaseBackupConfig
    description: |
      Backup options for the standby Autonomous Container Database.
    value:
      backupDestinationDetails:
        - backupRetentionPolicyOnTerminate: "{{ backupRetentionPolicyOnTerminate }}"
          dbrsPolicyId: "{{ dbrsPolicyId }}"
          id: "{{ id }}"
          internetProxy: "{{ internetProxy }}"
          isRemote: {{ isRemote }}
          isRetentionLockEnabled: {{ isRetentionLockEnabled }}
          remoteRegion: "{{ remoteRegion }}"
          type: "{{ type }}"
          vpcPassword: "{{ vpcPassword }}"
          vpcUser: "{{ vpcUser }}"
      recoveryWindowInDays: {{ recoveryWindowInDays }}
  - name: peerAutonomousContainerDatabaseCompartmentId
    value: "{{ peerAutonomousContainerDatabaseCompartmentId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the standby Autonomous Container Database
      will be created.
  - name: peerAutonomousContainerDatabaseDisplayName
    value: "{{ peerAutonomousContainerDatabaseDisplayName }}"
    description: |
      The display name for the peer Autonomous Container Database.
  - name: peerAutonomousExadataInfrastructureId
    value: "{{ peerAutonomousExadataInfrastructureId }}"
    description: |
      *No longer used.* This parameter is no longer used for Autonomous AI Database on dedicated Exadata infrasture. Specify a `peerCloudAutonomousVmClusterId` instead. Using this parameter will cause the operation to fail.
  - name: peerAutonomousVmClusterId
    value: "{{ peerAutonomousVmClusterId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous VM cluster for Autonomous Data Guard. Required to enable Data Guard.
  - name: peerCloudAutonomousVmClusterId
    value: "{{ peerCloudAutonomousVmClusterId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the peer cloud Autonomous Exadata VM Cluster.
  - name: peerDbUniqueName
    value: "{{ peerDbUniqueName }}"
    description: |
      **Deprecated.** The `DB_UNIQUE_NAME` of the peer Autonomous Container Database in a Data Guard association is set by Oracle Cloud Infrastructure.  Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail.
  - name: protectionMode
    value: "{{ protectionMode }}"
    description: |
      The protection mode of this Autonomous Data Guard association. For more information, see
      [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000)
      in the Oracle Data Guard documentation.
    valid_values: ['MAXIMUM_AVAILABILITY', 'MAXIMUM_PERFORMANCE']
  - name: serviceLevelAgreementType
    value: "{{ serviceLevelAgreementType }}"
    description: |
      The service level agreement type of the Autonomous Container Database. The default is STANDARD. For an autonomous dataguard Autonomous Container Database, the specified Autonomous Exadata Infrastructure must be associated with a remote Autonomous Exadata Infrastructure.
    valid_values: ['STANDARD', 'AUTONOMOUS_DATAGUARD']
  - name: source
    value: "{{ source }}"
    description: |
      The source of the database. Use `NONE` to create a new Autonomous Container Database (ACD). Use `BACKUP_FROM_ID` to create a new ACD from a specified backup.
    valid_values: ['NONE', 'BACKUP_FROM_ID']
    default: NONE
  - name: standbyMaintenanceBufferInDays
    value: {{ standbyMaintenanceBufferInDays }}
    description: |
      The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database.
      This value represents the number of days before scheduled maintenance of the primary database.
  - 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: versionPreference
    value: "{{ versionPreference }}"
    description: |
      The next maintenance version preference.
    valid_values: ['NEXT_RELEASE_UPDATE', 'LATEST_RELEASE_UPDATE']
    default: NEXT_RELEASE_UPDATE
  - name: vmFailoverReservation
    value: {{ vmFailoverReservation }}
    description: |
      The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option.
    default: 50
  - 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). 

`UPDATE` examples

update

Updates the properties of an Autonomous Container Database, such as display name, maintenance preference, backup retention, and tags.

UPDATE oci.database.autonomous_container_databases
SET 
backupConfig = '{{ backupConfig }}',
customerContacts = '{{ customerContacts }}',
dbSplitThreshold = {{ dbSplitThreshold }},
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
distributionAffinity = '{{ distributionAffinity }}',
freeformTags = '{{ freeformTags }}',
isDstFileUpdateEnabled = {{ isDstFileUpdateEnabled }},
maintenanceWindowDetails = '{{ maintenanceWindowDetails }}',
netServicesArchitecture = '{{ netServicesArchitecture }}',
okvEndPointGroupName = '{{ okvEndPointGroupName }}',
patchModel = '{{ patchModel }}',
standbyMaintenanceBufferInDays = {{ standbyMaintenanceBufferInDays }},
versionPreference = '{{ versionPreference }}',
vmFailoverReservation = {{ vmFailoverReservation }}
WHERE 
autonomousContainerDatabaseId = '{{ autonomousContainerDatabaseId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
associatedBackupConfigurationDetails,
autonomousExadataInfrastructureId,
autonomousVmClusterId,
availabilityDomain,
availableCpus,
backupConfig,
backupDestinationPropertiesList,
cloudAutonomousVmClusterId,
compartmentId,
computeModel,
customerContacts,
dataguard,
dataguardGroupMembers,
dbName,
dbSplitThreshold,
dbUniqueName,
dbVersion,
definedTags,
displayName,
distributionAffinity,
dstFileVersion,
freeformTags,
infrastructureType,
isDataGuardEnabled,
isDstFileUpdateEnabled,
isMultipleStandby,
keyHistoryEntry,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyVersionId,
largestProvisionableAutonomousDatabaseInCpus,
lastMaintenanceRunId,
lifecycleDetails,
lifecycleState,
listOneOffPatches,
maintenanceWindow,
memoryPerOracleComputeUnitInGBs,
netServicesArchitecture,
nextMaintenanceRunId,
okvEndPointGroupName,
patchId,
patchModel,
provisionableCpus,
provisionedCpus,
reclaimableCpus,
recoveryApplianceDetails,
reservedCpus,
role,
serviceLevelAgreementType,
standbyMaintenanceBufferInDays,
systemTags,
timeCreated,
timeOfLastBackup,
timeSnapshotStandbyRevert,
totalCpus,
vaultId,
versionPreference,
vmFailoverReservation;

`DELETE` examples

terminate

Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it.

DELETE FROM oci.database.autonomous_container_databases
WHERE autonomousContainerDatabaseId = '{{ autonomousContainerDatabaseId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

add_standby_autonomous_container_database
change_compartment
change_dataguard_role
edit_autonomous_container_database_dataguard
failover_autonomous_container_database_dataguard
reinstate_autonomous_container_database_dataguard
restart_autonomous_container_database
rotate_autonomous_container_database_encryption_key
convert_standby_autonomous_container_database
switchover_autonomous_container_database_dataguard

Add a standby Autonomous Container Database. For more information about Autonomous Data Guard,see [Protect Critical Databases from Failures and Disasters Using Autonomous Data Guard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbau/GUID-C57B9A6E-7471-4CDC-8F10-B8386538E31C).

EXEC oci.database.autonomous_container_databases.add_standby_autonomous_container_database 
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"fastStartFailOverLagLimitInSeconds": {{ fastStartFailOverLagLimitInSeconds }}, 
"isAutomaticFailoverEnabled": {{ isAutomaticFailoverEnabled }}, 
"peerAutonomousContainerDatabaseBackupConfig": "{{ peerAutonomousContainerDatabaseBackupConfig }}", 
"peerAutonomousContainerDatabaseCompartmentId": "{{ peerAutonomousContainerDatabaseCompartmentId }}", 
"peerAutonomousContainerDatabaseDisplayName": "{{ peerAutonomousContainerDatabaseDisplayName }}", 
"peerAutonomousVmClusterId": "{{ peerAutonomousVmClusterId }}", 
"peerCloudAutonomousVmClusterId": "{{ peerCloudAutonomousVmClusterId }}", 
"peerDbUniqueName": "{{ peerDbUniqueName }}", 
"protectionMode": "{{ protectionMode }}", 
"standbyMaintenanceBufferInDays": {{ standbyMaintenanceBufferInDays }}
}'
;

Move the Autonomous Container Database and its dependent resources to the specified compartment. For more information about moving Autonomous Container Databases, see [Moving Database Resources to a Different Compartment](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/raqyy/#articletitle.html).

EXEC oci.database.autonomous_container_databases.change_compartment 
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Deprecated. Use the [ConvertStandbyAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/ConvertStandbyAutonomousContainerDatabase) operation to switch the Autonomous Container Database (ACD) role between Standby and Snapshot Standby. For more information about changing ACD Role, see [Convert Physical Standby to Snapshot Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-D3B503F1-0032-4B0D-9F00-ACAE8151AB80) and [Convert Snapshot Standby to Physical Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-E8D7E0EE-8244-467D-B33A-1BC6F969A0A4).

EXEC oci.database.autonomous_container_databases.change_dataguard_role 
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"autonomousContainerDatabaseDataguardAssociationId": "{{ autonomousContainerDatabaseDataguardAssociationId }}", 
"connectionStringsType": "{{ connectionStringsType }}", 
"role": "{{ role }}"
}'
;

Modify Autonomous Container Database Data Guard settings such as protection mode, automatic failover, and fast start failover lag limit. For more information, see [Update Autonomous Container Database Dataguard](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-3A936EC7-7A49-4FD2-9F39-8DB6B22011CE).

EXEC oci.database.autonomous_container_databases.edit_autonomous_container_database_dataguard 
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"fastStartFailOverLagLimitInSeconds": {{ fastStartFailOverLagLimitInSeconds }}, 
"isAutomaticFailoverEnabled": {{ isAutomaticFailoverEnabled }}, 
"protectionMode": "{{ protectionMode }}"
}'
;

Performs failover to a standby Autonomous Container Database (ACD) identified by the autonomousContainerDatabaseId parameter. This standby ACD will become the new primary ACD when the failover completes successfully. For more information, see [Fail Over to the Standby in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-C8FFA343-223C-4F41-9656-AEC356AD90A0).

EXEC oci.database.autonomous_container_databases.failover_autonomous_container_database_dataguard 
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}'
;

Reinstates a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter to an active standby ACD. For more information, see [Reinstate the Disabled Standby in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-B5C6A90D-72E3-4F32-988D-8AECC0A2D947).

EXEC oci.database.autonomous_container_databases.reinstate_autonomous_container_database_dataguard 
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}'
;

Rolling restarts the specified Autonomous Container Database.

EXEC oci.database.autonomous_container_databases.restart_autonomous_container_database 
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}' 
@@json=
'{
"isForceRestart": {{ isForceRestart }}
}'
;

Creates a new version of an existing Vault service key.

EXEC oci.database.autonomous_container_databases.rotate_autonomous_container_database_encryption_key 
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}' 
@@json=
'{
"keyVersionId": "{{ keyVersionId }}"
}'
;

Convert the standby Autonomous Container Database (ACD) between physical standby and snapshot standby ACD. For more information about converting standby ACDs, see [Convert Physical Standby to Snapshot Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-D3B503F1-0032-4B0D-9F00-ACAE8151AB80) and [Convert Snapshot Standby to Physical Standby](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-E8D7E0EE-8244-467D-B33A-1BC6F969A0A4).

EXEC oci.database.autonomous_container_databases.convert_standby_autonomous_container_database 
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"connectionStringsType": "{{ connectionStringsType }}", 
"role": "{{ role }}"
}'
;

Switchover an Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD. This standby ACD will become the new primary ACD when the switchover completes successfully. For more information, see [Switch Roles in an Autonomous Data Guard Configuration](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html#ADBCL-GUID-A2AB31F6-D52D-493C-9BA7-D87A0F17078F).

EXEC oci.database.autonomous_container_databases.switchover_autonomous_container_database_dataguard 
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​