Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateAutonomousDatabase

Updates the properties of an Autonomous Database.

Request Syntax


{
   "adminPassword": "string",
   "allowlistedIps": [ "string" ],
   "autonomousDatabaseId": "string",
   "autonomousMaintenanceScheduleType": "string",
   "autoRefreshFrequencyInSeconds": number,
   "autoRefreshPointLagInSeconds": number,
   "backupRetentionPeriodInDays": number,
   "byolComputeCountLimit": number,
   "computeCount": number,
   "cpuCoreCount": number,
   "customerContactsToSendToOCI": [ 
      { 
         "email": "string"
      }
   ],
   "databaseEdition": "string",
   "dataStorageSizeInGBs": number,
   "dataStorageSizeInTBs": number,
   "dbName": "string",
   "dbToolsDetails": [ 
      { 
         "computeCount": number,
         "isEnabled": boolean,
         "maxIdleTimeInMinutes": number,
         "name": "string"
      }
   ],
   "dbVersion": "string",
   "dbWorkload": "string",
   "displayName": "string",
   "encryptionKeyConfiguration": { ... },
   "encryptionKeyProvider": "string",
   "isAutoScalingEnabled": boolean,
   "isAutoScalingForStorageEnabled": boolean,
   "isBackupRetentionLocked": boolean,
   "isDisconnectPeer": boolean,
   "isLocalDataGuardEnabled": boolean,
   "isMtlsConnectionRequired": boolean,
   "isRefreshableClone": boolean,
   "licenseModel": "string",
   "localAdgAutoFailoverMaxDataLossLimit": number,
   "longTermBackupSchedule": { 
      "isDisabled": boolean,
      "repeatCadence": "string",
      "retentionPeriodInDays": number,
      "timeOfBackup": "string"
   },
   "openMode": "string",
   "peerDbId": "string",
   "permissionLevel": "string",
   "privateEndpointIp": "string",
   "privateEndpointLabel": "string",
   "refreshableMode": "string",
   "resourcePoolLeaderId": "string",
   "resourcePoolSummary": { 
      "availableComputeCapacity": number,
      "availableStorageCapacityInTBs": number,
      "isDisabled": boolean,
      "poolSize": number,
      "poolStorageSizeInTBs": number,
      "totalComputeCapacity": number
   },
   "scheduledOperations": [ 
      { 
         "dayOfWeek": { 
            "name": "string"
         },
         "scheduledStartTime": "string",
         "scheduledStopTime": "string"
      }
   ],
   "standbyAllowlistedIps": [ "string" ],
   "standbyAllowlistedIpsSource": "string",
   "timeOfAutoRefreshStart": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

adminPassword

The new password for the ADMIN user of the Autonomous Database.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 30.

Required: No

allowlistedIps

The list of IP addresses that are allowed to access the Autonomous Database.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 1024 items.

Required: No

autonomousDatabaseId

The unique identifier of the Autonomous Database to update.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 2048.

Pattern: (arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})

Required: Yes

autonomousMaintenanceScheduleType

The maintenance schedule type for the Autonomous Database.

Type: String

Valid Values: EARLY | REGULAR

Required: No

autoRefreshFrequencyInSeconds

The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed.

Type: Integer

Valid Range: Minimum value of 3600. Maximum value of 604800.

Required: No

autoRefreshPointLagInSeconds

The time lag, in seconds, between the refreshable clone and its source Autonomous Database.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 604800.

Required: No

backupRetentionPeriodInDays

The retention period, in days, for automatic backups of the Autonomous Database.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 60.

Required: No

byolComputeCountLimit

The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.

Type: Double

Valid Range: Minimum value of 2.

Required: No

computeCount

The compute capacity, in number of ECPUs or OCPUs, to assign to the Autonomous Database.

Type: Double

Valid Range: Minimum value of 0.1. Maximum value of 512.

Required: No

cpuCoreCount

The number of CPU cores to allocate to the Autonomous Database.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 128.

Required: No

customerContactsToSendToOCI

The list of customer contacts to receive operational notifications from OCI for the Autonomous Database.

Type: Array of CustomerContact objects

Required: No

databaseEdition

The Oracle Database edition to apply to the Autonomous Database.

Type: String

Valid Values: STANDARD_EDITION | ENTERPRISE_EDITION

Required: No

dataStorageSizeInGBs

The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database.

Type: Integer

Valid Range: Minimum value of 20. Maximum value of 393216.

Required: No

dataStorageSizeInTBs

The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 384.

Required: No

dbName

The new name of the Autonomous Database.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 30.

