Skip to main content

autonomous_databases

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

Overview

Nameautonomous_databases
TypeResource
Idaws.odb.autonomous_databases

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
actual_used_data_storage_size_in_tbsnumber (double)The actual amount of data storage currently in use by the Autonomous Database, in TB.
admin_password_source_summaryobjectThe summary of the admin password source configuration for the Autonomous Database.
allocated_storage_size_in_tbsnumber (double)The amount of storage currently allocated to the Autonomous Database, in TB.
allowlisted_ipsarrayThe list of IP addresses that are allowed to access the Autonomous Database.
apex_detailsobjectThe Oracle Application Express (APEX) details for the Autonomous Database.
auto_refresh_frequency_in_secondsintegerThe frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed.
auto_refresh_point_lag_in_secondsintegerThe time lag, in seconds, between the refreshable clone and its source Autonomous Database.
autonomous_database_arnstringThe Amazon Resource Name (ARN) of the Autonomous Database. (pattern: <code>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-z0-9-_]{6,64}</code>)
autonomous_database_idstringThe unique identifier of the Autonomous Database. (pattern: <code>(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})</code>)
autonomous_maintenance_schedule_typestringThe maintenance schedule type for the Autonomous Database. (EARLY, REGULAR)
availability_zonestringThe Availability Zone where the Autonomous Database is located.
availability_zone_idstringThe unique identifier of the Availability Zone where the Autonomous Database is located.
available_upgrade_versionsarrayThe list of Oracle Database software versions to which the Autonomous Database can be upgraded.
backup_retention_period_in_daysintegerThe retention period, in days, for automatic backups of the Autonomous Database.
byol_compute_count_limitintegerThe maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.
character_setstringThe character set of the Autonomous Database.
clone_table_space_listarrayThe list of tablespace identifiers to clone for the Autonomous Database.
compute_countnumber (float)The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), assigned to the Autonomous Database.
compute_modelstringThe compute model of the Autonomous Database, either ECPU or OCPU. (ECPU, OCPU)
connection_string_detailsobjectThe connection string details for the Autonomous Database.
connection_urlsobjectThe connection URLs for accessing tools and services for the Autonomous Database.
cpu_core_countintegerThe number of CPU cores allocated to the Autonomous Database.
created_atstring (date-time)The date and time when the Autonomous Database was created.
customer_contactsarrayThe list of customer contacts that receive operational notifications from Oracle for the Autonomous Database.
data_safe_statusstringThe status of the Oracle Data Safe registration for the Autonomous Database. (REGISTERING, REGISTERED, DEREGISTERING, NOT_REGISTERED, FAILED)
data_storage_size_in_gbsintegerThe size, in gigabytes (GB), of the data volume allocated for the Autonomous Database.
data_storage_size_in_tbsnumber (double)The size, in terabytes (TB), of the data volume allocated for the Autonomous Database.
database_editionstringThe Oracle Database edition of the Autonomous Database. (STANDARD_EDITION, ENTERPRISE_EDITION)
database_management_statusstringThe status of Oracle Database Management for the Autonomous Database. (ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING)
database_typestringThe type of the Autonomous Database, either a regular database or a clone. (REGULAR, CLONE)
db_namestringThe name of the Autonomous Database.
db_tools_detailsarrayThe list of database management tools enabled for the Autonomous Database.
db_versionstringThe Oracle Database software version of the Autonomous Database.
db_workloadstringThe intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX. (OLTP, AJD, APEX, LH)
display_namestringThe user-friendly name of the Autonomous Database.
encryption_summaryobjectThe encryption configuration for the Autonomous Database.
failed_data_recovery_in_secondsintegerThe amount of time, in seconds, that the data in the Autonomous Database is behind the data in the primary database.
in_memory_area_in_gbsintegerThe size of the in-memory area of the Autonomous Database, in GB.
is_auto_scaling_enabledbooleanIndicates whether automatic scaling of the compute resources is enabled for the Autonomous Database.
is_auto_scaling_for_storage_enabledbooleanIndicates whether automatic scaling of the storage is enabled for the Autonomous Database.
is_backup_retention_lockedbooleanIndicates whether the backup retention period of the Autonomous Database is locked.
is_local_data_guard_enabledbooleanIndicates whether local Oracle Data Guard is enabled for the Autonomous Database.
is_mtls_connection_requiredbooleanIndicates whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.
is_reconnect_clone_enabledbooleanIndicates whether reconnecting the refreshable clone to its source Autonomous Database is enabled.
is_refreshable_clonebooleanIndicates whether the Autonomous Database is a refreshable clone.
is_remote_data_guard_enabledbooleanIndicates whether remote Oracle Data Guard is enabled for the Autonomous Database.
license_modelstringThe Oracle license model that applies to the Autonomous Database. (BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED)
local_adg_auto_failover_max_data_loss_limitintegerThe maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database.
local_disaster_recovery_typestringThe type of local disaster recovery configured for the Autonomous Database. (ADG, BACKUP_BASED)
local_standby_dbobjectThe details of the local standby Autonomous Database in an Oracle Data Guard configuration.
long_term_backup_scheduleobjectThe long-term backup schedule for the Autonomous Database.
maintenance_target_componentstringThe component on the Autonomous Database that the current maintenance is being applied to.
memory_per_oracle_compute_unit_in_gbsintegerThe amount of memory allocated per Oracle Compute Unit, in GB.
ncharacter_setstringThe national character set of the Autonomous Database.
net_services_architecturestringThe Oracle Net Services architecture of the Autonomous Database, either dedicated or shared. (DEDICATED, SHARED)
next_long_term_backup_time_stampstring (date-time)The date and time of the next scheduled long-term backup of the Autonomous Database.
oci_resource_anchor_namestringThe name of the Oracle Cloud Infrastructure (OCI) resource anchor associated with the Autonomous Database.
oci_urlstringThe URL for accessing the OCI console page for the Autonomous Database.
ocidstringThe Oracle Cloud Identifier (OCID) of the Autonomous Database.
odb_network_arnstringThe Amazon Resource Name (ARN) of the ODB network associated with the Autonomous Database. (pattern: <code>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-z0-9-_]{6,64}</code>)
odb_network_idstringThe unique identifier of the ODB network associated with the Autonomous Database. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
open_modestringThe mode in which the Autonomous Database is open, either read-only or read/write. (READ_ONLY, READ_WRITE)
operations_insights_statusstringThe status of Oracle Operations Insights for the Autonomous Database. (ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING)
peer_db_idsarrayThe list of unique identifiers of the peer Autonomous Databases.
percent_progressnumber (float)The progress of the current operation on the Autonomous Database, as a percentage.
permission_levelstringThe permission level of the Autonomous Database. (RESTRICTED, UNRESTRICTED)
private_endpointstringThe private endpoint for the Autonomous Database.
private_endpoint_ipstringThe private endpoint IP address for the Autonomous Database.
private_endpoint_labelstringThe private endpoint label for the Autonomous Database.
provisionable_cpusarrayThe list of CPU core counts that you can provision for the Autonomous Database.
refreshable_modestringThe refresh mode of the refreshable clone Autonomous Database. (AUTOMATIC, MANUAL)
refreshable_statusstringThe refresh status of the refreshable clone Autonomous Database. (REFRESHING, NOT_REFRESHING)
remote_disaster_recovery_configurationobjectThe configuration of the remote disaster recovery for the Autonomous Database.
resource_pool_leader_idstringThe unique identifier of the resource pool leader Autonomous Database.
resource_pool_summaryobjectThe configuration of the resource pool for the Autonomous Database.
rolestringThe Oracle Data Guard role of the Autonomous Database. (PRIMARY, STANDBY, DISABLED_STANDBY, BACKUP_COPY, SNAPSHOT_STANDBY)
scheduled_operationsarrayThe list of scheduled start and stop times for the Autonomous Database.
service_console_urlstringThe URL for accessing the Oracle service console for the Autonomous Database.
source_idstringThe unique identifier of the source from which the Autonomous Database was created.
sql_web_developer_urlstringThe URL for accessing Oracle SQL Developer Web for the Autonomous Database.
standby_allowlisted_ipsarrayThe list of IP addresses that are allowed to access the standby Autonomous Database.
standby_allowlisted_ips_sourcestringThe source of the allowlisted IP addresses for the standby Autonomous Database. (PRIMARY, SEPARATE, NOT_APPLICABLE)
standby_dbobjectThe details of the standby Autonomous Database in a cross-Region Oracle Data Guard configuration.
statusstringThe current status of the Autonomous Database. (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)
status_reasonstringAdditional information about the current status of the Autonomous Database, if applicable.
time_data_guard_role_changedstring (date-time)The date and time when the Oracle Data Guard role of the Autonomous Database last changed.
time_deletion_of_free_autonomous_databasestring (date-time)The date and time when the inactive Always Free Autonomous Database is scheduled to be automatically deleted.
time_disaster_recovery_role_changedstring (date-time)The date and time when the disaster recovery role of the Autonomous Database last changed.
time_local_data_guard_enabledstring (date-time)The date and time when local Oracle Data Guard was enabled for the Autonomous Database.
time_maintenance_beginstring (date-time)The date and time when the next maintenance of the Autonomous Database begins.
time_maintenance_endstring (date-time)The date and time when the next maintenance of the Autonomous Database ends.
time_of_auto_refresh_startstring (date-time)The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts.
time_of_last_backupstring (date-time)The date and time of the last backup of the Autonomous Database.
time_of_last_failoverstring (date-time)The date and time of the last failover operation for the Autonomous Database.
time_of_last_refreshstring (date-time)The date and time of the last refresh of the refreshable clone Autonomous Database.
time_of_last_refresh_pointstring (date-time)The date and time as of which the data in the refreshable clone Autonomous Database is current.
time_of_last_switchoverstring (date-time)The date and time of the last switchover operation for the Autonomous Database.
time_of_next_refreshstring (date-time)The date and time of the next scheduled refresh of the refreshable clone Autonomous Database.
time_reclamation_of_free_autonomous_databasestring (date-time)The date and time when the Always Free Autonomous Database is scheduled to be stopped because of inactivity.
time_undeletedstring (date-time)The date and time when the Autonomous Database was restored after deletion.
time_until_reconnect_clone_enabledstring (date-time)The date and time until which reconnecting the refreshable clone to its source Autonomous Database is allowed.
total_backup_storage_size_in_gbsnumber (double)The total amount of backup storage used by the Autonomous Database, in GB.
used_data_storage_size_in_gbsintegerThe amount of data storage currently in use by the Autonomous Database, in GB.
used_data_storage_size_in_tbsnumber (double)The amount of data storage currently in use by the Autonomous Database, in TB.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_autonomous_databaseselectregionGets information about a specific Autonomous Database.
list_autonomous_databasesselectregionReturns information about the Autonomous Databases owned by your Amazon Web Services account in the current Amazon Web Services Region.
create_autonomous_database_walletinsertregion, autonomousDatabaseIdCreates a new wallet for the specified Autonomous Database.
create_autonomous_databaseinsertregionCreates a new Autonomous Database.
update_autonomous_databaseupdateregion, autonomousDatabaseIdUpdates the properties of an Autonomous Database.
delete_autonomous_databasedeleteregionDeletes the specified Autonomous Database.
failover_autonomous_databaseexecregion, autonomousDatabaseIdInitiates a failover of the specified Autonomous Database to a standby peer database.
reboot_autonomous_databaseexecregion, autonomousDatabaseIdReboots the specified Autonomous Database.
restore_autonomous_databaseexecregion, autonomousDatabaseId, timestampRestores the specified Autonomous Database to a point in time.
shrink_autonomous_databaseexecregion, autonomousDatabaseIdShrinks the storage of the specified Autonomous Database to reclaim unused space.
start_autonomous_databaseexecregion, autonomousDatabaseIdStarts the specified Autonomous Database.
stop_autonomous_databaseexecregion, autonomousDatabaseIdStops the specified Autonomous Database.
switchover_autonomous_databaseexecregion, autonomousDatabaseIdPerforms a switchover of the specified Autonomous Database to a standby peer database.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Gets information about a specific Autonomous Database.

