Fileset Backup Parameters

The following list of parameters control what is going to be included into the associated backup:

Option	Required	Default	Values	Example	Description
instances	No		Valid instance names or ids separated by ‘,’	myInstance1, myInstance2	Backup each instance containing the tag ‘Name’ with the provided values or the provided instance ids. If no instance is provided the plugin will list all the instances and will backup them
instances_exclude	No		Valid instance names or ids separated by ‘,’	excludeExample, i-1233sablkblvdfdlkjdfh	Exclude selected instance containing the tag ‘Name’ with the provided values or the provided instance ids. 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 by name. 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 by name. 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 containing the specified tags
instances_tags_exclude	No		Tag keys or values (format: tagkey1=valuekey1,tagkey2=tagkey2…)	backup=no	Exclude instances containing the specified tags
disks	No		Disk ids separated by ‘,’	vol-123fadfafdfdhfd	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
disks_exclude	No		Disk ids separated by ‘,’	vol-456fadfafdfdhfd, vol-78904adsfdasfd	Exclude selected volumes from the selectd instances. If this is the only parameter found for disk selection, all disks will be included and this list will be excluded
disks_regex_include	No		Valid regex	.*23232343	Backup matching volumes by name. Please, only provide list parameters or regex ones. But do not try to combine them
disks_regex_exclude	No		Valid regex	.vol-34.	Exclude matching volumes by name. Please, only provide list parameters or regex ones. But do not try to combine them. If this is the only parameter found for volume selection, all volumes will be included and matching volumes will be excluded
instances_filter_file	No		String representing a full path of a .json file	/opt/bacula/etc/instances-filter.json	Use the file to interpret all the filters and backup only the matching instances. See next section to have more information about this advanced filter
keep_full_snapshot	No	No	0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	Yes	Incremental backups will normally remove the Full backup, making the combination with Differential backups not possible. If that combination is desired, enable this parameter and the Full snapshot wont be removed
shutdown	No	No	0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	Yes	Shutdown the selected instance(s) before doing the snapshot of the backup operation and start them just after. This will ensure application consistency, but be aware of the inherent service disruption with the associated instances
exclude_boot_volume	No	No	0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	Yes	Exclude the boot volume from the backup operation
force_cleanup_snapshots	No	No	0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	Yes	Bacula will only remove snapshots that were created by this plugin. If an external snapshot is made, the backup will fail unless this option is enabled, so any not suitable snasphot will be removed before the backup

Advanced Instance Filter

The instances_filter_file parameter provides users with a highly adaptable method to filter the selection of backup target instances according to their preferences.

This parameter requires a file path that points to a JSON file. The file must be locally accessible to the File Daemon and have the necessary permissions to be read.

The supported parameters are all the ones described in this AWS article in the section associated to the parameter ‘filters’ that are not already present as other direct parameters for the plugin: https://awscli.amazonaws.com/v2/documentation/api/2.0.34/reference/ec2/describe-instances.html

The article refers to the sub-routine ‘describe-instances’ of the command line tool AWS CLI, so it should be familiar to users running workloads over AWS. The possible parameters are also listed below:

Possible filters

 affinity - The affinity setting for an instance running on a Dedicated Host (default | host ).

 architecture - The instance architecture (i386 | x86_64 | arm64 ).

 availability-zone - The Availability Zone of the instance.

 block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z .

 block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

 block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh ).

 block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached ).

 block-device-mapping.volume-id - The volume ID of the EBS volume.

 client-token - The idempotency token you provided when you launched the instance.

 dns-name - The public DNS name of the instance.

 group-id - The ID of the security group for the instance. EC2-Classic only.

 group-name - The name of the security group for the instance. EC2-Classic only.

 hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.

 host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

 hypervisor - The hypervisor type of the instance (ovm | xen ). The value xen is used for both Xen and Nitro hypervisors.

 iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

 image-id - The ID of the image used to launch the instance.

 instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled ).

 instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

 instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped ).

 instance-type - The type of instance (for example, t2.micro ).

 instance.group-id - The ID of the security group for the instance.

 instance.group-name - The name of the security group for the instance.

 ip-address - The public IPv4 address of the instance.

 kernel-id - The kernel ID.

 key-name - The name of the key pair used when the instance was launched.

 launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

 launch-time - The time when the instance was launched.

 metadata-options.http-tokens - The metadata request authorization state (optional | required )

 metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64 )

 metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled )

 monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled ).

 network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.

 network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.

 network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.

 network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.

 network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

 network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

 network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

 network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

 network-interface.attachment.attachment-id - The ID of the interface attachment.

 network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

 network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

 network-interface.attachment.device-index - The device index to which the network interface is attached.

 network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached ).

 network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

 network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

 network-interface.availability-zone - The Availability Zone for the network interface.

 network-interface.description - The description of the network interface.

 network-interface.group-id - The ID of a security group associated with the network interface.

 network-interface.group-name - The name of a security group associated with the network interface.

 network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.

 network-interface.mac-address - The MAC address of the network interface.

 network-interface.network-interface-id - The ID of the network interface.

 network-interface.owner-id - The ID of the owner of the network interface.

 network-interface.private-dns-name - The private DNS name of the network interface.

 network-interface.requester-id - The requester ID for the network interface.

 network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

 network-interface.status - The status of the network interface (available ) | in-use ).

 network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

 network-interface.subnet-id - The ID of the subnet for the network interface.

 network-interface.vpc-id - The ID of the VPC for the network interface.

 owner-id - The AWS account ID of the instance owner.

 placement-group-name - The name of the placement group for the instance.

 placement-partition-number - The partition in which the instance is located.

 platform - The platform. To list only Windows instances, use windows .

 private-dns-name - The private IPv4 DNS name of the instance.

 private-ip-address - The private IPv4 address of the instance.

 product-code - The product code associated with the AMI used to launch the instance.

 product-code.type - The type of product code (devpay | marketplace ).

 ramdisk-id - The RAM disk ID.

 reason - The reason for the current state of the instance (for example, shows “User Initiated [date]” when you stop or terminate the instance). Similar to the state-reason-code filter.

 requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

 reservation-id - The ID of the instance’s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.

 root-device-name - The device name of the root device volume (for example, /dev/sda1 ).

 root-device-type - The type of the root device volume (ebs | instance-store ).

 source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

 spot-instance-request-id - The ID of the Spot Instance request.

 state-reason-code - The reason code for the state change.

 state-reason-message - A message that describes the state change.

 subnet-id - The ID of the subnet for the instance.

 tenancy - The tenancy of an instance (dedicated | default | host ).

 virtualization-type - The virtualization type of the instance (paravirtual | hvm ).

 vpc-id - The ID of the VPC that the instance is running in.

This information needs to be formated in the file with a JSON structure. Below is an example:

Advanced Filter: File Contents Example

{
     "instance-type" : "t2.micro",
     "architecture" : "x86_64"
}