This is an archive version of the document. To get the most up-to-date information, see the
current version.
Policy
The following properties and subschemas represent the Policy JSON schema.
Policy
Property | Type | Description |
|---|
id | string($uuid) | System ID assigned to a backup policy in the Veeam Backup for AWS REST API. |
snapshotSettings | PolicySnapshotSettings | Cloud-native snapshot settings configured for the backup policy. |
replicaSettings | PolicyReplicaSettings | Settings for snapshot replicas configured for the backup policy. |
backupSettings | PolicyBackupSettings | Backup settings configured for the backup policy. |
regionIds | array [string($uuid)] | System IDs assigned in the Veeam Backup for AWS REST API to AWS regions where EC2 instances that are backed up reside. |
selectedItems | PolicyBackupItems | AWS resources selected to be protected by the backup policy. |
excludedItems | PolicyBackupItems | AWS resources excluded from the backup policy. |
scheduleSettings | ScheduleSettings | Backup schedule specified for the backup policy. |
name | string | Name of the backup policy. |
description | string | Description of the backup policy. |
priority | integer($int64) | Priority order number of the backup policy. |
amazonAccountId | string($uuid) | System ID assigned in the Veeam Backup for AWS REST API to an IAM role whose permissions Veeam Backup for AWS uses to access AWS resources and perform EC2 instance backup. |
retrySettings | RetrySettings | Retry settings configured for the backup policy. |
policyNotificationSettings | PolicyNotificationSettings | Notification settings configured for the backup policy. |
isEnabled | boolean | Defines whether the backup policy is enabled. |
backupType | string | Type of the backup policy: AllItems, SelectedItems. |
createdBy | string | Veeam Backup for AWS user that created the backup policy. |
modifiedBy | string | Veeam Backup for AWS user that modified the backup policy. |
usn | integer($int64) | Update sequence number of the policy. |
warning | string | Warning message on the AWS limits exceeding if any. |
lastPolicySessionStatus | string | Status of the most recent backup session: Running, NeverExecuted, Succeeded, Warning, Failed, Canceled. |
_embeddedResources | PolicyEmbeddedResources | A list of methods and operations used to get the backup policy in the Veeam Backup for AWS REST API, and request URLs used to perform the operations. |
_links | array | A list of methods and operations available for the backup policy in the Veeam Backup for AWS REST API, and request URLs used to perform the operations. |
PolicySnapshotSettings
Property | Type | Description |
|---|
additionalTags | TagSpec | Information on tags assigned to the snapshots. | copyTagsFromVolumeEnabled | boolean | Defines whether to assign to the snapshot replicas tags of EBS volumes attached to processed EC2 instances. | tryCreateVSSSnapshot | boolean | Defines whether application-aware processing for Windows EC2 instances running VSS-aware applications is enabled. |
|
PolicyReplicaSettings
Property | Type | Description |
|---|
mapping | ReplicaMapping | Information on configured snapshot replication mapping. | additionalTags | TagSpec | Information on tags assigned to snapshot replicas. | copyTagsFromVolumeEnabled | boolean | Defines whether to assign to the replicated snapshots tags of EBS volumes attached to processed EC2 instances. |
|
TagSpec
Property | Type | Description |
|---|
key | string | Key of an AWS tag. | value | string | Value of the AWS tag. |
|
ReplicaMapping
Property | Type | Description |
|---|
sourceRegionId | string($uuid) | System ID assigned in the Veeam Backup for AWS REST API to the source AWS region. | targetRegionId | string($uuid) | System ID assigned in the Veeam Backup for AWS REST API to the target AWS region. | targetAmazonAccountId | string($uuid) | System ID assigned in the Veeam Backup for AWS REST API to an IAM role whose permissions Veeam Backup for AWS uses to copy and store snapshots in a target AWS region. | encryptionKey | string | AWS Key Management Service (AWS KMS) customer master keys (CMK) used for snapshot encryption. |
|
PolicyBackupSettings
Property | Type | Description |
|---|
targetRepositoryId | string($uuid) | 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
Property | Type | Description |
|---|
virtualMachineIds | array [string($uuid)] | System IDs assigned to EC2 instances in the Veeam Backup for AWS REST API. | tagIds | array [string($uuid)] | System IDs assigned to AWS tags in the Veeam Backup for AWS REST API. |
|
ScheduleSettings
Property | Type | Description |
|---|
dailyScheduleEnabled | boolean | Defines whether backup daily schedule is enabled. | dailySchedule | DailyScheduleSettings | Backup daily schedule settings configured for the backup policy. | weeklyScheduleEnabled | boolean | Defines whether backup weekly schedule is enabled. | weeklySchedule | WeeklyScheduleSettings | Backup weekly schedule settings configured for the backup policy. | monthlyScheduleEnabled | boolean | Defines whether backup monthly schedule is enabled. | monthlySchedule | MonthlyScheduleSettings | Backup monthly schedule settings configured for the backup policy. | yearlyScheduleEnabled | boolean | Defines whether backup yearly schedule is enabled. | yearlySchedule | YearlyScheduleSettings | Backup yearly schedule settings configured for the backup policy. |
|
DailyScheduleSettings
Property | Type | Description |
|---|
kind | string | Days when the backup policy must run: Everyday, WeekDays, SelectedDays. | runsPerHour | integer($int32) | [Applies only for cloud-native snapshots] Number of cloud-native snapshots that the backup policy must create within an hour (minimum: 1). | days | array [string] | [Applies if the Selected days value is specified for the kind parameter ] Days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. | snapshotOptions | DailySnapshotScheduleSettings | Daily schedule settings for cloud-native snapshots. | backupOptions | DailyBackupScheduleSettings | Daily schedule settings for image-level backups. | replicaOptions | DailyReplicaScheduleSettings | Daily schedule settings for snapshot replicas. |
|
DailySnapshotScheduleSettings, DailyReplicaScheduleSettings
Property | Type | Description |
|---|
retention | PointsRetentionOptions | Number of restore points to keep in cloud-native snapshot and snapshot replica chains. | schedule | DailySchedule | Hours when the backup policy must run. |
|
DailyBackupScheduleSettings
Property | Type | Description |
|---|
retention | PeriodRetentionOptions | Number of days (or months) to keep restore points in a backup chain. | schedule | DailySchedule | Hours when the backup policy must run. |
|
WeeklyScheduleSettings
WeeklySnapshotScheduleSettings, WeeklyReplicaScheduleSettings
Property | Type | Description |
|---|
retention | PointsRetentionOptions | Number of restore points to keep in cloud-native snapshot and snapshot replica chains. | schedule | WeeklySchedule | Days of the week when the backup policy must run. |
|
WeeklyBackupScheduleSettings
Property | Type | Description |
|---|
retention | PeriodRetentionOptions | Number of days (or months) to keep restore points in a backup chain. | schedule | WeeklySchedule | Days of the week when the backup policy must run. |
|
MonthlyScheduleSettings
Property | Type | Description |
|---|
timeLocal | string($date-time) | Date of the backup policy creation or modification and time when the backup policy must run. | dayNumberInMonth | string | Day of the month when the backup policy must run: First, Second, Third, Fourth, Last, OnDay. | dayOfWeek | array [string] | [Applies if one of the First, Second, Third, Fourth or Last values is specified for the dayNumberInMonth parameter] Days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. | dayOfMonth | integer($int32) | [Applies if the OnDay value is specified for the dayNumberInMonth parameter] Ordinal number of the day of the month when the backup policy must run. | snapshotOptions | MonthlySnapshotScheduleSettings | Monthly schedule settings for cloud-native snapshots. | backupOptions | MonthlyBackupScheduleSettings | Monthly schedule settings for image-level backups. | replicaOptions | MonthlyReplicaScheduleSettings | Monthly schedule settings for snapshot replicas. |
|
MonthlySnapshotScheduleSettings, MonthlyReplicaScheduleSettings
Property | Type | Description |
|---|
retention | PointsRetentionOptions | Number of restore points to keep in cloud-native snapshot and snapshot replica chains. | schedule | MonthlySchedule | Months when the backup policy must run. |
|
MonthlyBackupScheduleSettings
Property | Type | Description |
|---|
retention | PeriodRetentionOptions | Number of days (or months) for which you want to keep restore points in a backup chain. | schedule | MonthlySchedule | Months when the backup policy must run. |
|
YearlyScheduleSettings
Property | Type | Description |
|---|
timeLocal | string($date-time) | Date of the backup policy creation or modification and time when the backup policy must run. | dayNumberInMonth | string | Day of the month when the backup policy must run: First, Second, Third, Fourth, Last, OnDay. | dayOfWeek | array [string] | [Applies if one of the First, Second, Third, Fourth or Last values is specified for the dayNumberInMonth parameter] Days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. | dayOfMonth | integer($int32) | [Applies if the OnDay value is specified for the dayNumberInMonth parameter] Ordinal number of the day of the month when the backup policy must run. | month | array [string] | Month when the backup policy must run: January, February, March, April, May, June, July, August, September, October, November, December. | retention | YearlyRetentionOptions | Number of years to keep restore points in a backup chain. |
|
PointsRetentionOptions
Property | Type | Description |
|---|
count | integer($int32) | Number of restore points to keep in cloud-native snapshot and snapshot replica chains. |
|
PeriodRetentionOptions
Property | Type | Description |
|---|
type | string | Type of the period: Days, Months. | count | integer($int32) | Number of days (or months) to keep restore points in a backup chain. |
|
YearlyRetentionOptions
Property | Type | Description |
|---|
count | integer($int32) | Number of years to keep restore points in a backup chain. | type | array [string] | Type of the period: Years. |
|
DailySchedule
Property | Type | Description |
|---|
hours | array [boolean] | Hours when the backup policy must start creating cloud-native snapshots, snapshot replicas or image-level backups. |
|
WeeklySchedule
Property | Type | Description |
|---|
days | array [string] | 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
Property | Type | Description |
|---|
months | array [string] | 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
Property | Type | Description |
|---|
retryTimes | integer($int32) | Maximum number of retry attempts specified for the backup policy. |
|
PolicyNotificationSettings
Property | Type | Description |
|---|
recipient | string | Recipient email address. | notifyOnSuccess | boolean | Defines whether to receive an email notification if a policy completes successfully. | notifyOnWarning | boolean | Defines whether to receive an email notification if a policy completes with a warning. | notifyOnFailure | boolean | Defines whether to receive an email notification if a policy fails. |
|
PolicyEmbeddedResources
Property | Type | Description |
|---|
lastBackupSession | link | Request URL used to get information on the most recent backup session. | lastFinishedBackupSession | link | Request URL used to get information on the most recent completed backup session. | targetRepository | link | Request URL used to get information on the target S3 repository. | protectedResources | link | Request URL used to get information on AWS resources protected by the backup policy. | excludedResources | link | Request URL used to get information on AWS resources excluded from the backup policy. | regions | link | Request URL used to get information on AWS regions selected for the backup policy. |
|