SELECT
actual_used_data_storage_size_in_tbs,
admin_password_source_summary,
allocated_storage_size_in_tbs,
allowlisted_ips,
apex_details,
auto_refresh_frequency_in_seconds,
auto_refresh_point_lag_in_seconds,
autonomous_database_arn,
autonomous_database_id,
autonomous_maintenance_schedule_type,
availability_zone,
availability_zone_id,
available_upgrade_versions,
backup_retention_period_in_days,
byol_compute_count_limit,
character_set,
clone_table_space_list,
compute_count,
compute_model,
connection_string_details,
connection_urls,
cpu_core_count,
created_at,
customer_contacts,
data_safe_status,
data_storage_size_in_gbs,
data_storage_size_in_tbs,
database_edition,
database_management_status,
database_type,
db_name,
db_tools_details,
db_version,
db_workload,
display_name,
encryption_summary,
failed_data_recovery_in_seconds,
in_memory_area_in_gbs,
is_auto_scaling_enabled,
is_auto_scaling_for_storage_enabled,
is_backup_retention_locked,
is_local_data_guard_enabled,
is_mtls_connection_required,
is_reconnect_clone_enabled,
is_refreshable_clone,
is_remote_data_guard_enabled,
license_model,
local_adg_auto_failover_max_data_loss_limit,
local_disaster_recovery_type,
local_standby_db,
long_term_backup_schedule,
maintenance_target_component,
memory_per_oracle_compute_unit_in_gbs,
ncharacter_set,
net_services_architecture,
next_long_term_backup_time_stamp,
oci_resource_anchor_name,
oci_url,
ocid,
odb_network_arn,
odb_network_id,
open_mode,
operations_insights_status,
peer_db_ids,
percent_progress,
permission_level,
private_endpoint,
private_endpoint_ip,
private_endpoint_label,
provisionable_cpus,
refreshable_mode,
refreshable_status,
remote_disaster_recovery_configuration,
resource_pool_leader_id,
resource_pool_summary,
role,
scheduled_operations,
service_console_url,
source_id,
sql_web_developer_url,
standby_allowlisted_ips,
standby_allowlisted_ips_source,
standby_db,
status,
status_reason,
time_data_guard_role_changed,
time_deletion_of_free_autonomous_database,
time_disaster_recovery_role_changed,
time_local_data_guard_enabled,
time_maintenance_begin,
time_maintenance_end,
time_of_auto_refresh_start,
time_of_last_backup,
time_of_last_failover,
time_of_last_refresh,
time_of_last_refresh_point,
time_of_last_switchover,
time_of_next_refresh,
time_reclamation_of_free_autonomous_database,
time_undeleted,
time_until_reconnect_clone_enabled,
total_backup_storage_size_in_gbs,
used_data_storage_size_in_gbs,
used_data_storage_size_in_tbs
FROM aws.odb.autonomous_databases
WHERE region = '{{ region }}' -- required
;

