Actions, resources, and condition keys for AWS Backup
AWS Backup (service prefix: backup
) provides the following service-specific resources, actions, and condition context
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.
Topics
Actions defined by AWS 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 AWS. 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.
The Resource types column indicates whether each action supports resource-level permissions. If
there is no value for this column, you must specify all resources ("*") in the
Resource
element of your policy statement. If the column includes a resource type, then
you can specify an ARN of that type in a statement with that action. Required
resources are indicated in the table with an asterisk (*). If you specify a resource-level
permission ARN in a statement using this action, then it must be of this type.
Some actions support multiple resource types. If the resource type is optional (not
indicated as required), then you can choose to use one but not the other.
For details about the columns in the following table, see The actions table.
Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
---|---|---|---|---|---|
CopyFromBackupVault [permission only] | Allows to copy from a backup vault | Write | |||
CopyIntoBackupVault [permission only] | Allows to copy into a backup vault | Write | |||
CreateBackupPlan | Creates a new backup plan | Write | |||
CreateBackupSelection | Creates a new resource assignment in a backup plan. | Write |
iam:PassRole |
||
CreateBackupVault | Creates a new backup vault. | Write | |||
DeleteBackupPlan | Deletes a backup plan. | Write | |||
DeleteBackupSelection | Deletes a resource assignment from a backup plan. | Write | |||
DeleteBackupVault | Deletes a backup vault. | Write | |||
DeleteBackupVaultAccessPolicy | Deletes backup vault access policy. | Write | |||
DeleteBackupVaultNotifications | Removes notifications from backup vault. | Write | |||
DeleteRecoveryPoint | Deletes a recovery point from a backup vault. | Write | |||
DescribeBackupJob | Describes a backup job | Read | |||
DescribeBackupVault | Describes a new backup vault with the specified name. | Read | |||
DescribeCopyJob | Describes a copy job | Read | |||
DescribeGlobalSettings | Describes global settings | Read | |||
DescribeProtectedResource | Describes a protected resource. | Read | |||
DescribeRecoveryPoint | Describes a recovery point. | Read | |||
DescribeRegionSettings | Describes region settings | Read | |||
DescribeRestoreJob | Describes a restore job. | Read | |||
ExportBackupPlanTemplate | Exports a backup plan as a JSON. | Read | |||
GetBackupPlan | Gets a backup plan. | Read | |||
GetBackupPlanFromJSON | Transforms a JSON to a backup plan. | Read | |||
GetBackupPlanFromTemplate | Transforms a template to a backup plan. | Read | |||
GetBackupSelection | Gets a backup plan resource assignment. | Read | |||
GetBackupVaultAccessPolicy | Gets backup vault access policy. | Read | |||
GetBackupVaultNotifications | Gets backup vault notifications. | Read | |||
GetRecoveryPointRestoreMetadata | Gets recovery point restore metadata. | Read | |||
GetSupportedResourceTypes | Gets supported resource types. | Read | |||
ListBackupJobs | Lists backup jobs. | List | |||
ListBackupPlanTemplates | Lists backup plan templates provided by AWS Backup. | List | |||
ListBackupPlanVersions | Lists backup plan versions. | List | |||
ListBackupPlans | Lists backup plans. | List | |||
ListBackupSelections | Lists resource assignments for a specific backup plan. | List | |||
ListBackupVaults | Lists backup vaults. | List | |||
ListCopyJobs | Lists copy jobs | List | |||
ListProtectedResources | Lists protected resources by AWS Backup. | List | |||
ListRecoveryPointsByBackupVault | Lists recovery points inside a backup vault. | List | |||
ListRecoveryPointsByResource | Lists recovery points for a resource. | List | |||
ListRestoreJobs | Lists restore jobs. | List | |||
ListTags | Lists tags for a resource. | List | |||
PutBackupVaultAccessPolicy | Adds an access policy to the backup vault. | Write | |||
PutBackupVaultNotifications | Adds an SNS topic to the backup vault. | Write | |||
StartBackupJob | Starts a new backup job. | Write |
iam:PassRole |
||
StartCopyJob | Copy a backup from a source backup vault to a destination backup vault. | Write |
iam:PassRole |
||
StartRestoreJob | Starts a new restore job. | Write |
iam:PassRole |
||
StopBackupJob | Stops a backup job. | Write | |||
TagResource | Tags a resource. | Tagging | |||
UntagResource | Untags a resource. | Tagging | |||
UpdateBackupPlan | Updates a backup plan. | Write | |||
UpdateGlobalSettings | Updates global settings | Write | |||
UpdateRecoveryPointLifecycle | Updates the lifecycle of the recovery point. | Write | |||
UpdateRegionSettings | Describes region settings | Write |
Resource types defined by AWS Backup
The following resource types are defined by this service and can be used in the
Resource
element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource
type can also define which condition keys you can include in a policy. These
keys are displayed in the last column of the table. For details about the columns
in the following table, see The resource types table.
Resource types | ARN | Condition keys |
---|---|---|
backupVault |
arn:${Partition}:backup:${Region}:${Account}:backup-vault:${BackupVaultName}
|
|
backupPlan |
arn:${Partition}:backup:${Region}:${Account}:backup-plan:${BackupPlanId}
|
|
recoveryPoint |
arn:${Partition}:${Vendor}:${Region}:*:${ResourceType}:${RecoveryPointId}
|
Condition keys for AWS Backup
AWS Backup defines the following condition keys that can be used in the Condition
element of an IAM policy. You can use these keys to further refine the conditions
under which the policy statement applies. For details about the columns in the
following table, see The condition keys table.
To view the global condition keys that are available to all services, see Available global condition keys.
Condition keys | Description | Type |
---|---|---|
aws:RequestTag/${TagKey} | Filters actions based on the allowed set of values for each of the tags | String |
aws:ResourceTag/${TagKey} | Filters actions based on the tags associated with the resource | String |
aws:TagKeys | Filters actions based on the presence of mandatory tags in the request | String |
backup:CopyTargetOrgPaths | Filters actions based on the organization unit. | String |
backup:CopyTargets | Filters actions based on the ARN of an backup vault. | String |