Actions, resources, and condition keys for Amazon Backup Gateway
Amazon Backup Gateway (service prefix: backup-gateway) 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 Amazon Backup Gateway
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.
The Access level column of the Actions table describes how the action is classified (List, Read, Permissions management, or Tagging). This classification can help you understand the level of access that an action grants when you use it in a policy. For more information about access levels, see Access levels in policy summaries.
The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies 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. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.
The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.
Note
Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.
For details about the columns in the following table, see Actions table.
| Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
|---|---|---|---|---|---|
| AssociateGatewayToServer | Grants permission to AssociateGatewayToServer | Write | |||
| Backup | Grants permission to Backup | Write | |||
| CreateGateway | Grants permission to to CreateGateway | Write | |||
| DeleteGateway | Grants permission to DeleteGateway | Write | |||
| DeleteHypervisor | Grants permission to DeleteHypervisor | Write | |||
| DisassociateGatewayFromServer | Grants permission to DisassociateGatewayFromServer | Write | |||
| GetBandwidthRateLimitSchedule | Grants permission to GetBandwidthRateLimitSchedule | Read | |||
| GetGateway | Grants permission to GetGateway | Read | |||
| GetHypervisor | Grants permission to GetHypervisor | Read | |||
| GetHypervisorPropertyMappings | Grants permission to GetHypervisorPropertyMappings | Read | |||
| GetVirtualMachine | Grants permission to GetVirtualMachine | Read | |||
| ImportHypervisorConfiguration | Grants permission to ImportHypervisorConfiguration | Write | |||
| ListGateways | Grants permission to ListGateways | Read | |||
| ListHypervisors | Grants permission to ListHypervisors | Read | |||
| ListTagsForResource | Grants permission to ListTagsForResource | Read | |||
| ListVirtualMachines | Grants permission to ListVirtualMachines | Read | |||
| PutBandwidthRateLimitSchedule | Grants permission to PutBandwidthRateLimitSchedule | Write | |||
| PutHypervisorPropertyMappings | Grants permission to PutHypervisorPropertyMappings | Write |
iam:PassRole |
||
| PutMaintenanceStartTime | Grants permission to PutMaintenanceStartTime | Write | |||
| Restore | Grants permission to Restore | Write | |||
| StartVirtualMachinesMetadataSync | Grants permission to StartVirtualMachinesMetadataSync | Write |
iam:PassRole |
||
| TagResource | Grants permission to TagResource | Tagging | |||
| TestHypervisorConfiguration | Grants permission to TestHypervisorConfiguration | Write | |||
| UntagResource | Grants permission to UntagResource | Tagging | |||
| UpdateGatewayInformation | Grants permission to UpdateGatewayInformation | Write | |||
| UpdateGatewaySoftwareNow | Grants permission to UpdateGatewaySoftwareNow | Write | |||
| UpdateHypervisor | Grants permission to UpdateHypervisor | Write |
Resource types defined by Amazon Backup Gateway
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 Resource types table. For details about the columns in the following table, see Resource types table.
| Resource types | ARN | Condition keys |
|---|---|---|
| gateway |
arn:${Partition}:backup-gateway:${Region}:${Account}:gateway/${GatewayId}
|
|
| hypervisor |
arn:${Partition}:backup-gateway:${Region}:${Account}:hypervisor/${HypervisorId}
|
|
| virtualmachine |
arn:${Partition}:backup-gateway:${Region}:${Account}:vm/${VirtualmachineId}
|
Condition keys for Amazon Backup Gateway
Amazon Backup Gateway 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 Condition keys table.
To view the global condition keys that are available to all services, see Amazon global condition context keys.
| Condition keys | Description | Type |
|---|---|---|
| aws:RequestTag/${TagKey} | Filters access by the allowed set of values for each of the tags | String |
| aws:ResourceTag/${TagKey} | Filters access by tag-value associated with the resource | String |
| aws:TagKeys | Filters access by the presence of mandatory tags in the request | ArrayOfString |