Actions, resources, and condition keys for Amazon Backup
Amazon Backup (service prefix: backup) provides the following
service-specific operations, resources, actions, and condition keys for use in IAM permission
policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon Backup
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
AssociateBackupVaultMpaApprovalTeam |
Write |
|||
|
CancelLegalHold |
Write |
|||
|
CreateBackupPlan |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
malware-protection.guardduty.amazonaws.com |
Write |
||
|
CreateBackupSelection |
Write |
|||
iam:PassedToService |
backup.amazonaws.com |
Write |
||
|
CreateBackupVault |
Write |
|||
Tagging, Write |
||||
|
CreateFramework |
Write |
|||
Tagging, Write |
||||
|
CreateLegalHold |
Write |
|||
Tagging, Write |
||||
|
CreateLogicallyAirGappedBackupVault |
Write |
|||
Tagging, Write |
||||
|
CreateReportPlan |
Write |
|||
Tagging, Write |
||||
|
CreateRestoreAccessBackupVault |
Write |
|||
Tagging, Write |
||||
|
CreateRestoreTestingPlan |
Write |
|||
Tagging, Write |
||||
|
CreateRestoreTestingSelection |
Write |
|||
iam:PassedToService |
restore-testing.backup.amazonaws.com |
Write |
||
|
CreateTieringConfiguration |
Write |
|||
Tagging, Write |
||||
|
DeleteBackupPlan |
Write |
|||
|
DeleteBackupSelection |
Write |
|||
|
DeleteBackupVault |
Write |
|||
|
DeleteBackupVaultAccessPolicy |
Permissions management, Write |
|||
|
DeleteBackupVaultLockConfiguration |
Write |
|||
|
DeleteBackupVaultNotifications |
Write |
|||
|
DeleteFramework |
Write |
|||
|
DeleteRecoveryPoint |
Write |
|||
|
DeleteReportPlan |
Write |
|||
|
DeleteRestoreTestingPlan |
Write |
|||
|
DeleteRestoreTestingSelection |
Write |
|||
|
DeleteTieringConfiguration |
Write |
|||
|
DescribeBackupJob |
Read |
|||
|
DescribeBackupVault |
Read |
|||
|
DescribeCopyJob |
Read |
|||
|
DescribeFramework |
Read |
|||
|
DescribeGlobalSettings |
Read |
|||
|
DescribeProtectedResource |
Read |
|||
|
DescribeRecoveryPoint |
Read |
|||
|
DescribeRegionSettings |
Read |
|||
|
DescribeReportJob |
Read |
|||
|
DescribeReportPlan |
Read |
|||
|
DescribeRestoreJob |
Read |
|||
|
DescribeScanJob |
Read |
|||
|
DisassociateBackupVaultMpaApprovalTeam |
Write |
|||
|
DisassociateRecoveryPoint |
Write |
|||
|
DisassociateRecoveryPointFromParent |
Write |
|||
|
ExportBackupPlanTemplate |
Read |
|||
|
GetBackupPlan |
Read |
|||
|
GetBackupPlanFromJSON |
Read |
|||
|
GetBackupPlanFromTemplate |
Read |
|||
|
GetBackupSelection |
Read |
|||
|
GetBackupVaultAccessPolicy |
Read |
|||
|
GetBackupVaultNotifications |
Read |
|||
|
GetLegalHold |
Read |
|||
|
GetPITRMalwareScanResults |
Read |
|||
|
GetRecoveryPointIndexDetails |
Read |
|||
|
GetRecoveryPointRestoreMetadata |
Read |
|||
|
GetRestoreJobMetadata |
Read |
|||
|
GetRestoreTestingInferredMetadata |
Read |
|||
|
GetRestoreTestingPlan |
Read |
|||
|
GetRestoreTestingSelection |
Read |
|||
|
GetSupportedResourceTypes |
Read |
|||
|
GetTieringConfiguration |
Read |
|||
|
ListBackupJobSummaries |
List |
|||
|
ListBackupJobs |
List |
|||
|
ListBackupPlanTemplates |
List |
|||
|
ListBackupPlanVersions |
List |
|||
|
ListBackupPlans |
List |
|||
|
ListBackupSelections |
List |
|||
|
ListBackupVaults |
List |
|||
|
ListCopyJobSummaries |
List |
|||
|
ListCopyJobs |
List |
|||
|
ListFrameworks |
List |
|||
|
ListIndexedRecoveryPoints |
List |
|||
|
ListLegalHolds |
List |
|||
|
ListProtectedResources |
List |
|||
|
ListProtectedResourcesByBackupVault |
List |
|||
|
ListRecoveryPointsByBackupVault |
List |
|||
|
ListRecoveryPointsByLegalHold |
List |
|||
|
ListRecoveryPointsByResource |
List |
|||
|
ListReportJobs |
List |
|||
|
ListReportPlans |
List |
|||
|
ListRestoreAccessBackupVaults |
List |
|||
|
ListRestoreJobSummaries |
List |
|||
|
ListRestoreJobs |
List |
|||
|
ListRestoreJobsByProtectedResource |
List |
|||
|
ListRestoreTestingPlans |
List |
|||
|
ListRestoreTestingSelections |
List |
|||
|
ListScanJobSummaries |
List |
|||
|
ListScanJobs |
List |
|||
|
ListTags |
Read |
|||
|
ListTieringConfigurations |
List |
|||
|
PutBackupVaultAccessPolicy |
Permissions management, Write |
|||
|
PutBackupVaultLockConfiguration |
Write |
|||
|
PutBackupVaultNotifications |
Write |
|||
|
PutRestoreValidationResult |
Write |
|||
|
RevokeRestoreAccessBackupVault |
Write |
|||
|
StartBackupJob |
Write |
|||
iam:PassedToService |
backup.amazonaws.com |
Write |
||
|
StartCopyJob |
Write |
|||
iam:PassedToService |
backup.amazonaws.com |
Write |
||
|
StartReportJob |
Write |
|||
|
StartRestoreJob |
Write |
|||
iam:PassedToService |
backup.amazonaws.com |
Write |
||
|
StartScanJob |
Write |
|||
iam:PassedToService |
backup.amazonaws.com, malware-protection.guardduty.amazonaws.com |
Write |
||
|
StopBackupJob |
Write |
|||
|
TagResource |
Tagging, Write |
|||
|
UntagResource |
Tagging, Write |
|||
|
UpdateBackupPlan |
Write |
|||
iam:PassedToService |
malware-protection.guardduty.amazonaws.com |
Write |
||
|
UpdateFramework |
Write |
|||
|
UpdateGlobalSettings |
Write |
|||
|
UpdateRecoveryPointIndexSettings |
Write |
|||
iam:PassedToService |
backup.amazonaws.com |
Write |
||
|
UpdateRecoveryPointLifecycle |
Write |
|||
|
UpdateRegionSettings |
Write |
|||
|
UpdateReportPlan |
Write |
|||
|
UpdateRestoreTestingPlan |
Write |
|||
|
UpdateRestoreTestingSelection |
Write |
|||
iam:PassedToService |
restore-testing.backup.amazonaws.com |
Write |
||
|
UpdateTieringConfiguration |
Write |
Actions defined by Amazon Backup
You can specify the following actions in the Action element of an IAM
policy statement. Use policies to grant permissions to perform an operation in Amazon. When
you use an action in a policy, you usually allow or deny access to the API operation or CLI
command with the same name. However, in some cases, a single action controls access to more
than one operation. Alternatively, some operations require several different actions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to associate an MPA approval team with a backup vault |
Write |
|||
Grants permission to cancel a legal hold |
Write |
|||
Grants permission to create a new backup plan |
Write |
|||
Grants permission to create a new resource assignment in a backup plan |
Write |
|||
Grants permission to create a new backup vault |
Write |
|||
Grants permission to create a new framework |
Write |
|||
Grants permission to create a new legal hold |
Write |
|||
Grants permission to create a new logically air-gapped backup vault, a logical container where backups are stored |
Write |
|||
Grants permission to create a new report plan |
Write |
|||
Grants permission to create a restore access backup vault |
Write |
|||
Grants permission to create a new restore testing plan |
Write |
|||
Grants permission to create a new resource assignment in a restore testing plan |
Write |
|||
Grants permission to create a new tiering configuration |
Write |
|||
Grants permission to delete a backup plan |
Write |
|||
Grants permission to delete a resource assignment from a backup plan |
Write |
|||
Grants permission to delete a backup vault |
Write |
|||
Grants permission to delete backup vault access policy |
Permissions management, Write |
|||
Grants permission to remove the lock configuration from a backup vault |
Write |
|||
Grants permission to remove the notifications from a backup vault |
Write |
|||
Grants permission to delete a framework |
Write |
|||
Grants permission to delete a recovery point from a backup vault |
Write |
|||
Grants permission to delete a report plan |
Write |
|||
Grants permission to delete a restore testing plan |
Write |
|||
Grants permission to delete a resource assignment from a restore testing plan |
Write |
|||
Grants permission to delete a tiering configuration |
Write |
|||
Grants permission to describe a backup job |
Read |
|||
Grants permission to describe a new backup vault with the specified name |
Read |
|||
Grants permission to describe a copy job |
Read |
|||
Grants permission to describe a framework with the specified name |
Read |
|||
Grants permission to describe global settings |
Read |
|||
Grants permission to describe a protected resource |
Read |
|||
Grants permission to describe a recovery point |
Read |
|||
Grants permission to describe region settings |
Read |
|||
Grants permission to describe a report job |
Read |
|||
Grants permission to describe a report plan with the specified name |
Read |
|||
Grants permission to describe a restore job |
Read |
|||
Grants permission to describe a scan job |
Read |
|||
Grants permission to disassociate an MPA approval team from a backup vault |
Write |
|||
Grants permission to disassociate a recovery point from a backup vault |
Write |
|||
Grants permission to disassociate a recovery point from its parent |
Write |
|||
Grants permission to export a backup plan as a JSON |
Read |
|||
Grants permission to get a backup plan |
Read |
|||
Grants permission to transform a JSON to a backup plan |
Read |
|||
Grants permission to transform a template to a backup plan |
Read |
|||
Grants permission to get a backup plan resource assignment |
Read |
|||
Grants permission to get backup vault access policy |
Read |
|||
Grants permission to get backup vault notifications |
Read |
|||
Grants permission to get a legal hold |
Read |
|||
Grants permission to get point-in-time recovery (PITR) malware scan results |
Read |
|||
Grants permission to get indexing details for a recovery point |
Read |
|||
Grants permission to get recovery point restore metadata |
Read |
|||
Grants permission to get the restore metadata associated with a restore job |
Read |
|||
Grants permission to get inferred metadata generated by restore testing |
Read |
|||
Grants permission to get a restore testing plan |
Read |
|||
Grants permission to get a restore testing plan resource assignment |
Read |
|||
Grants permission to get supported resource types |
Read |
|||
Grants permission to describe a tiering configuration |
Read |
|||
Grants permission to list backup job summaries |
List |
|||
Grants permission to list backup jobs |
List |
|||
Grants permission to list backup plan templates provided by Amazon Backup |
List |
|||
Grants permission to list backup plan versions |
List |
|||
Grants permission to list backup plans |
List |
|||
Grants permission to list resource assignments for a specific backup plan |
List |
|||
Grants permission to list backup vaults |
List |
|||
Grants permission to list copy job summaries |
List |
|||
Grants permission to list copy jobs |
List |
|||
Grants permission to list frameworks |
List |
|||
Grants permission to get list indexed recovery points |
List |
|||
Grants permission to list legal holds |
List |
|||
Grants permission to list protected resources by Amazon Backup |
List |
|||
Grants permission to list protected resources inside a backup vault |
List |
|||
Grants permission to list recovery points inside a backup vault |
List |
|||
Grants permission to list recovery points by legal hold |
List |
|||
Grants permission to list recovery points for a resource |
List |
|||
Grants permission to list report jobs |
List |
|||
Grants permission to list report plans |
List |
|||
Grants permission to list a restore access backup vaults associated with a backup vault |
List |
|||
Grants permission to list restore job summaries |
List |
|||
Grants permission to list restore jobs |
List |
|||
Grants permission to list restore jobs for a protected resource |
List |
|||
Grants permission to list restore testing plans |
List |
|||
Grants permission to list resource assignments for a specific restore testing plan |
List |
|||
Grants permission to list scan job summaries |
List |
|||
Grants permission to list scan jobs |
List |
|||
Grants permission to list tags for a resource |
Read |
|||
Grants permission to list tiering configurations |
List |
|||
Grants permission to add an access policy to the backup vault |
Permissions management, Write |
|||
Grants permission to add a lock configuration to the backup vault |
Write |
|||
Grants permission to add an SNS topic to the backup vault |
Write |
|||
Grants permission to put a restore validation result |
Write |
|||
Grants permission to revoke a restore access backup vault |
Write |
|||
Grants permission to start a new backup job |
Write |
|||
Grants permission to copy a backup from a source backup vault to a destination backup vault |
Write |
|||
Grants permission to start a new report job |
Write |
|||
Grants permission to start a new restore job |
Write |
|||
Grants permission to start a new scan job |
Write |
|||
Grants permission to stop a backup job |
Write |
|||
Grants permission to tag a resource |
Tagging, Write |
|||
Grants permission to untag a resource |
Tagging, Write |
|||
Grants permission to update a backup plan |
Write |
|||
Grants permission to update a framework |
Write |
|||
Grants permission to update the current global settings for the Amazon Account |
Write |
|||
Grants permission to update recovery point index settings |
Write |
|||
Grants permission to update the lifecycle of the recovery point |
Write |
|||
Grants permission to update the current service opt-in settings for the Region |
Write |
|||
Grants permission to update a report plan |
Write |
|||
Grants permission to update a restore testing plan |
Write |
|||
Grants permission to update a resource assignment in a restore testing plan |
Write |
|||
Grants permission to update a tiering configuration |
Write |
Permission-only actions for Amazon Backup
The following actions are defined by Amazon Backup but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to copy from a backup vault |
Write |
|||
Grants permission to copy into a backup vault |
Write |
|||
Grants permission to create a new access point for backup instant access |
Write |
|||
Grants permission to delete the access point |
Write |
|||
Grants permission to delete backup vault sharing policy |
Permissions management, Write |
|||
Grants permission to return information about the specified access point |
Read |
|||
Grants permission to get backup vault sharing policy |
Read |
|||
Grants permission to list indexed recovery points to search |
Permissions management, Write |
|||
Grants permission to add a sharing policy to the backup vault |
Permissions management, Write |
|||
Grants permission to search a recovery point |
Permissions management, Write |
Resource types defined by Amazon Backup
The following resource types are defined by this service and can be used in the
Resource element of IAM permission policy statements.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:backup:${Region}:${Account}:backup-plan:${BackupPlanId} |
||
arn:${Partition}:backup:${Region}:${Account}:backup-vault:${BackupVaultName} |
||
arn:${Partition}:backup:${Region}:${Account}:framework:${FrameworkName}-${FrameworkId} |
||
arn:${Partition}:backup:${Region}:${Account}:legal-hold:${LegalHoldId} |
||
arn:${Partition}:${Vendor}:${Region}:*:${ResourceType}:${RecoveryPointId} |
||
arn:${Partition}:backup:${Region}:${Account}:report-plan:${ReportPlanName}-${ReportPlanId} |
||
arn:${Partition}:backup:${Region}:${Account}:restore-testing-plan:${RestoreTestingPlanName}-${RestoreTestingPlanId} |
||
arn:${Partition}:backup:${Region}:${Account}:tiering-configuration:${TieringConfigurationName}-${TieringConfigurationId} |
Condition keys for Amazon Backup
Amazon Backup defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the allowed set of values for each of the tags |
String |
|
Filters access by the tags associated with the resource |
String |
|
Filters access by the presence of mandatory tags in the request |
ArrayOfString |
|
Filters access by the value of the ChangeableForDays parameter |
Numeric |
|
Filters access by the organization unit |
ArrayOfString |
|
Filters access by the ARN of a backup vault |
ArrayOfARN |
|
Filters access by the Framework ARNs |
ArrayOfARN |
|
Filters access by the value of Index parameter |
String |
|
Filters access by the value of the MaxRetentionDays parameter |
Numeric |
|
Filters access by the value of the MinRetentionDays parameter |
Numeric |
|
Filters access by the MPA Approval Team ARN of a backup vault |
ARN |