Actions, resources, and condition keys for AWS App Mesh

AWS App Mesh (service prefix: appmesh) 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.

Actions defined by AWS App Mesh

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
CreateGatewayRoute	Grants permission to create a gateway route that is associated with a virtual gateway	Write	gatewayRoute*	aws:TagKeys aws:RequestTag/${TagKey}
CreateGatewayRoute		Write	virtualService
CreateMesh	Grants permission to create a service mesh	Write	mesh*
CreateMesh	Grants permission to create a service mesh	Write		aws:TagKeys aws:RequestTag/${TagKey}
CreateRoute	Grants permission to create a route that is associated with a virtual router	Write	route*	aws:TagKeys aws:RequestTag/${TagKey}
CreateRoute		Write	virtualNode
CreateVirtualGateway	Grants permission to create a virtual gateway within a service mesh	Write	virtualGateway*
CreateVirtualGateway		Write		aws:TagKeys aws:RequestTag/${TagKey}
CreateVirtualNode	Grants permission to create a virtual node within a service mesh	Write	virtualNode*	aws:TagKeys aws:RequestTag/${TagKey}
CreateVirtualNode		Write	virtualService
CreateVirtualRouter	Grants permission to create a virtual router within a service mesh	Write	virtualRouter*
CreateVirtualRouter		Write		aws:TagKeys aws:RequestTag/${TagKey}
CreateVirtualService	Grants permission to create a virtual service within a service mesh	Write	virtualService*	aws:TagKeys aws:RequestTag/${TagKey}
			virtualNode
			virtualRouter
DeleteGatewayRoute	Grants permission to delete an existing gateway route	Write	gatewayRoute*
DeleteMesh	Grants permission to delete an existing service mesh	Write	mesh*
DeleteMeshPolicy [permission only]	Grants permission to delete the RAM access control policy for a mesh	Write	mesh*
DeleteRoute	Grants permission to delete an existing route	Write	route*
DeleteVirtualGateway	Grants permission to delete an existing virtual gateway	Write	virtualGateway*
DeleteVirtualNode	Grants permission to delete an existing virtual node	Write	virtualNode*
DeleteVirtualRouter	Grants permission to delete an existing virtual router	Write	virtualRouter*
DeleteVirtualService	Grants permission to delete an existing virtual service	Write	virtualService*
DescribeGatewayRoute	Grants permission to describe an existing gateway route	Read	gatewayRoute*
DescribeMesh	Grants permission to describe an existing service mesh	Read	mesh*
DescribeRoute	Grants permission to describe an existing route	Read	route*
DescribeVirtualGateway	Grants permission to describe an existing virtual gateway	Read	virtualGateway*
DescribeVirtualNode	Grants permission to describe an existing virtual node	Read	virtualNode*
DescribeVirtualRouter	Grants permission to describe an existing virtual router	Read	virtualRouter*
DescribeVirtualService	Grants permission to describe an existing virtual service	Read	virtualService*
GetMeshPolicy [permission only]	Grants permission to read the RAM access control policy for a mesh	Read	mesh*
ListGatewayRoutes	Grants permission to list existing gateway routes in a service mesh	List	virtualGateway*
ListMeshes	Grants permission to list existing service meshes	List
ListRoutes	Grants permission to list existing routes in a service mesh	List	virtualRouter*
ListTagsForResource	Grants permission to list the tags for an App Mesh resource	List	gatewayRoute
			mesh
			route
			virtualGateway
			virtualNode
			virtualRouter
			virtualService
ListVirtualGateways	Grants permission to list existing virtual gateways in a service mesh	List	mesh*
ListVirtualNodes	Grants permission to list existing virtual nodes	List	mesh*
ListVirtualRouters	Grants permission to list existing virtual routers in a service mesh	List	mesh*
ListVirtualServices	Grants permission to list existing virtual services in a service mesh	List	mesh*
PutMeshPolicy [permission only]	Grants permission to define the RAM access control policy for a mesh	Write	mesh*
StreamAggregatedResources	Grants permission to receive streamed resources for an App Mesh endpoint (VirtualNode/VirtualGateway)	Read	virtualGateway
StreamAggregatedResources		Read	virtualNode
TagResource	Grants permission to tag a resource with a specified resourceArn	Tagging	gatewayRoute
			mesh
			route
			virtualGateway
			virtualNode
			virtualRouter
			virtualService
				aws:TagKeys aws:RequestTag/${TagKey}
UntagResource	Grants permission to delete a tag from a resource	Tagging	gatewayRoute
			mesh
			route
			virtualGateway
			virtualNode
			virtualRouter
			virtualService
				aws:TagKeys
UpdateGatewayRoute	Grants permission to update an existing gateway route for a specified service mesh and virtual gateway	Write	gatewayRoute*
UpdateGatewayRoute		Write	virtualService
UpdateMesh	Grants permission to update an existing service mesh	Write	mesh*
UpdateRoute	Grants permission to update an existing route for a specified service mesh and virtual router	Write	route*
UpdateRoute		Write	virtualNode
UpdateVirtualGateway	Grants permission to update an existing virtual gateway in a specified service mesh	Write	virtualGateway*
UpdateVirtualNode	Grants permission to update an existing virtual node in a specified service mesh	Write	virtualNode*
UpdateVirtualRouter	Grants permission to update an existing virtual router in a specified service mesh	Write	virtualRouter*
UpdateVirtualService	Grants permission to update an existing virtual service in a specified service mesh	Write	virtualService*
			virtualNode
			virtualRouter

Resource types defined by AWS App Mesh

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
mesh	`arn:${Partition}:appmesh:${Region}:${Account}:mesh/${MeshName}`	aws:ResourceTag/${TagKey}
virtualService	`arn:${Partition}:appmesh:${Region}:${Account}:mesh/${MeshName}/virtualService/${VirtualServiceName}`	aws:ResourceTag/${TagKey}
virtualNode	`arn:${Partition}:appmesh:${Region}:${Account}:mesh/${MeshName}/virtualNode/${VirtualNodeName}`	aws:ResourceTag/${TagKey}
virtualRouter	`arn:${Partition}:appmesh:${Region}:${Account}:mesh/${MeshName}/virtualRouter/${VirtualRouterName}`	aws:ResourceTag/${TagKey}
route	`arn:${Partition}:appmesh:${Region}:${Account}:mesh/${MeshName}/virtualRouter/${VirtualRouterName}/route/${RouteName}`	aws:ResourceTag/${TagKey}
virtualGateway	`arn:${Partition}:appmesh:${Region}:${Account}:mesh/${MeshName}/virtualGateway/${VirtualGatewayName}`	aws:ResourceTag/${TagKey}
gatewayRoute	`arn:${Partition}:appmesh:${Region}:${Account}:mesh/${MeshName}/virtualGateway/${VirtualGatewayName}/gatewayRoute/${GatewayRouteName}`	aws:ResourceTag/${TagKey}

Condition keys for AWS App Mesh

AWS App Mesh 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 actions by the presence of tag key-value pairs in the request	String
aws:ResourceTag/${TagKey}	Filters actions by the tag key-value pairs attached to the resource	String
aws:TagKeys	Filters actions by the presence of tag keys in the request	ArrayOfString

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

Amazon API Gateway Management V2

AWS App Mesh Preview