Actions, resources, and condition keys for AWS Backup Gateway - Service Authorization Reference

Actions, resources, and condition keys for AWS Backup Gateway

AWS Backup Gateway (service prefix: backup-gateway) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by AWS 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 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 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

gateway*

hypervisor*

Backup Grants permission to Backup Write

virtualmachine*

CreateGateway Grants permission to to CreateGateway Write

aws:RequestTag/${TagKey}

aws:TagKeys

DeleteGateway Grants permission to DeleteGateway Write

gateway*

DeleteHypervisor Grants permission to DeleteHypervisor Write

hypervisor*

DisassociateGatewayFromServer Grants permission to DisassociateGatewayFromServer Write

gateway*

GetBandwidthRateLimitSchedule Grants permission to GetBandwidthRateLimitSchedule Read

gateway*

GetGateway Grants permission to GetGateway Read

gateway*

GetHypervisor Grants permission to GetHypervisor Read

hypervisor*

GetHypervisorPropertyMappings Grants permission to GetHypervisorPropertyMappings Read

hypervisor*

GetVirtualMachine Grants permission to GetVirtualMachine Read

virtualmachine*

ImportHypervisorConfiguration Grants permission to ImportHypervisorConfiguration Write

aws:RequestTag/${TagKey}

aws:TagKeys

ListGateways Grants permission to ListGateways Read
ListHypervisors Grants permission to ListHypervisors Read
ListTagsForResource Grants permission to ListTagsForResource Read

gateway

hypervisor

virtualmachine

ListVirtualMachines Grants permission to ListVirtualMachines Read
PutBandwidthRateLimitSchedule Grants permission to PutBandwidthRateLimitSchedule Write

gateway*

PutHypervisorPropertyMappings Grants permission to PutHypervisorPropertyMappings Write

hypervisor*

iam:PassRole

PutMaintenanceStartTime Grants permission to PutMaintenanceStartTime Write

gateway*

Restore Grants permission to Restore Write

hypervisor*

StartVirtualMachinesMetadataSync Grants permission to StartVirtualMachinesMetadataSync Write

hypervisor*

iam:PassRole

TagResource Grants permission to TagResource Tagging

gateway

hypervisor

virtualmachine

aws:RequestTag/${TagKey}

aws:TagKeys

TestHypervisorConfiguration Grants permission to TestHypervisorConfiguration Write

gateway*

UntagResource Grants permission to UntagResource Tagging

gateway

hypervisor

virtualmachine

aws:TagKeys

UpdateGatewayInformation Grants permission to UpdateGatewayInformation Write

gateway*

UpdateGatewaySoftwareNow Grants permission to UpdateGatewaySoftwareNow Write

gateway*

UpdateHypervisor Grants permission to UpdateHypervisor Write

gateway*

Resource types defined by AWS 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::${Account}:gateway/${GatewayId}

aws:ResourceTag/${TagKey}

hypervisor arn:${Partition}:backup-gateway::${Account}:hypervisor/${HypervisorId}

aws:ResourceTag/${TagKey}

virtualmachine arn:${Partition}:backup-gateway::${Account}:vm/${VirtualmachineId}

aws:ResourceTag/${TagKey}

Condition keys for AWS Backup Gateway

AWS 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 Available global condition 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