This is an archive version of the document. To get the most up-to-date information, see the
current version.
PolicySpec
The following parameters and subschemas represent the PolicySpec JSON schema.
PolicySpec
Parameter | Required/Optional | Type | Description |
|---|
snapshotSettings | Optional | PolicySnapshotSettings | Specifies cloud-native snapshot settings for the backup policy. |
replicaSettings | Optional | PolicyReplicaSettings | Specifies settings for snapshot replicas for the backup policy. |
backupSettings | Optional | PolicyBackupSettings | Specifies backup settings for the backup policy. |
regionIds | Optional | array [string($uuid)] | Specifies system IDs assigned in the Veeam Backup for AWS REST API to AWS regions where EC2 instances that are backed up reside. |
selectedItems | Optional | PolicyBackupItems | Specifies AWS resources to be protected by the backup policy. |
excludedItems | Optional | PolicyBackupItems | Specifies AWS resources to exclude from the backup policy. |
scheduleSettings | Optional | ScheduleSettings | Specifies a backup schedule for the backup policy. |
name | Required | string | Specifies a name of the backup policy. |
description | Optional | string | Specifies a description of the backup policy. |
amazonAccountId | Required | string($uuid) | Specifies a system ID assigned in the Veeam Backup for AWS REST API to an IAM role whose permissions Veeam Backup for AWS will use to access AWS resources and perform EC2 instance backup. |
retrySettings | Optional | RetrySettings | Specifies retry settings for the backup policy. |
policyNotificationSettings | Optional | PolicyNotificationSettings | Specifies notification settings for the backup policy. |
backupType | Required | string | Specifies a type of the backup policy: AllItems, SelectedItems. |
PolicySnapshotSettings
Parameter | Required/Optional | Type | Description |
|---|
additionalTags | Optional | TagSpec | Specifies tags to be assigned to the snapshots. | copyTagsFromVolumeEnabled | Optional | boolean | Defines whether to assign to the snapshot replicas tags of EBS volumes attached to processed EC2 instances. | tryCreateVSSSnapshot | Optional | boolean | Defines whether to enable application-aware processing for Windows EC2 instances running VSS-aware applications. |
|
PolicyReplicaSettings
Parameter | Required/Optional | Type | Description |
|---|
mapping | Required | ReplicaMapping | Specifies snapshot replication mapping details. | additionalTags | Optional | TagSpec | Specifies tags to be assigned to snapshot replicas. | copyTagsFromVolumeEnabled | Optional | boolean | Defines whether to assign to the replicated snapshots tags of EBS volumes attached to processed EC2 instances. |
|
TagSpec
Parameter | Required/Optional | Type | Description |
|---|
key | Required | string | Specifies a key of an AWS tag. | value | Required | string | Specifies a value of the AWS tag. |
|
ReplicaMapping
Parameter | Required/Optional | Type | Description |
|---|
sourceRegionId | Required | string($uuid) | Specifies a system ID assigned in the Veeam Backup for AWS REST API to the source AWS region. | targetRegionId | Required | string($uuid) | Specifies a system ID assigned in the Veeam Backup for AWS REST API to the target AWS region. | targetAmazonAccountId | Required | string($uuid) | Specifies a system ID assigned in the Veeam Backup for AWS REST API to an IAM role whose permissions Veeam Backup for AWS will use to copy and store snapshots in a target AWS region. | encryptionKey | Optional | string | Specifies AWS Key Management Service (AWS KMS) customer master keys (CMK) to be used for snapshot encryption. |
|
PolicyBackupSettings
Parameter | Required/Optional | Type | Description |
|---|
targetRepositoryId | Optional | string($uuid) | Specifies a system ID assigned in the Veeam Backup for AWS REST API to the target S3 repository where Veeam Backup for AWS will store created backups. |
|
PolicyBackupItems
Parameter | Required/Optional | Type | Description |
|---|
virtualMachineIds | Optional | array [string($uuid)] | Specifies system IDs assigned to EC2 instances in the Veeam Backup for AWS REST API. | tagIds | Optional | array [string($uuid)] | Specifies system IDs assigned to AWS tags in the Veeam Backup for AWS REST API. |
|
ScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
dailyScheduleEnabled | Required | boolean | Defines whether to enable backup daily schedule. | dailySchedule | Optional | DailyScheduleSettings | Specifies backup daily schedule settings for the backup policy. | weeklyScheduleEnabled | Required | boolean | Defines whether to enable backup weekly schedule. | weeklySchedule | Optional | WeeklyScheduleSettings | Specifies backup weekly schedule settings for the backup policy. | monthlyScheduleEnabled | Required | boolean | Defines whether to enable backup monthly schedule. | monthlySchedule | Optional | MonthlyScheduleSettings | Specifies backup monthly schedule settings for the backup policy. | yearlyScheduleEnabled | Required | boolean | Defines whether to enable backup yearly schedule. | yearlySchedule | Optional | YearlyScheduleSettings | Specifies backup yearly schedule settings for the backup policy. |
|
DailyScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
kind | Required | string | Specifies days when the backup policy must run: Everyday, WeekDays, SelectedDays. | runsPerHour | Required | integer($int32) | [Applies only for cloud-native snapshots] Specifies a number of cloud-native snapshots that the backup policy must create within an hour (minimum: 1). | days | Optional | array [string] | [Applies if the Selected days value is specified for the kind parameter ] Specifies days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. | snapshotOptions | Required | DailySnapshotScheduleSettings | Specifies daily schedule settings for cloud-native snapshots. | backupOptions | Optional | DailyBackupScheduleSettings | Specifies daily schedule settings for image-level backups. | replicaOptions | Optional | DailyReplicaScheduleSettings | Specifies daily schedule settings for snapshot replicas. |
|
DailySnapshotScheduleSettings, DailyReplicaScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
retention | Required | PointsRetentionOptions | Specifies a number of restore points to keep in cloud-native snapshot and snapshot replica chains. | schedule | Required | DailySchedule | Specifies hours when the backup policy must run. |
|
DailyBackupScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
retention | Required | PeriodRetentionOptions | Specifies a number of days (or months) to keep restore points in a backup chain. | schedule | Required | DailySchedule | Specifies hours when the backup policy must run. |
|
WeeklyScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
timeLocal | Required | string($date-time) | Specifies time when the backup policy must run. | snapshotOptions | Required | WeeklySnapshotScheduleSettings | Specifies weekly schedule settings for cloud-native snapshots. | backupOptions | Optional | WeeklyBackupScheduleSettings | Specifies weekly schedule settings for image-level backups. | replicaOptions | Optional | WeeklyReplicaScheduleSettings | Specifies weekly schedule settings for snapshot replicas. |
|
WeeklySnapshotScheduleSettings, WeeklyReplicaScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
retention | Required | PointsRetentionOptions | Specifies a number of restore points to keep in cloud-native snapshot and snapshot replica chains. | schedule | Required | WeeklySchedule | Specifies days of the week when the backup policy must run. |
|
WeeklyBackupScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
retention | Required | PeriodRetentionOptions | Specifies a number of days (or months) to keep restore points in a backup chain. | schedule | Required | WeeklySchedule | Specifies days of the week when the backup policy must run. |
|
MonthlyScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
timeLocal | Required | string($date-time) | Specifies time when the backup policy must run. | dayNumberInMonth | Required | string | Specifies a day of the month when the backup policy must run: First, Second, Third, Fourth, Last, OnDay. | dayOfWeek | Optional | array [string] | [Applies if one of the First, Second, Third, Fourth or Last values is specified for the dayNumberInMonth parameter] Specifies days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. | dayOfMonth | Optional | integer($int32) | [Applies if the OnDay value is specified for the dayNumberInMonth parameter] Specifies the ordinal number of the day of the month when the backup policy must run. | snapshotOptions | Required | MonthlySnapshotScheduleSettings | Specifies monthly schedule settings for cloud-native snapshots. | backupOptions | Optional | MonthlyBackupScheduleSettings | Specifies monthly schedule settings for image-level backups. | replicaOptions | Optional | MonthlyReplicaScheduleSettings | Specifies monthly schedule settings for snapshot replicas. |
|
MonthlySnapshotScheduleSettings, MonthlyReplicaScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
retention | Required | PointsRetentionOptions | Specifies a number of restore points to keep in cloud-native snapshot and snapshot replica chains. | schedule | Required | MonthlySchedule | Specifies months when the backup policy must run. |
|
MonthlyBackupScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
retention | Required | PeriodRetentionOptions | Specifies a number of days (or months) for which you want to keep restore points in a backup chain. | schedule | Required | MonthlySchedule | Specifies months when the backup policy must run. |
|
YearlyScheduleSettings
Parameter | Required/Optional | Type | Description |
|---|
timeLocal | Required | string($date-time) | Specifies time when the backup policy must run. | dayNumberInMonth | Required | string | Specifies a day of the month when the backup policy must run: First, Second, Third, Fourth, Last, OnDay. | dayOfWeek | Optional | array [string] | [Applies if one of the First, Second, Third, Fourth or Last values is specified for the dayNumberInMonth parameter] Specifies days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. | dayOfMonth | Optional | integer($int32) | [Applies if the OnDay value is specified for the dayNumberInMonth parameter] Specifies the ordinal number of the day of the month when the backup policy must run. | month | Required | array [string] | Specifies a month when the backup policy must run: January, February, March, April, May, June, July, August, September, October, November, December. | retention | Required | YearlyRetentionOptions | Specifies a number of years to keep restore points in a backup chain. |
|
PointsRetentionOptions
Parameter | Required/Optional | Type | Description |
|---|
count | Required | integer($int32) | Specifies a number of restore points to keep in cloud-native snapshot and snapshot replica chains. |
|
PeriodRetentionOptions
Parameter | Required/Optional | Type | Description |
|---|
type | Required | string | Specifies a type of the period: Days, Months. | count | Required | integer($int32) | Specifies a number of days (or months) to keep restore points in a backup chain. |
|
YearlyRetentionOptions
Parameter | Required/Optional | Type | Description |
|---|
count | Required | integer($int32) | Specifies a number of years to keep restore points in a backup chain. | type | Required | array [string] | Specifies a type of the period: Years. |
|
DailySchedule
Parameter | Required/Optional | Type | Description |
|---|
hours | Required | array [boolean] | Starting from 12:00 AM up to 12:00 PM specifies the true value for hours when the backup policy must start creating cloud-native snapshots, snapshot replicas or image-level backups, and the false value for other hours. |
|
WeeklySchedule
Parameter | Required/Optional | Type | Description |
|---|
days | Required | array [string] | Specifies days of the week when the backup policy must start creating cloud-native snapshots, snapshot replicas or image-level backups: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. |
|
MonthlySchedule
Parameter | Required/Optional | Type | Description |
|---|
months | Required | array [string] | Specifies months when the backup policy must start creating cloud-native snapshots, snapshot replicas or image-level backups: January, February, March, April, May, June, July, August, September, October, November, December. |
|
RetrySettings
Parameter | Required/Optional | Type | Description |
|---|
retryTimes | Required | integer($int32) | Specifies the maximum number of retry attempts specified for the backup policy. |
|
PolicyNotificationSettings
Parameter | Required/Optional | Type | Description |
|---|
recipient | Optional | string | Specifies the recipient email address. | notifyOnSuccess | Optional | boolean | Defines whether to receive an email notification if a policy completes successfully. | notifyOnWarning | Optional | boolean | Defines whether to receive an email notification if a policy completes with a warning. | notifyOnFailure | Optional | boolean | Defines whether to receive an email notification if a policy fails. |
|