Fileset Backup Parameters

The following list of parameters controls what will be incorporated into the corresponding backup:

Option	Required	Default	Values	Example	Description
instances	No		Valid database instance or cluster identifiers separated by ‘,’	myInstance1, myInstance2	Comma separated list of database instance or cluster identifiers to backup. If no instance is provided the plugin will list all of them and will backup them
instances_exclude	No		Valid database instance or cluster identifiers separated by ‘,’	excludeExample, i-1233sablkblvdfdlkjdfh	Comma separated list of database instance or cluster identifiers to exclude from backup. If this is the only parameter found for selection, all elements will be included and this list will be excluded
instances_regex_include	No		Valid regex	.*-includedSuffix	Backup matching instances or clusters by its identifier. Please, only provide list parameters (instances + instances_exclude) or regex ones. But do not try to combine them
instances_regex_exclude	No		Valid regex	.*-excludedSuffix	Exclude matching instances or clusters by its identifier. Please, only provide list parameters (instances + instances_exclude) or regex ones. But do not try to combine them. If this is the only parameter found for user selection, all instances will be included and matching instances will be excluded
instances_tags	No		Tag keys or values (format: tagkey1=valuekey1,tagkey2=tagkey2…)	backup=yes	Backup instances or clusters containing the specified tags
instances_tags_exclude	No		Tag keys or values (format: tagkey1=valuekey1,tagkey2=tagkey2…)	backup=no	Exclude instances or clusters containing the specified tags
start_instances	No		0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	Yes	Backup only the list of ebs volumes indicated by this parameter from the selected instances. If not specified, all disks from each instance will be backed up
snapshots_retention	No	60	Integer	100	Retention or number of snapshots to be kept in Amazon RDS Service. Older ones exceeding this number will be removed
export_bucket	No		String representing an existing bucket in the region	mybucket	Name of the bucket to send the exported parquet files if export is enabled
export_folder	No		String representing a folder name	myfolder	Optional folder inside the bucket to store the exported files
export_role	No		String representing a IAM Role name with the proper export permissions	arn:aws:iam::046642946265:role/service-role/rds-export-role	Name of the s3 export role needed to perform export operations
export_key	No		String representing a KMS key	75gt9800-719e-44b1-63h0-4197d0gt9015	ARN of the AWS Encryption key needed to perform the export
export_elements	No		Valid table names separated by ‘,’	table1,table2	Comma separated list of tables to be exported (all are exported if empty)
export_download	No	Yes	0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	No	Download the exported files (parquet archives for every database table) from S3 user bucket and send it to be stored by the Bacula Storage Daemon
export_delete	No	No	0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	Yes	Delete the exported files from the S3 bucket just after the backup is sent to the Bacula Storage (export_download=yes), and also delete the snapshot if the snapshot retention has expired

Note

When the export_download = no parameter is set, the backup is not sent to the Bacula storage, but there is still the metadata that is copied to the Bacula storage. This is necessary to restore the data backed up in the user’s S3 bucket later.