autonomous_databases
Creates, updates, deletes, gets or lists an autonomous_databases resource.
Overview
| Name | autonomous_databases |
| Type | Resource |
| Id | aws.odb.autonomous_databases |
Fields
The following fields are returned by SELECT queries:
- get_autonomous_database
- list_autonomous_databases
| Name | Datatype | Description |
|---|---|---|
actual_used_data_storage_size_in_tbs | number (double) | The actual amount of data storage currently in use by the Autonomous Database, in TB. |
admin_password_source_summary | object | The summary of the admin password source configuration for the Autonomous Database. |
allocated_storage_size_in_tbs | number (double) | The amount of storage currently allocated to the Autonomous Database, in TB. |
allowlisted_ips | array | The list of IP addresses that are allowed to access the Autonomous Database. |
apex_details | object | The Oracle Application Express (APEX) details for the Autonomous Database. |
auto_refresh_frequency_in_seconds | integer | The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed. |
auto_refresh_point_lag_in_seconds | integer | The time lag, in seconds, between the refreshable clone and its source Autonomous Database. |
autonomous_database_arn | string | The 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_id | string | The 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_ |
autonomous_maintenance_schedule_type | string | The maintenance schedule type for the Autonomous Database. (EARLY, REGULAR) |
availability_zone | string | The Availability Zone where the Autonomous Database is located. |
availability_zone_id | string | The unique identifier of the Availability Zone where the Autonomous Database is located. |
available_upgrade_versions | array | The list of Oracle Database software versions to which the Autonomous Database can be upgraded. |
backup_retention_period_in_days | integer | The retention period, in days, for automatic backups of the Autonomous Database. |
byol_compute_count_limit | integer | The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model. |
character_set | string | The character set of the Autonomous Database. |
clone_table_space_list | array | The list of tablespace identifiers to clone for the Autonomous Database. |
compute_count | number (float) | The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), assigned to the Autonomous Database. |
compute_model | string | The compute model of the Autonomous Database, either ECPU or OCPU. (ECPU, OCPU) |
connection_string_details | object | The connection string details for the Autonomous Database. |
connection_urls | object | The connection URLs for accessing tools and services for the Autonomous Database. |
cpu_core_count | integer | The number of CPU cores allocated to the Autonomous Database. |
created_at | string (date-time) | The date and time when the Autonomous Database was created. |
customer_contacts | array | The list of customer contacts that receive operational notifications from Oracle for the Autonomous Database. |
data_safe_status | string | The status of the Oracle Data Safe registration for the Autonomous Database. (REGISTERING, REGISTERED, DEREGISTERING, NOT_REGISTERED, FAILED) |
data_storage_size_in_gbs | integer | The size, in gigabytes (GB), of the data volume allocated for the Autonomous Database. |
data_storage_size_in_tbs | number (double) | The size, in terabytes (TB), of the data volume allocated for the Autonomous Database. |
database_edition | string | The Oracle Database edition of the Autonomous Database. (STANDARD_EDITION, ENTERPRISE_EDITION) |
database_management_status | string | The status of Oracle Database Management for the Autonomous Database. (ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING) |
database_type | string | The type of the Autonomous Database, either a regular database or a clone. (REGULAR, CLONE) |
db_name | string | The name of the Autonomous Database. |
db_tools_details | array | The list of database management tools enabled for the Autonomous Database. |
db_version | string | The Oracle Database software version of the Autonomous Database. |
db_workload | string | The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX. (OLTP, AJD, APEX, LH) |
display_name | string | The user-friendly name of the Autonomous Database. |
encryption_summary | object | The encryption configuration for the Autonomous Database. |
failed_data_recovery_in_seconds | integer | The amount of time, in seconds, that the data in the Autonomous Database is behind the data in the primary database. |
in_memory_area_in_gbs | integer | The size of the in-memory area of the Autonomous Database, in GB. |
is_auto_scaling_enabled | boolean | Indicates whether automatic scaling of the compute resources is enabled for the Autonomous Database. |
is_auto_scaling_for_storage_enabled | boolean | Indicates whether automatic scaling of the storage is enabled for the Autonomous Database. |
is_backup_retention_locked | boolean | Indicates whether the backup retention period of the Autonomous Database is locked. |
is_local_data_guard_enabled | boolean | Indicates whether local Oracle Data Guard is enabled for the Autonomous Database. |
is_mtls_connection_required | boolean | Indicates whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database. |
is_reconnect_clone_enabled | boolean | Indicates whether reconnecting the refreshable clone to its source Autonomous Database is enabled. |
is_refreshable_clone | boolean | Indicates whether the Autonomous Database is a refreshable clone. |
is_remote_data_guard_enabled | boolean | Indicates whether remote Oracle Data Guard is enabled for the Autonomous Database. |
license_model | string | The Oracle license model that applies to the Autonomous Database. (BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED) |
local_adg_auto_failover_max_data_loss_limit | integer | The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database. |
local_disaster_recovery_type | string | The type of local disaster recovery configured for the Autonomous Database. (ADG, BACKUP_BASED) |
local_standby_db | object | The details of the local standby Autonomous Database in an Oracle Data Guard configuration. |
long_term_backup_schedule | object | The long-term backup schedule for the Autonomous Database. |
maintenance_target_component | string | The component on the Autonomous Database that the current maintenance is being applied to. |
memory_per_oracle_compute_unit_in_gbs | integer | The amount of memory allocated per Oracle Compute Unit, in GB. |
ncharacter_set | string | The national character set of the Autonomous Database. |
net_services_architecture | string | The Oracle Net Services architecture of the Autonomous Database, either dedicated or shared. (DEDICATED, SHARED) |
next_long_term_backup_time_stamp | string (date-time) | The date and time of the next scheduled long-term backup of the Autonomous Database. |
oci_resource_anchor_name | string | The name of the Oracle Cloud Infrastructure (OCI) resource anchor associated with the Autonomous Database. |
oci_url | string | The URL for accessing the OCI console page for the Autonomous Database. |
ocid | string | The Oracle Cloud Identifier (OCID) of the Autonomous Database. |
odb_network_arn | string | The 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_id | string | The unique identifier of the ODB network associated with the Autonomous Database. (pattern: <code>[a-zA-Z0-9_~.-]+</code>) |
open_mode | string | The mode in which the Autonomous Database is open, either read-only or read/write. (READ_ONLY, READ_WRITE) |
operations_insights_status | string | The status of Oracle Operations Insights for the Autonomous Database. (ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING) |
peer_db_ids | array | The list of unique identifiers of the peer Autonomous Databases. |
percent_progress | number (float) | The progress of the current operation on the Autonomous Database, as a percentage. |
permission_level | string | The permission level of the Autonomous Database. (RESTRICTED, UNRESTRICTED) |
private_endpoint | string | The private endpoint for the Autonomous Database. |
private_endpoint_ip | string | The private endpoint IP address for the Autonomous Database. |
private_endpoint_label | string | The private endpoint label for the Autonomous Database. |
provisionable_cpus | array | The list of CPU core counts that you can provision for the Autonomous Database. |
refreshable_mode | string | The refresh mode of the refreshable clone Autonomous Database. (AUTOMATIC, MANUAL) |
refreshable_status | string | The refresh status of the refreshable clone Autonomous Database. (REFRESHING, NOT_REFRESHING) |
remote_disaster_recovery_configuration | object | The configuration of the remote disaster recovery for the Autonomous Database. |
resource_pool_leader_id | string | The unique identifier of the resource pool leader Autonomous Database. |
resource_pool_summary | object | The configuration of the resource pool for the Autonomous Database. |
role | string | The Oracle Data Guard role of the Autonomous Database. (PRIMARY, STANDBY, DISABLED_STANDBY, BACKUP_COPY, SNAPSHOT_STANDBY) |
scheduled_operations | array | The list of scheduled start and stop times for the Autonomous Database. |
service_console_url | string | The URL for accessing the Oracle service console for the Autonomous Database. |
source_id | string | The unique identifier of the source from which the Autonomous Database was created. |
sql_web_developer_url | string | The URL for accessing Oracle SQL Developer Web for the Autonomous Database. |
standby_allowlisted_ips | array | The list of IP addresses that are allowed to access the standby Autonomous Database. |
standby_allowlisted_ips_source | string | The source of the allowlisted IP addresses for the standby Autonomous Database. (PRIMARY, SEPARATE, NOT_APPLICABLE) |
standby_db | object | The details of the standby Autonomous Database in a cross-Region Oracle Data Guard configuration. |
status | string | The 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_reason | string | Additional information about the current status of the Autonomous Database, if applicable. |
time_data_guard_role_changed | string (date-time) | The date and time when the Oracle Data Guard role of the Autonomous Database last changed. |
time_deletion_of_free_autonomous_database | string (date-time) | The date and time when the inactive Always Free Autonomous Database is scheduled to be automatically deleted. |
time_disaster_recovery_role_changed | string (date-time) | The date and time when the disaster recovery role of the Autonomous Database last changed. |
time_local_data_guard_enabled | string (date-time) | The date and time when local Oracle Data Guard was enabled for the Autonomous Database. |
time_maintenance_begin | string (date-time) | The date and time when the next maintenance of the Autonomous Database begins. |
time_maintenance_end | string (date-time) | The date and time when the next maintenance of the Autonomous Database ends. |
time_of_auto_refresh_start | string (date-time) | The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts. |
time_of_last_backup | string (date-time) | The date and time of the last backup of the Autonomous Database. |
time_of_last_failover | string (date-time) | The date and time of the last failover operation for the Autonomous Database. |
time_of_last_refresh | string (date-time) | The date and time of the last refresh of the refreshable clone Autonomous Database. |
time_of_last_refresh_point | string (date-time) | The date and time as of which the data in the refreshable clone Autonomous Database is current. |
time_of_last_switchover | string (date-time) | The date and time of the last switchover operation for the Autonomous Database. |
time_of_next_refresh | string (date-time) | The date and time of the next scheduled refresh of the refreshable clone Autonomous Database. |
time_reclamation_of_free_autonomous_database | string (date-time) | The date and time when the Always Free Autonomous Database is scheduled to be stopped because of inactivity. |
time_undeleted | string (date-time) | The date and time when the Autonomous Database was restored after deletion. |
time_until_reconnect_clone_enabled | string (date-time) | The date and time until which reconnecting the refreshable clone to its source Autonomous Database is allowed. |
total_backup_storage_size_in_gbs | number (double) | The total amount of backup storage used by the Autonomous Database, in GB. |
used_data_storage_size_in_gbs | integer | The amount of data storage currently in use by the Autonomous Database, in GB. |
used_data_storage_size_in_tbs | number (double) | The amount of data storage currently in use by the Autonomous Database, in TB. |
| Name | Datatype | Description |
|---|---|---|
actual_used_data_storage_size_in_tbs | number (double) | The actual amount of data storage currently in use by the Autonomous Database, in TB. |
admin_password_source_summary | object | The summary of the admin password source configuration for the Autonomous Database. |
allocated_storage_size_in_tbs | number (double) | The amount of storage currently allocated to the Autonomous Database, in TB. |
allowlisted_ips | array | The list of IP addresses that are allowed to access the Autonomous Database. |
apex_details | object | The Oracle Application Express (APEX) details for the Autonomous Database. |
auto_refresh_frequency_in_seconds | integer | The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed. |
auto_refresh_point_lag_in_seconds | integer | The time lag, in seconds, between the refreshable clone and its source Autonomous Database. |
autonomous_database_arn | string | The 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_id | string | The 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_ |
autonomous_maintenance_schedule_type | string | The maintenance schedule type for the Autonomous Database. (EARLY, REGULAR) |
availability_zone | string | The Availability Zone where the Autonomous Database is located. |
availability_zone_id | string | The unique identifier of the Availability Zone where the Autonomous Database is located. |
available_upgrade_versions | array | The list of Oracle Database software versions to which the Autonomous Database can be upgraded. |
backup_retention_period_in_days | integer | The retention period, in days, for automatic backups of the Autonomous Database. |
byol_compute_count_limit | integer | The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model. |
character_set | string | The character set of the Autonomous Database. |
clone_table_space_list | array | The list of tablespace identifiers to clone for the Autonomous Database. |
compute_count | number (float) | The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), assigned to the Autonomous Database. |
compute_model | string | The compute model of the Autonomous Database, either ECPU or OCPU. (ECPU, OCPU) |
connection_string_details | object | The connection string details for the Autonomous Database. |
connection_urls | object | The connection URLs for accessing tools and services for the Autonomous Database. |
cpu_core_count | integer | The number of CPU cores allocated to the Autonomous Database. |
created_at | string (date-time) | The date and time when the Autonomous Database was created. |
customer_contacts | array | The list of customer contacts that receive operational notifications from Oracle for the Autonomous Database. |
data_safe_status | string | The status of the Oracle Data Safe registration for the Autonomous Database. (REGISTERING, REGISTERED, DEREGISTERING, NOT_REGISTERED, FAILED) |
data_storage_size_in_gbs | integer | The size, in gigabytes (GB), of the data volume allocated for the Autonomous Database. |
data_storage_size_in_tbs | number (double) | The size, in terabytes (TB), of the data volume allocated for the Autonomous Database. |
database_edition | string | The Oracle Database edition of the Autonomous Database. (STANDARD_EDITION, ENTERPRISE_EDITION) |
database_management_status | string | The status of Oracle Database Management for the Autonomous Database. (ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING) |
database_type | string | The type of the Autonomous Database, either a regular database or a clone. (REGULAR, CLONE) |
db_name | string | The name of the Autonomous Database. |
db_tools_details | array | The list of database management tools enabled for the Autonomous Database. |
db_version | string | The Oracle Database software version of the Autonomous Database. |
db_workload | string | The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX. (OLTP, AJD, APEX, LH) |
display_name | string | The user-friendly name of the Autonomous Database. |
encryption_summary | object | The encryption configuration for the Autonomous Database. |
failed_data_recovery_in_seconds | integer | The amount of time, in seconds, that the data in the Autonomous Database is behind the data in the primary database. |
in_memory_area_in_gbs | integer | The size of the in-memory area of the Autonomous Database, in GB. |
is_auto_scaling_enabled | boolean | Indicates whether automatic scaling of the compute resources is enabled for the Autonomous Database. |
is_auto_scaling_for_storage_enabled | boolean | Indicates whether automatic scaling of the storage is enabled for the Autonomous Database. |
is_backup_retention_locked | boolean | Indicates whether the backup retention period of the Autonomous Database is locked. |
is_local_data_guard_enabled | boolean | Indicates whether local Oracle Data Guard is enabled for the Autonomous Database. |
is_mtls_connection_required | boolean | Indicates whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database. |
is_reconnect_clone_enabled | boolean | Indicates whether reconnecting the refreshable clone to its source Autonomous Database is enabled. |
is_refreshable_clone | boolean | Indicates whether the Autonomous Database is a refreshable clone. |
is_remote_data_guard_enabled | boolean | Indicates whether remote Oracle Data Guard is enabled for the Autonomous Database. |
license_model | string | The Oracle license model that applies to the Autonomous Database. (BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED) |
local_adg_auto_failover_max_data_loss_limit | integer | The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database. |
local_disaster_recovery_type | string | The type of local disaster recovery configured for the Autonomous Database. (ADG, BACKUP_BASED) |
local_standby_db | object | The details of the local standby Autonomous Database in an Oracle Data Guard configuration. |
long_term_backup_schedule | object | The long-term backup schedule for the Autonomous Database. |
maintenance_target_component | string | The component on the Autonomous Database that the current maintenance is being applied to. |
memory_per_oracle_compute_unit_in_gbs | integer | The amount of memory allocated per Oracle Compute Unit, in GB. |
ncharacter_set | string | The national character set of the Autonomous Database. |
net_services_architecture | string | The Oracle Net Services architecture of the Autonomous Database, either dedicated or shared. (DEDICATED, SHARED) |
next_long_term_backup_time_stamp | string (date-time) | The date and time of the next scheduled long-term backup of the Autonomous Database. |
oci_resource_anchor_name | string | The name of the Oracle Cloud Infrastructure (OCI) resource anchor associated with the Autonomous Database. |
oci_url | string | The URL for accessing the OCI console page for the Autonomous Database. |
ocid | string | The Oracle Cloud Identifier (OCID) of the Autonomous Database. |
odb_network_arn | string | The 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_id | string | The unique identifier of the ODB network associated with the Autonomous Database. (pattern: <code>[a-zA-Z0-9_~.-]+</code>) |
open_mode | string | The mode in which the Autonomous Database is open, either read-only or read/write. (READ_ONLY, READ_WRITE) |
operations_insights_status | string | The status of Oracle Operations Insights for the Autonomous Database. (ENABLING, ENABLED, DISABLING, NOT_ENABLED, FAILED_ENABLING, FAILED_DISABLING) |
peer_db_ids | array | The list of unique identifiers of the peer Autonomous Databases. |
percent_progress | number (float) | The progress of the current operation on the Autonomous Database, as a percentage. |
permission_level | string | The permission level of the Autonomous Database. (RESTRICTED, UNRESTRICTED) |
private_endpoint | string | The private endpoint for the Autonomous Database. |
private_endpoint_ip | string | The private endpoint IP address for the Autonomous Database. |
private_endpoint_label | string | The private endpoint label for the Autonomous Database. |
provisionable_cpus | array | The list of CPU core counts that you can provision for the Autonomous Database. |
refreshable_mode | string | The refresh mode of the refreshable clone Autonomous Database. (AUTOMATIC, MANUAL) |
refreshable_status | string | The refresh status of the refreshable clone Autonomous Database. (REFRESHING, NOT_REFRESHING) |
remote_disaster_recovery_configuration | object | The configuration of the remote disaster recovery for the Autonomous Database. |
resource_pool_leader_id | string | The unique identifier of the resource pool leader Autonomous Database. |
resource_pool_summary | object | The configuration of the resource pool for the Autonomous Database. |
role | string | The Oracle Data Guard role of the Autonomous Database. (PRIMARY, STANDBY, DISABLED_STANDBY, BACKUP_COPY, SNAPSHOT_STANDBY) |
scheduled_operations | array | The list of scheduled start and stop times for the Autonomous Database. |
service_console_url | string | The URL for accessing the Oracle service console for the Autonomous Database. |
source_id | string | The unique identifier of the source from which the Autonomous Database was created. |
sql_web_developer_url | string | The URL for accessing Oracle SQL Developer Web for the Autonomous Database. |
standby_allowlisted_ips | array | The list of IP addresses that are allowed to access the standby Autonomous Database. |
standby_allowlisted_ips_source | string | The source of the allowlisted IP addresses for the standby Autonomous Database. (PRIMARY, SEPARATE, NOT_APPLICABLE) |
standby_db | object | The details of the standby Autonomous Database in a cross-Region Oracle Data Guard configuration. |
status | string | The 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_reason | string | Additional information about the current status of the Autonomous Database, if applicable. |
time_data_guard_role_changed | string (date-time) | The date and time when the Oracle Data Guard role of the Autonomous Database last changed. |
time_deletion_of_free_autonomous_database | string (date-time) | The date and time when the inactive Always Free Autonomous Database is scheduled to be automatically deleted. |
time_disaster_recovery_role_changed | string (date-time) | The date and time when the disaster recovery role of the Autonomous Database last changed. |
time_local_data_guard_enabled | string (date-time) | The date and time when local Oracle Data Guard was enabled for the Autonomous Database. |
time_maintenance_begin | string (date-time) | The date and time when the next maintenance of the Autonomous Database begins. |
time_maintenance_end | string (date-time) | The date and time when the next maintenance of the Autonomous Database ends. |
time_of_auto_refresh_start | string (date-time) | The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts. |
time_of_last_backup | string (date-time) | The date and time of the last backup of the Autonomous Database. |
time_of_last_failover | string (date-time) | The date and time of the last failover operation for the Autonomous Database. |
time_of_last_refresh | string (date-time) | The date and time of the last refresh of the refreshable clone Autonomous Database. |
time_of_last_refresh_point | string (date-time) | The date and time as of which the data in the refreshable clone Autonomous Database is current. |
time_of_last_switchover | string (date-time) | The date and time of the last switchover operation for the Autonomous Database. |
time_of_next_refresh | string (date-time) | The date and time of the next scheduled refresh of the refreshable clone Autonomous Database. |
time_reclamation_of_free_autonomous_database | string (date-time) | The date and time when the Always Free Autonomous Database is scheduled to be stopped because of inactivity. |
time_undeleted | string (date-time) | The date and time when the Autonomous Database was restored after deletion. |
time_until_reconnect_clone_enabled | string (date-time) | The date and time until which reconnecting the refreshable clone to its source Autonomous Database is allowed. |
total_backup_storage_size_in_gbs | number (double) | The total amount of backup storage used by the Autonomous Database, in GB. |
used_data_storage_size_in_gbs | integer | The amount of data storage currently in use by the Autonomous Database, in GB. |
used_data_storage_size_in_tbs | number (double) | The amount of data storage currently in use by the Autonomous Database, in TB. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_autonomous_database | select | region | Gets information about a specific Autonomous Database. | |
list_autonomous_databases | select | region | Returns information about the Autonomous Databases owned by your Amazon Web Services account in the current Amazon Web Services Region. | |
create_autonomous_database_wallet | insert | region, autonomousDatabaseId | Creates a new wallet for the specified Autonomous Database. | |
create_autonomous_database | insert | region | Creates a new Autonomous Database. | |
update_autonomous_database | update | region, autonomousDatabaseId | Updates the properties of an Autonomous Database. | |
delete_autonomous_database | delete | region | Deletes the specified Autonomous Database. | |
failover_autonomous_database | exec | region, autonomousDatabaseId | Initiates a failover of the specified Autonomous Database to a standby peer database. | |
reboot_autonomous_database | exec | region, autonomousDatabaseId | Reboots the specified Autonomous Database. | |
restore_autonomous_database | exec | region, autonomousDatabaseId, timestamp | Restores the specified Autonomous Database to a point in time. | |
shrink_autonomous_database | exec | region, autonomousDatabaseId | Shrinks the storage of the specified Autonomous Database to reclaim unused space. | |
start_autonomous_database | exec | region, autonomousDatabaseId | Starts the specified Autonomous Database. | |
stop_autonomous_database | exec | region, autonomousDatabaseId | Stops the specified Autonomous Database. | |
switchover_autonomous_database | exec | region, autonomousDatabaseId | Performs 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.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_autonomous_database
- list_autonomous_databases
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
;
Returns information about the Autonomous Databases owned by your Amazon Web Services account in the current Amazon Web Services Region.
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
- create_autonomous_database_wallet
- create_autonomous_database
- Manifest
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
;
Creates a new Autonomous Database.
INSERT INTO aws.odb.autonomous_databases (
odbNetworkId,
displayName,
dbName,
adminPassword,
computeCount,
dataStorageSizeInTBs,
dataStorageSizeInGBs,
dbWorkload,
isAutoScalingEnabled,
isAutoScalingForStorageEnabled,
licenseModel,
characterSet,
ncharacterSet,
dbVersion,
databaseEdition,
standbyAllowlistedIpsSource,
autonomousMaintenanceScheduleType,
backupRetentionPeriodInDays,
byolComputeCountLimit,
cpuCoreCount,
customerContactsToSendToOCI,
privateEndpointIp,
privateEndpointLabel,
resourcePoolLeaderId,
resourcePoolSummary,
scheduledOperations,
standbyAllowlistedIps,
allowlistedIps,
transportableTablespace,
isBackupRetentionLocked,
isLocalDataGuardEnabled,
isMtlsConnectionRequired,
dbToolsDetails,
source,
sourceConfiguration,
encryptionKeyProvider,
encryptionKeyConfiguration,
adminPasswordSource,
adminPasswordSourceConfiguration,
clientToken,
tags,
region
)
SELECT
'{{ odbNetworkId }}',
'{{ displayName }}',
'{{ dbName }}',
'{{ adminPassword }}',
{{ computeCount }},
{{ dataStorageSizeInTBs }},
{{ dataStorageSizeInGBs }},
'{{ dbWorkload }}',
{{ isAutoScalingEnabled }},
{{ isAutoScalingForStorageEnabled }},
'{{ licenseModel }}',
'{{ characterSet }}',
'{{ ncharacterSet }}',
'{{ dbVersion }}',
'{{ databaseEdition }}',
'{{ standbyAllowlistedIpsSource }}',
'{{ autonomousMaintenanceScheduleType }}',
{{ backupRetentionPeriodInDays }},
{{ byolComputeCountLimit }},
{{ cpuCoreCount }},
'{{ customerContactsToSendToOCI }}',
'{{ privateEndpointIp }}',
'{{ privateEndpointLabel }}',
'{{ resourcePoolLeaderId }}',
'{{ resourcePoolSummary }}',
'{{ scheduledOperations }}',
'{{ standbyAllowlistedIps }}',
'{{ allowlistedIps }}',
'{{ transportableTablespace }}',
{{ isBackupRetentionLocked }},
{{ isLocalDataGuardEnabled }},
{{ isMtlsConnectionRequired }},
'{{ dbToolsDetails }}',
'{{ source }}',
'{{ sourceConfiguration }}',
'{{ encryptionKeyProvider }}',
'{{ encryptionKeyConfiguration }}',
'{{ adminPasswordSource }}',
'{{ adminPasswordSourceConfiguration }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
autonomous_database_id,
display_name,
status,
status_reason
;
# Description fields are for documentation purposes
- name: autonomous_databases
props:
- name: region
value: "{{ region }}"
description: Required parameter for the autonomous_databases resource.
- name: autonomousDatabaseId
value: "{{ autonomousDatabaseId }}"
description: |
The unique identifier of the Autonomous Database to create a wallet for.
- name: walletType
value: "{{ walletType }}"
description: |
The type of wallet to create, either a regional wallet or an instance wallet.
valid_values: ['REGIONAL', 'INSTANCE']
- name: password
value: "{{ password }}"
description: |
The password to encrypt the keys inside the wallet.
- name: passwordSource
value: "{{ passwordSource }}"
description: |
The source of the password for encrypting the wallet. When set to CUSTOMER_MANAGED_AWS_SECRET, the password is retrieved from an Amazon Web Services Secrets Manager secret.
valid_values: ['CUSTOMER_MANAGED_AWS_SECRET', 'API_REQUEST_PARAMETER']
- name: passwordSourceConfiguration
description: |
The configuration of the password source for the Autonomous Database wallet.
value:
customerManagedAwsSecret:
secretId: "{{ secretId }}"
iamRoleArn: "{{ iamRoleArn }}"
externalIdType: "{{ externalIdType }}"
- name: clientToken
value: "{{ clientToken }}"
description: |
A client-provided token to ensure the idempotency of the request.
- name: odbNetworkId
value: "{{ odbNetworkId }}"
description: |
The unique identifier of the ODB network to be used for the Autonomous Database.
- name: displayName
value: "{{ displayName }}"
description: |
The user-friendly name for the Autonomous Database. The name does not have to be unique.
- name: dbName
value: "{{ dbName }}"
description: |
The name of the Autonomous Database. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The name must be unique in the Amazon Web Services account.
- name: adminPassword
value: "{{ adminPassword }}"
description: |
The password for the ADMIN user of the Autonomous Database.
- name: computeCount
value: {{ computeCount }}
description: |
The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), to assign to the Autonomous Database.
- name: dataStorageSizeInTBs
value: {{ dataStorageSizeInTBs }}
description: |
The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database.
- name: dataStorageSizeInGBs
value: {{ dataStorageSizeInGBs }}
description: |
The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database.
- name: dbWorkload
value: "{{ dbWorkload }}"
description: |
The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX.
valid_values: ['OLTP', 'AJD', 'APEX', 'LH']
- name: isAutoScalingEnabled
value: {{ isAutoScalingEnabled }}
description: |
Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.
- name: isAutoScalingForStorageEnabled
value: {{ isAutoScalingForStorageEnabled }}
description: |
Specifies whether to enable automatic scaling of the storage for the Autonomous Database.
- name: licenseModel
value: "{{ licenseModel }}"
description: |
The Oracle license model to apply to the Autonomous Database.
valid_values: ['BRING_YOUR_OWN_LICENSE', 'LICENSE_INCLUDED']
- name: characterSet
value: "{{ characterSet }}"
description: |
The character set to use for the Autonomous Database.
- name: ncharacterSet
value: "{{ ncharacterSet }}"
description: |
The national character set to use for the Autonomous Database.
- name: dbVersion
value: "{{ dbVersion }}"
description: |
The Oracle Database software version to use for the Autonomous Database.
- name: databaseEdition
value: "{{ databaseEdition }}"
description: |
The Oracle Database edition to apply to the Autonomous Database.
valid_values: ['STANDARD_EDITION', 'ENTERPRISE_EDITION']
- name: standbyAllowlistedIpsSource
value: "{{ standbyAllowlistedIpsSource }}"
description: |
The source of the allowlisted IP addresses for the standby Autonomous Database.
valid_values: ['PRIMARY', 'SEPARATE', 'NOT_APPLICABLE']
- name: autonomousMaintenanceScheduleType
value: "{{ autonomousMaintenanceScheduleType }}"
description: |
The maintenance schedule type for the Autonomous Database.
valid_values: ['EARLY', 'REGULAR']
- name: backupRetentionPeriodInDays
value: {{ backupRetentionPeriodInDays }}
description: |
The retention period, in days, for automatic backups of the Autonomous Database.
- name: byolComputeCountLimit
value: {{ byolComputeCountLimit }}
description: |
The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.
- name: cpuCoreCount
value: {{ cpuCoreCount }}
description: |
The number of CPU cores to allocate to the Autonomous Database.
- name: customerContactsToSendToOCI
description: |
The list of customer contacts to receive operational notifications from Oracle Cloud Infrastructure (OCI) for the Autonomous Database.
value:
- email: "{{ email }}"
- name: privateEndpointIp
value: "{{ privateEndpointIp }}"
description: |
The private endpoint IP address for the Autonomous Database.
- name: privateEndpointLabel
value: "{{ privateEndpointLabel }}"
description: |
The private endpoint label for the Autonomous Database.
- name: resourcePoolLeaderId
value: "{{ resourcePoolLeaderId }}"
description: |
The unique identifier of the resource pool leader Autonomous Database.
- name: resourcePoolSummary
description: |
The configuration of the resource pool for the Autonomous Database.
value:
isDisabled: {{ isDisabled }}
poolSize: {{ poolSize }}
poolStorageSizeInTBs: {{ poolStorageSizeInTBs }}
availableStorageCapacityInTBs: {{ availableStorageCapacityInTBs }}
totalComputeCapacity: {{ totalComputeCapacity }}
availableComputeCapacity: {{ availableComputeCapacity }}
- name: scheduledOperations
description: |
The list of scheduled start and stop times for the Autonomous Database.
value:
- dayOfWeek:
name: "{{ name }}"
scheduledStartTime: "{{ scheduledStartTime }}"
scheduledStopTime: "{{ scheduledStopTime }}"
- name: standbyAllowlistedIps
value:
- "{{ standbyAllowlistedIps }}"
description: |
The list of IP addresses that are allowed to access the standby Autonomous Database.
- name: allowlistedIps
value:
- "{{ allowlistedIps }}"
description: |
The list of IP addresses that are allowed to access the Autonomous Database.
- name: transportableTablespace
description: |
The transportable tablespace configuration to use when creating the Autonomous Database.
value:
ttsBundleUrl: "{{ ttsBundleUrl }}"
- name: isBackupRetentionLocked
value: {{ isBackupRetentionLocked }}
description: |
Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.
- name: isLocalDataGuardEnabled
value: {{ isLocalDataGuardEnabled }}
description: |
Specifies whether to enable local Oracle Data Guard for the Autonomous Database.
- name: isMtlsConnectionRequired
value: {{ isMtlsConnectionRequired }}
description: |
Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.
- name: dbToolsDetails
description: |
The list of database management tools to enable for the Autonomous Database.
value:
- isEnabled: {{ isEnabled }}
name: "{{ name }}"
computeCount: {{ computeCount }}
maxIdleTimeInMinutes: {{ maxIdleTimeInMinutes }}
- name: source
value: "{{ source }}"
description: |
The source from which to create the Autonomous Database, such as a clone, backup, or cross-Region copy.
valid_values: ['NONE', 'DATABASE', 'BACKUP_FROM_ID', 'BACKUP_FROM_TIMESTAMP', 'CROSS_REGION_DATAGUARD', 'CROSS_REGION_DISASTER_RECOVERY', 'CLONE_TO_REFRESHABLE']
- name: sourceConfiguration
description: |
The configuration details for the source used to create the Autonomous Database.
value:
databaseClone:
sourceAutonomousDatabaseId: "{{ sourceAutonomousDatabaseId }}"
cloneType: "{{ cloneType }}"
restoreFromBackup:
autonomousDatabaseBackupId: "{{ autonomousDatabaseBackupId }}"
cloneType: "{{ cloneType }}"
cloneTableSpaceList:
- {{ cloneTableSpaceList }}
pointInTimeRestore:
sourceAutonomousDatabaseId: "{{ sourceAutonomousDatabaseId }}"
cloneType: "{{ cloneType }}"
timestamp: "{{ timestamp }}"
useLatestAvailableBackupTimestamp: {{ useLatestAvailableBackupTimestamp }}
cloneTableSpaceList:
- {{ cloneTableSpaceList }}
crossRegionDataGuard:
sourceAutonomousDatabaseArn: "{{ sourceAutonomousDatabaseArn }}"
crossRegionDisasterRecovery:
sourceAutonomousDatabaseArn: "{{ sourceAutonomousDatabaseArn }}"
remoteDisasterRecoveryType: "{{ remoteDisasterRecoveryType }}"
isReplicateAutomaticBackups: {{ isReplicateAutomaticBackups }}
cloneToRefreshable:
sourceAutonomousDatabaseId: "{{ sourceAutonomousDatabaseId }}"
refreshableMode: "{{ refreshableMode }}"
autoRefreshFrequencyInSeconds: {{ autoRefreshFrequencyInSeconds }}
autoRefreshPointLagInSeconds: {{ autoRefreshPointLagInSeconds }}
timeOfAutoRefreshStart: "{{ timeOfAutoRefreshStart }}"
openMode: "{{ openMode }}"
cloneType: "{{ cloneType }}"
- name: encryptionKeyProvider
value: "{{ encryptionKeyProvider }}"
description: |
The provider of the encryption key to use for the Autonomous Database.
valid_values: ['ORACLE_MANAGED', 'AWS_KMS']
- name: encryptionKeyConfiguration
description: |
The configuration of the encryption key to use for the Autonomous Database.
value:
awsEncryptionKey:
iamRoleArn: "{{ iamRoleArn }}"
externalIdType: "{{ externalIdType }}"
kmsKeyId: "{{ kmsKeyId }}"
- name: adminPasswordSource
value: "{{ adminPasswordSource }}"
description: |
The source of the admin password for the Autonomous Database. When set to CUSTOMER_MANAGED_AWS_SECRET, the admin password is retrieved from an Amazon Web Services Secrets Manager secret.
valid_values: ['CUSTOMER_MANAGED_AWS_SECRET', 'API_REQUEST_PARAMETER']
- name: adminPasswordSourceConfiguration
description: |
The configuration of the admin password source for the Autonomous Database.
value:
customerManagedAwsSecret:
secretId: "{{ secretId }}"
iamRoleArn: "{{ iamRoleArn }}"
externalIdType: "{{ externalIdType }}"
- name: tags
value: "{{ tags }}"
description: |
The list of resource tags to apply to the Autonomous Database. Each tag is a key-value pair with no predefined name, type, or namespace.
UPDATE examples
- update_autonomous_database
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
- delete_autonomous_database
Deletes the specified Autonomous Database.
DELETE FROM aws.odb.autonomous_databases
WHERE region = '{{ region }}' --required
;
Lifecycle Methods
- failover_autonomous_database
- reboot_autonomous_database
- restore_autonomous_database
- shrink_autonomous_database
- start_autonomous_database
- stop_autonomous_database
- switchover_autonomous_database
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 }}"
}'
;
Reboots the specified Autonomous Database.
EXEC aws.odb.autonomous_databases.reboot_autonomous_database
@region='{{ region }}' --required
@@json=
'{
"autonomousDatabaseId": "{{ autonomousDatabaseId }}",
"isOnlineReboot": {{ isOnlineReboot }}
}'
;
Restores the specified Autonomous Database to a point in time.
EXEC aws.odb.autonomous_databases.restore_autonomous_database
@region='{{ region }}' --required
@@json=
'{
"autonomousDatabaseId": "{{ autonomousDatabaseId }}",
"timestamp": "{{ timestamp }}"
}'
;
Shrinks the storage of the specified Autonomous Database to reclaim unused space.
EXEC aws.odb.autonomous_databases.shrink_autonomous_database
@region='{{ region }}' --required
@@json=
'{
"autonomousDatabaseId": "{{ autonomousDatabaseId }}"
}'
;
Starts the specified Autonomous Database.
EXEC aws.odb.autonomous_databases.start_autonomous_database
@region='{{ region }}' --required
@@json=
'{
"autonomousDatabaseId": "{{ autonomousDatabaseId }}"
}'
;
Stops the specified Autonomous Database.
EXEC aws.odb.autonomous_databases.stop_autonomous_database
@region='{{ region }}' --required
@@json=
'{
"autonomousDatabaseId": "{{ autonomousDatabaseId }}"
}'
;
Performs a switchover of the specified Autonomous Database to a standby peer database.
EXEC aws.odb.autonomous_databases.switchover_autonomous_database
@region='{{ region }}' --required
@@json=
'{
"autonomousDatabaseId": "{{ autonomousDatabaseId }}",
"peerDbArn": "{{ peerDbArn }}"
}'
;