odb / Client / update_autonomous_database

update_autonomous_database¶

odb.Client.update_autonomous_database(**kwargs)¶

Updates the properties of an Autonomous Database.

Request Syntax

response = client.update_autonomous_database(
    autonomousDatabaseId='string',
    adminPassword='string',
    computeCount=123.0,
    cpuCoreCount=123,
    dataStorageSizeInTBs=123,
    dataStorageSizeInGBs=123,
    displayName='string',
    dbName='string',
    dbVersion='string',
    dbWorkload='OLTP'|'AJD'|'APEX'|'LH',
    dbToolsDetails=[
        {
            'isEnabled': True|False,
            'name': 'string',
            'computeCount': 123.0,
            'maxIdleTimeInMinutes': 123
        },
    ],
    databaseEdition='STANDARD_EDITION'|'ENTERPRISE_EDITION',
    licenseModel='BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
    isAutoScalingEnabled=True|False,
    isAutoScalingForStorageEnabled=True|False,
    isBackupRetentionLocked=True|False,
    isLocalDataGuardEnabled=True|False,
    isMtlsConnectionRequired=True|False,
    isRefreshableClone=True|False,
    isDisconnectPeer=True|False,
    backupRetentionPeriodInDays=123,
    byolComputeCountLimit=123.0,
    localAdgAutoFailoverMaxDataLossLimit=123,
    autonomousMaintenanceScheduleType='EARLY'|'REGULAR',
    customerContactsToSendToOCI=[
        {
            'email': 'string'
        },
    ],
    scheduledOperations=[
        {
            'dayOfWeek': {
                'name': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
            },
            'scheduledStartTime': 'string',
            'scheduledStopTime': 'string'
        },
    ],
    longTermBackupSchedule={
        'isDisabled': True|False,
        'repeatCadence': 'ONE_TIME'|'WEEKLY'|'MONTHLY'|'YEARLY',
        'retentionPeriodInDays': 123,
        'timeOfBackup': datetime(2015, 1, 1)
    },
    openMode='READ_ONLY'|'READ_WRITE',
    permissionLevel='RESTRICTED'|'UNRESTRICTED',
    refreshableMode='AUTOMATIC'|'MANUAL',
    privateEndpointIp='string',
    privateEndpointLabel='string',
    peerDbId='string',
    resourcePoolLeaderId='string',
    resourcePoolSummary={
        'isDisabled': True|False,
        'poolSize': 123,
        'poolStorageSizeInTBs': 123,
        'availableStorageCapacityInTBs': 123.0,
        'totalComputeCapacity': 123,
        'availableComputeCapacity': 123
    },
    standbyAllowlistedIpsSource='PRIMARY'|'SEPARATE'|'NOT_APPLICABLE',
    standbyAllowlistedIps=[
        'string',
    ],
    allowlistedIps=[
        'string',
    ],
    autoRefreshFrequencyInSeconds=123,
    autoRefreshPointLagInSeconds=123,
    timeOfAutoRefreshStart=datetime(2015, 1, 1),
    encryptionKeyProvider='ORACLE_MANAGED'|'AWS_KMS',
    encryptionKeyConfiguration={
        'awsEncryptionKey': {
            'iamRoleArn': 'string',
            'externalIdType': 'database_ocid'|'compartment_ocid'|'tenant_ocid',
            'kmsKeyId': 'string'
        }
    }
)

Parameters:

autonomousDatabaseId (string) –
[REQUIRED]

The unique identifier of the Autonomous Database to update.
adminPassword (string) – The new password for the ADMIN user of the Autonomous Database.
computeCount (float) – The compute capacity, in number of ECPUs or OCPUs, to assign to the Autonomous Database.
cpuCoreCount (integer) – The number of CPU cores to allocate to the Autonomous Database.
dataStorageSizeInTBs (integer) – The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database.
dataStorageSizeInGBs (integer) – The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database.
displayName (string) – The new user-friendly name for the Autonomous Database.
dbName (string) – The new name of the Autonomous Database.
dbVersion (string) – The Oracle Database software version to use for the Autonomous Database.
dbWorkload (string) – The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX.
dbToolsDetails (list) –
The list of database management tools to enable for the Autonomous Database.
- (dict) –
  
  Information about a database management tool for an Autonomous Database.
  - isEnabled (boolean) –
    
    Indicates whether the database management tool is enabled.
  - name (string) –
    
    The name of the database management tool.
  - computeCount (float) –
    
    The compute capacity allocated to the database management tool.
  - maxIdleTimeInMinutes (integer) –
    
    The maximum amount of time, in minutes, that the database management tool can be idle before it is shut down.
databaseEdition (string) – The Oracle Database edition to apply to the Autonomous Database.
licenseModel (string) – The Oracle license model to apply to the Autonomous Database.
isAutoScalingEnabled (boolean) – Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.
isAutoScalingForStorageEnabled (boolean) – Specifies whether to enable automatic scaling of the storage for the Autonomous Database.
isBackupRetentionLocked (boolean) – Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.
isLocalDataGuardEnabled (boolean) – Specifies whether to enable local Oracle Data Guard for the Autonomous Database.
isMtlsConnectionRequired (boolean) – Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.
isRefreshableClone (boolean) – Specifies whether the Autonomous Database is a refreshable clone.
isDisconnectPeer (boolean) – Specifies whether to disconnect the Autonomous Database from its peer database.
backupRetentionPeriodInDays (integer) – The retention period, in days, for automatic backups of the Autonomous Database.
byolComputeCountLimit (float) – The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.
localAdgAutoFailoverMaxDataLossLimit (integer) – The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database.
autonomousMaintenanceScheduleType (string) – The maintenance schedule type for the Autonomous Database.
customerContactsToSendToOCI (list) –
The list of customer contacts to receive operational notifications from OCI for the Autonomous Database.
- (dict) –
  
  A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure.
  - email (string) –
    
    The email address of the contact.