Required: No

dbToolsDetails

The list of database management tools to enable for the Autonomous Database.

Type: Array of DatabaseTool objects

Required: No

dbVersion

The Oracle Database software version to use for the Autonomous Database.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

dbWorkload

The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX.

Type: String

Valid Values: OLTP | AJD | APEX | LH

Required: No

displayName

The new user-friendly name for the Autonomous Database.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*

Required: No

encryptionKeyConfiguration

The configuration of the encryption key to use for the Autonomous Database.

Type: EncryptionKeyConfigurationInput object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

encryptionKeyProvider

The provider of the encryption key to use for the Autonomous Database.

Type: String

Valid Values: ORACLE_MANAGED | AWS_KMS

Required: No

isAutoScalingEnabled

Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.

Type: Boolean

Required: No

isAutoScalingForStorageEnabled

Specifies whether to enable automatic scaling of the storage for the Autonomous Database.

Type: Boolean

Required: No

isBackupRetentionLocked

Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.

Type: Boolean

Required: No

isDisconnectPeer

Specifies whether to disconnect the Autonomous Database from its peer database.

Type: Boolean

Required: No

isLocalDataGuardEnabled

Specifies whether to enable local Oracle Data Guard for the Autonomous Database.

Type: Boolean

Required: No

isMtlsConnectionRequired

Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.

Type: Boolean

Required: No

isRefreshableClone

Specifies whether the Autonomous Database is a refreshable clone.

Type: Boolean

Required: No

licenseModel

The Oracle license model to apply to the Autonomous Database.

Type: String

Valid Values: BRING_YOUR_OWN_LICENSE | LICENSE_INCLUDED

Required: No

localAdgAutoFailoverMaxDataLossLimit

The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 3600.

Required: No

longTermBackupSchedule

The long-term backup schedule for the Autonomous Database.

Type: LongTermBackupSchedule object

Required: No

openMode

The mode in which to open the Autonomous Database, either read-only or read/write.

Type: String

Valid Values: READ_ONLY | READ_WRITE

Required: No

peerDbId

The unique identifier of the peer Autonomous Database.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 2048.

Pattern: (arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})

Required: No

permissionLevel

The permission level of the Autonomous Database.

Type: String

Valid Values: RESTRICTED | UNRESTRICTED

Required: No

privateEndpointIp

The private endpoint IP address for the Autonomous Database.

Type: String

Required: No

privateEndpointLabel

The private endpoint label for the Autonomous Database.

Type: String

Required: No

refreshableMode

The refresh mode of the refreshable clone Autonomous Database.

Type: String

Valid Values: AUTOMATIC | MANUAL

Required: No

resourcePoolLeaderId

The unique identifier of the resource pool leader Autonomous Database.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 2048.

Pattern: (arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})

Required: No

resourcePoolSummary

The configuration of the resource pool for the Autonomous Database.

Type: ResourcePoolSummary object

Required: No

scheduledOperations

The list of scheduled start and stop times for the Autonomous Database.

Type: Array of ScheduledOperationDetails objects

Required: No

standbyAllowlistedIps

The list of IP addresses that are allowed to access the standby Autonomous Database.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 1024 items.

Required: No

standbyAllowlistedIpsSource

The source of the allowlisted IP addresses for the standby Autonomous Database.

Type: String

Valid Values: PRIMARY | SEPARATE | NOT_APPLICABLE

Required: No

timeOfAutoRefreshStart

The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts.

Type: Timestamp

Required: No

Response Syntax


{
   "autonomousDatabaseId": "string",
   "displayName": "string",
   "status": "string",
   "statusReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

autonomousDatabaseId

The unique identifier of the Autonomous Database that was updated.

Type: String

displayName

The user-friendly name of the Autonomous Database that was updated.

Type: String

status

The current status of the Autonomous Database.

Type: String

statusReason

Additional information about the current status of the Autonomous Database, if applicable.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

HTTP Status Code: 400

ConflictException

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

resourceId: The identifier of the resource that caused the conflict.
resourceType: The type of resource that caused the conflict.

HTTP Status Code: 400

InternalServerException

Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.

retryAfterSeconds: The number of seconds to wait before retrying the request after an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

resourceId: The identifier of the resource that was not found.
resourceType: The type of resource that was not found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

retryAfterSeconds: The number of seconds to wait before retrying the request after being throttled.

HTTP Status Code: 400

ValidationException

The request has failed validation because it is missing required fields or has invalid inputs.

fieldList: A list of fields that failed validation.
reason: The reason why the validation failed.

HTTP Status Code: 400