db_backups

Creates, updates, deletes, gets or lists a db_backups resource.

Overview

Name	db_backups
Type	Resource
Id	aws.timestream_influxdb.db_backups

Fields

The following fields are returned by SELECT queries:

get_db_backup

Name	Datatype	Description
id	string	Service-generated unique identifier of the backup. (pattern: <code>[a-zA-Z0-9]+</code>)
name	string	The customer-provided name of the backup. (pattern: <code>[a-zA-Z][a-zA-Z0-9](-[a-zA-Z0-9]+)</code>)
allocated_storage	integer	The allocated storage of the resource at the time of backup, in GiB.
arn	string	The Amazon Resource Name (ARN) of the backup. (pattern: <code>arn:aws[a-z-]*:timestream-influxdb:[a-z0-9-]+:[0-9]{12}:(db-instance|db-cluster|db-parameter-group|db-backup)/[a-zA-Z0-9]{3,64}</code>)
cluster_configuration	object	The cluster configuration of the resource at the time of backup.
created_at	string (date-time)	The time when the backup was created.
db_instance_type	string	The DB instance type of the resource at the time of backup. (db.influx.medium, db.influx.large, db.influx.xlarge, db.influx.2xlarge, db.influx.4xlarge, db.influx.8xlarge, db.influx.12xlarge, db.influx.16xlarge, db.influx.24xlarge)
db_parameter_group_id	string	The identifier of the DB parameter group associated with the backup. (pattern: <code>[a-zA-Z0-9]+</code>)
db_resource_id	string	The identifier of the DB resource that the backup was created from. (pattern: <code>[a-zA-Z0-9]+</code>)
db_storage_type	string	The storage type of the resource at the time of backup. (InfluxIOIncludedT1, InfluxIOIncludedT2, InfluxIOIncludedT3)
deployment_type	string	The deployment type of the resource that the backup was created from. (SINGLE_AZ, WITH_MULTIAZ_STANDBY, MULTI_NODE_READ_REPLICAS)
engine_type	string	The engine type of the resource that the backup was created from. (INFLUXDB_V2, INFLUXDB_V3_CORE, INFLUXDB_V3_ENTERPRISE)
expires_after	string	The date after which the backup will be automatically deleted. (pattern: <code>\d{4}-\d{2}-\d{2}</code>)
failover_mode	string	The failover mode of the resource at the time of backup. (AUTOMATIC, NO_FAILOVER)
influx_auth_parameters_secret_arn	string	The ARN of the Secrets Manager secret containing the InfluxDB auth parameters.
kms_key_id	string	The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup. (pattern: <code>[a-zA-Z0-9:/_-]+</code>)
log_delivery_configuration	object	The log delivery configuration of the resource at the time of backup.
maintenance_schedule	object	The maintenance schedule of the resource at the time of backup.
network_type	string	The network type of the resource at the time of backup. (IPV4, DUAL)
port	integer	The port number of the resource at the time of backup.
publicly_accessible	boolean	Indicates whether the resource was publicly accessible at the time of backup.
status	string	The current status of the backup. (IN_PROGRESS, COMPLETED, FAILED, DELETING, DELETED)
type_	string	The type of backup. (HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, ON_DEMAND, CONTINUOUS)
vpc_security_group_ids	array	The VPC security group IDs associated with the resource at the time of backup.
vpc_subnet_ids	array	The VPC subnet IDs associated with the resource at the time of backup.

list_db_backups