scheduledOperations (list) –
The list of scheduled start and stop times for the Autonomous Database.
- (dict) –
  
  The scheduled start and stop times for an Autonomous Database on a specific day of the week.
  - dayOfWeek (dict) – [REQUIRED]
    
    The day of the week on which the scheduled operation occurs.
    - name (string) –
      
      The name of the day of the week.
  - scheduledStartTime (string) –
    
    The scheduled start time for the Autonomous Database, in UTC.
  - scheduledStopTime (string) –
    
    The scheduled stop time for the Autonomous Database, in UTC.
longTermBackupSchedule (dict) –
The long-term backup schedule for the Autonomous Database.
- isDisabled (boolean) –
  
  Indicates whether the long-term backup schedule is disabled.
- repeatCadence (string) –
  
  The cadence at which long-term backups are taken.
- retentionPeriodInDays (integer) –
  
  The retention period, in days, for long-term backups.
- timeOfBackup (datetime) –
  
  The date and time at which the long-term backup is taken.
openMode (string) – The mode in which to open the Autonomous Database, either read-only or read/write.
permissionLevel (string) – The permission level of the Autonomous Database.
refreshableMode (string) – The refresh mode of the refreshable clone Autonomous Database.
privateEndpointIp (string) – The private endpoint IP address for the Autonomous Database.
privateEndpointLabel (string) – The private endpoint label for the Autonomous Database.
peerDbId (string) – The unique identifier of the peer Autonomous Database.
resourcePoolLeaderId (string) – The unique identifier of the resource pool leader Autonomous Database.
resourcePoolSummary (dict) –
The configuration of the resource pool for the Autonomous Database.
- isDisabled (boolean) –
  
  Indicates whether the resource pool is disabled.
- poolSize (integer) –
  
  The number of Autonomous Databases that the resource pool can contain.
- poolStorageSizeInTBs (integer) –
  
  The total storage size of the resource pool, in terabytes (TB).
- availableStorageCapacityInTBs (float) –
  
  The available storage capacity in the resource pool, in TB.
- totalComputeCapacity (integer) –
  
  The total compute capacity of the resource pool.
- availableComputeCapacity (integer) –
  
  The available compute capacity in the resource pool.
standbyAllowlistedIpsSource (string) – The source of the allowlisted IP addresses for the standby Autonomous Database.
standbyAllowlistedIps (list) –
The list of IP addresses that are allowed to access the standby Autonomous Database.
- (string) –
allowlistedIps (list) –
The list of IP addresses that are allowed to access the Autonomous Database.
- (string) –
autoRefreshFrequencyInSeconds (integer) – The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed.
autoRefreshPointLagInSeconds (integer) – The time lag, in seconds, between the refreshable clone and its source Autonomous Database.
timeOfAutoRefreshStart (datetime) – The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts.
encryptionKeyProvider (string) – The provider of the encryption key to use for the Autonomous Database.
encryptionKeyConfiguration (dict) –
The configuration of the encryption key to use for the Autonomous Database.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: awsEncryptionKey.
- awsEncryptionKey (dict) –
  
  The configuration of the Amazon Web Services Key Management Service (KMS) encryption key to use.
  - iamRoleArn (string) –
    
    The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants access to the KMS key.
  - externalIdType (string) –
    
    The type of external identifier associated with the encryption key.
  - kmsKeyId (string) –
    
    The identifier or ARN of the Amazon Web Services KMS key to use for encryption.

Return type:

dict

Returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': 'string',
    'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS'|'STOPPING'|'STOPPED'|'STARTING'|'UNAVAILABLE'|'RESTORE_IN_PROGRESS'|'RESTORE_FAILED'|'BACKUP_IN_PROGRESS'|'SCALE_IN_PROGRESS'|'AVAILABLE_NEEDS_ATTENTION'|'RESTARTING'|'RECREATING'|'ROLE_CHANGE_IN_PROGRESS'|'UPGRADING'|'INACCESSIBLE'|'STANDBY',
    'statusReason': 'string'
}

Response Structure

(dict) –
- autonomousDatabaseId (string) –
  
  The unique identifier of the Autonomous Database that was updated.
- displayName (string) –
  
  The user-friendly name of the Autonomous Database that was updated.
- status (string) –
  
  The current status of the Autonomous Database.
- statusReason (string) –
  
  Additional information about the current status of the Autonomous Database, if applicable.

Exceptions

odb.Client.exceptions.ThrottlingException
odb.Client.exceptions.ValidationException
odb.Client.exceptions.ConflictException
odb.Client.exceptions.AccessDeniedException
odb.Client.exceptions.InternalServerException
odb.Client.exceptions.ResourceNotFoundException