INSERT examples

Creates a new wallet for the specified Autonomous Database.

INSERT INTO aws.odb.autonomous_databases (
autonomousDatabaseId,
walletType,
password,
passwordSource,
passwordSourceConfiguration,
clientToken,
region
)
SELECT
'{{ autonomousDatabaseId }}' /* required */,
'{{ walletType }}',
'{{ password }}',
'{{ passwordSource }}',
'{{ passwordSourceConfiguration }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
autonomous_database_wallet_file
;

UPDATE examples

Updates the properties of an Autonomous Database.

UPDATE aws.odb.autonomous_databases
SET
autonomousDatabaseId = '{{ autonomousDatabaseId }}',
adminPassword = '{{ adminPassword }}',
computeCount = {{ computeCount }},
cpuCoreCount = {{ cpuCoreCount }},
dataStorageSizeInTBs = {{ dataStorageSizeInTBs }},
dataStorageSizeInGBs = {{ dataStorageSizeInGBs }},
displayName = '{{ displayName }}',
dbName = '{{ dbName }}',
dbVersion = '{{ dbVersion }}',
dbWorkload = '{{ dbWorkload }}',
dbToolsDetails = '{{ dbToolsDetails }}',
databaseEdition = '{{ databaseEdition }}',
licenseModel = '{{ licenseModel }}',
isAutoScalingEnabled = {{ isAutoScalingEnabled }},
isAutoScalingForStorageEnabled = {{ isAutoScalingForStorageEnabled }},
isBackupRetentionLocked = {{ isBackupRetentionLocked }},
isLocalDataGuardEnabled = {{ isLocalDataGuardEnabled }},
isMtlsConnectionRequired = {{ isMtlsConnectionRequired }},
isRefreshableClone = {{ isRefreshableClone }},
isDisconnectPeer = {{ isDisconnectPeer }},
backupRetentionPeriodInDays = {{ backupRetentionPeriodInDays }},
byolComputeCountLimit = {{ byolComputeCountLimit }},
localAdgAutoFailoverMaxDataLossLimit = {{ localAdgAutoFailoverMaxDataLossLimit }},
autonomousMaintenanceScheduleType = '{{ autonomousMaintenanceScheduleType }}',
customerContactsToSendToOCI = '{{ customerContactsToSendToOCI }}',
scheduledOperations = '{{ scheduledOperations }}',
longTermBackupSchedule = '{{ longTermBackupSchedule }}',
openMode = '{{ openMode }}',
permissionLevel = '{{ permissionLevel }}',
refreshableMode = '{{ refreshableMode }}',
privateEndpointIp = '{{ privateEndpointIp }}',
privateEndpointLabel = '{{ privateEndpointLabel }}',
peerDbId = '{{ peerDbId }}',
resourcePoolLeaderId = '{{ resourcePoolLeaderId }}',
resourcePoolSummary = '{{ resourcePoolSummary }}',
standbyAllowlistedIpsSource = '{{ standbyAllowlistedIpsSource }}',
standbyAllowlistedIps = '{{ standbyAllowlistedIps }}',
allowlistedIps = '{{ allowlistedIps }}',
autoRefreshFrequencyInSeconds = {{ autoRefreshFrequencyInSeconds }},
autoRefreshPointLagInSeconds = {{ autoRefreshPointLagInSeconds }},
timeOfAutoRefreshStart = '{{ timeOfAutoRefreshStart }}',
encryptionKeyProvider = '{{ encryptionKeyProvider }}',
encryptionKeyConfiguration = '{{ encryptionKeyConfiguration }}',
adminPasswordSource = '{{ adminPasswordSource }}',
adminPasswordSourceConfiguration = '{{ adminPasswordSourceConfiguration }}'
WHERE
region = '{{ region }}' --required
AND autonomousDatabaseId = '{{ autonomousDatabaseId }}' --required
RETURNING
autonomous_database_id,
display_name,
status,
status_reason;

DELETE examples

Deletes the specified Autonomous Database.

DELETE FROM aws.odb.autonomous_databases
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

Initiates a failover of the specified Autonomous Database to a standby peer database.

EXEC aws.odb.autonomous_databases.failover_autonomous_database
@region='{{ region }}' --required
@@json=
'{
"autonomousDatabaseId": "{{ autonomousDatabaseId }}",
"peerDbArn": "{{ peerDbArn }}"
}'
;