Name	Datatype	Description
id	string	Service-generated unique identifier of the backup. (pattern: <code>[a-zA-Z0-9]+</code>)
name	string	The customer-provided name of the backup. (pattern: <code>[a-zA-Z][a-zA-Z0-9](-[a-zA-Z0-9]+)</code>)
arn	string	The Amazon Resource Name (ARN) of the backup. (pattern: <code>arn:aws[a-z-]*:timestream-influxdb:[a-z0-9-]+:[0-9]{12}:(db-instance|db-cluster|db-parameter-group|db-backup)/[a-zA-Z0-9]{3,64}</code>)
created_at	string (date-time)	The time when the backup was created.
db_resource_id	string	The identifier of the DB resource that the backup was created from. (pattern: <code>[a-zA-Z0-9]+</code>)
deployment_type	string	The deployment type of the resource that the backup was created from. (SINGLE_AZ, WITH_MULTIAZ_STANDBY, MULTI_NODE_READ_REPLICAS)
engine_type	string	The engine type of the resource that the backup was created from. (INFLUXDB_V2, INFLUXDB_V3_CORE, INFLUXDB_V3_ENTERPRISE)
expires_after	string	The date after which the backup will be automatically deleted. (pattern: <code>\d{4}-\d{2}-\d{2}</code>)
kms_key_id	string	The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup. (pattern: <code>[a-zA-Z0-9:/_-]+</code>)
status	string	The status of the backup. Valid values are IN_PROGRESS, COMPLETED, FAILED, DELETING, and DELETED. (IN_PROGRESS, COMPLETED, FAILED, DELETING, DELETED)
type_	string	The type of backup. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, ON_DEMAND, and CONTINUOUS. (HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, ON_DEMAND, CONTINUOUS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_db_backup	select	region		Returns information about a specific Timestream for InfluxDB backup.
list_db_backups	select	region		Returns a list of Timestream for InfluxDB backups.
create_db_backup	insert	region, name, dbResourceId		Creates a new on-demand backup of a Timestream for InfluxDB resource.
delete_db_backup	delete	region		Deletes a Timestream for InfluxDB backup.
restore_from_db_backup	exec	region, name, dbBackupId		Restores a Timestream for InfluxDB resource from a backup. By default, a new resource is created. You can optionally restore to the same resource using the REPLACE_EXISTING restore mode.

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_db_backup

Returns information about a specific Timestream for InfluxDB backup.

SELECT
id,
name,
allocated_storage,
arn,
cluster_configuration,
created_at,
db_instance_type,
db_parameter_group_id,
db_resource_id,
db_storage_type,
deployment_type,
engine_type,
expires_after,
failover_mode,
influx_auth_parameters_secret_arn,
kms_key_id,
log_delivery_configuration,
maintenance_schedule,
network_type,
port,
publicly_accessible,
status,
type_,
vpc_security_group_ids,
vpc_subnet_ids
FROM aws.timestream_influxdb.db_backups
WHERE region = '{{ region }}' -- required
;

list_db_backups

Returns a list of Timestream for InfluxDB backups.

SELECT
id,
name,
arn,
created_at,
db_resource_id,
deployment_type,
engine_type,
expires_after,
kms_key_id,
status,
type_
FROM aws.timestream_influxdb.db_backups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_db_backup

Creates a new on-demand backup of a Timestream for InfluxDB resource.

INSERT INTO aws.timestream_influxdb.db_backups (
name,
dbResourceId,
retentionDays,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ dbResourceId }}' /* required */,
{{ retentionDays }},
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
allocated_storage,
arn,
cluster_configuration,
created_at,
db_instance_type,
db_parameter_group_id,
db_resource_id,
db_storage_type,
deployment_type,
engine_type,
expires_after,
failover_mode,
influx_auth_parameters_secret_arn,
kms_key_id,
log_delivery_configuration,
maintenance_schedule,
network_type,
port,
publicly_accessible,
status,
type_,
vpc_security_group_ids,
vpc_subnet_ids
;

Manifest

# Description fields are for documentation purposes
- name: db_backups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the db_backups resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the backup. Must be unique within the account and region.
  - name: dbResourceId
    value: "{{ dbResourceId }}"
    description: |
      The id of the DB instance or DB cluster to back up.
  - name: retentionDays
    value: {{ retentionDays }}
    description: |
      The number of days to retain the backup. Valid values are 1 to 3650.
  - name: tags
    value: "{{ tags }}"
    description: |
      A list of key-value pairs to associate with the backup.

DELETE examples

delete_db_backup

Deletes a Timestream for InfluxDB backup.

DELETE FROM aws.timestream_influxdb.db_backups
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

restore_from_db_backup

Restores a Timestream for InfluxDB resource from a backup. By default, a new resource is created. You can optionally restore to the same resource using the REPLACE_EXISTING restore mode.

EXEC aws.timestream_influxdb.db_backups.restore_from_db_backup 
@region='{{ region }}' --required 
@@json=
'{
"name": "{{ name }}", 
"dbBackupId": "{{ dbBackupId }}", 
"restoreToTime": "{{ restoreToTime }}", 
"restoreMode": "{{ restoreMode }}", 
"vpcSubnetIds": "{{ vpcSubnetIds }}", 
"vpcSecurityGroupIds": "{{ vpcSecurityGroupIds }}", 
"publiclyAccessible": {{ publiclyAccessible }}, 
"logDeliveryConfiguration": "{{ logDeliveryConfiguration }}", 
"maintenanceSchedule": "{{ maintenanceSchedule }}", 
"tags": "{{ tags }}", 
"port": {{ port }}, 
"networkType": "{{ networkType }}", 
"deploymentType": "{{ deploymentType }}", 
"dbBackupConfigurations": "{{ dbBackupConfigurations }}", 
"kmsKeyId": "{{ kmsKeyId }}"
}'
;