autonomous_database_backups

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

Overview

Name	autonomous_database_backups
Type	Resource
Id	aws.odb.autonomous_database_backups

Fields

The following fields are returned by SELECT queries:

get_autonomous_database_backup

Name	Datatype	Description
autonomous_database_backup_arn	string	The Amazon Resource Name (ARN) of the Autonomous Database backup. (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_backup_id	string	The unique identifier of the Autonomous Database backup. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
autonomous_database_id	string	The unique identifier of the Autonomous Database that the backup was created from. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
db_version	string	The Oracle Database software version of the Autonomous Database backup.
display_name	string	The user-friendly name of the Autonomous Database backup.
is_automatic	boolean	Indicates whether the backup was created automatically.
ocid	string	The Oracle Cloud Identifier (OCID) of the Autonomous Database backup.
retention_period_in_days	integer	The retention period, in days, for the Autonomous Database backup.
size_in_tbs	number (double)	The size of the Autonomous Database backup, in terabytes (TB).
status	string	The current status of the Autonomous Database backup. (ACTIVE, CREATING, UPDATING, DELETING, FAILED)
status_reason	string	Additional information about the current status of the Autonomous Database backup, if applicable.
time_available_till	string (date-time)	The date and time until which the Autonomous Database backup is available for restore.
time_ended	string (date-time)	The date and time when the Autonomous Database backup ended.
time_started	string (date-time)	The date and time when the Autonomous Database backup started.
type_	string	The type of the Autonomous Database backup. (INCREMENTAL, FULL, LONGTERM, VIRTUAL_FULL, CUMULATIVE_INCREMENTAL, ROLL_FORWARD_IMAGE_COPY)

list_autonomous_database_backups

Name	Datatype	Description
autonomous_database_backup_arn	string	The Amazon Resource Name (ARN) of the Autonomous Database backup. (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_backup_id	string	The unique identifier of the Autonomous Database backup. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
autonomous_database_id	string	The unique identifier of the Autonomous Database that the backup was created from. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
db_version	string	The Oracle Database software version of the Autonomous Database backup.
display_name	string	The user-friendly name of the Autonomous Database backup.
is_automatic	boolean	Indicates whether the backup was created automatically.
ocid	string	The Oracle Cloud Identifier (OCID) of the Autonomous Database backup.
retention_period_in_days	integer	The retention period, in days, for the Autonomous Database backup.
size_in_tbs	number (double)	The size of the Autonomous Database backup, in terabytes (TB).
status	string	The current status of the Autonomous Database backup. (ACTIVE, CREATING, UPDATING, DELETING, FAILED)
status_reason	string	Additional information about the current status of the Autonomous Database backup, if applicable.
time_available_till	string (date-time)	The date and time until which the Autonomous Database backup is available for restore.
time_ended	string (date-time)	The date and time when the Autonomous Database backup ended.
time_started	string (date-time)	The date and time when the Autonomous Database backup started.
type_	string	The type of the Autonomous Database backup. (INCREMENTAL, FULL, LONGTERM, VIRTUAL_FULL, CUMULATIVE_INCREMENTAL, ROLL_FORWARD_IMAGE_COPY)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_autonomous_database_backup	select	region		Gets information about a specific Autonomous Database backup.
list_autonomous_database_backups	select	region		Lists the backups of the specified Autonomous Database.
create_autonomous_database_backup	insert	region, autonomousDatabaseId		Creates a new backup of the specified Autonomous Database.
update_autonomous_database_backup	update	region, autonomousDatabaseBackupId		Updates the properties of an Autonomous Database backup.
delete_autonomous_database_backup	delete	region		Deletes the specified Autonomous Database backup.

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_backup

Gets information about a specific Autonomous Database backup.

SELECT
autonomous_database_backup_arn,
autonomous_database_backup_id,
autonomous_database_id,
db_version,
display_name,
is_automatic,
ocid,
retention_period_in_days,
size_in_tbs,
status,
status_reason,
time_available_till,
time_ended,
time_started,
type_
FROM aws.odb.autonomous_database_backups
WHERE region = '{{ region }}' -- required
;

list_autonomous_database_backups

Lists the backups of the specified Autonomous Database.

SELECT
autonomous_database_backup_arn,
autonomous_database_backup_id,
autonomous_database_id,
db_version,
display_name,
is_automatic,
ocid,
retention_period_in_days,
size_in_tbs,
status,
status_reason,
time_available_till,
time_ended,
time_started,
type_
FROM aws.odb.autonomous_database_backups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_autonomous_database_backup

Creates a new backup of the specified Autonomous Database.

INSERT INTO aws.odb.autonomous_database_backups (
autonomousDatabaseId,
displayName,
retentionPeriodInDays,
clientToken,
tags,
region
)
SELECT 
'{{ autonomousDatabaseId }}' /* required */,
'{{ displayName }}',
{{ retentionPeriodInDays }},
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
autonomous_database_backup_id,
display_name,
status,
status_reason
;

Manifest

# Description fields are for documentation purposes
- name: autonomous_database_backups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the autonomous_database_backups resource.
  - name: autonomousDatabaseId
    value: "{{ autonomousDatabaseId }}"
    description: |
      The unique identifier of the Autonomous Database to back up.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The user-friendly name for the Autonomous Database backup.
  - name: retentionPeriodInDays
    value: {{ retentionPeriodInDays }}
    description: |
      The retention period, in days, for the Autonomous Database backup.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      A client-provided token to ensure the idempotency of the request.
  - name: tags
    value: "{{ tags }}"
    description: |
      The list of resource tags to apply to the Autonomous Database backup. Each tag is a key-value pair with no predefined name, type, or namespace.

UPDATE examples

update_autonomous_database_backup

Updates the properties of an Autonomous Database backup.

UPDATE aws.odb.autonomous_database_backups
SET 
autonomousDatabaseBackupId = '{{ autonomousDatabaseBackupId }}',
retentionPeriodInDays = {{ retentionPeriodInDays }}
WHERE 
region = '{{ region }}' --required
AND autonomousDatabaseBackupId = '{{ autonomousDatabaseBackupId }}' --required
RETURNING
autonomous_database_backup_id,
display_name,
status,
status_reason;

DELETE examples

delete_autonomous_database_backup

Deletes the specified Autonomous Database backup.

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