Actions, resources, and condition keys for Amazon Elastic File System
Amazon Elastic File System (service prefix: elasticfilesystem) 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 Elastic File System
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 |
|---|---|---|---|---|---|
| Backup [permission only] | Grants permission to start a backup job for an existing file system | Write | |||
| ClientMount [permission only] | Grants permission to allow an NFS client read-access to a file system | Read | |||
| ClientRootAccess [permission only] | Grants permission to allow an NFS client root-access to a file system | Write | |||
| ClientWrite [permission only] | Grants permission to allow an NFS client write-access to a file system | Write | |||
| CreateAccessPoint | Grants permission to create an access point for the specified file system | Write |
elasticfilesystem:TagResource |
||
| CreateFileSystem | Grants permission to create a new, empty file system | Write |
elasticfilesystem:TagResource |
||
| CreateMountTarget | Grants permission to create a mount target for a file system | Write | |||
| CreateReplicationConfiguration | Grants permission to create a new replication configuration | Write | |||
| CreateTags | Grants permission to create or overwrite tags associated with a file system; deprecated, see TagResource | Tagging | |||
| DeleteAccessPoint | Grants permission to delete the specified access point | Write | |||
| DeleteFileSystem | Grants permission to delete a file system, permanently severing access to its contents | Write | |||
| DeleteFileSystemPolicy | Grants permission to delete the resource-level policy for a file system | Permissions management | |||
| DeleteMountTarget | Grants permission to delete the specified mount target | Write | |||
| DeleteReplicationConfiguration | Grants permission to delete a replication configuration | Write | |||
| DeleteTags | Grants permission to delete the specified tags from a file system; deprecated, see UntagResource | Tagging | |||
| DescribeAccessPoints | Grants permission to view the descriptions of Amazon EFS access points | List | |||
| DescribeAccountPreferences | Grants permission to view the account preferences in effect for an account | List | |||
| DescribeBackupPolicy | Grants permission to view the BackupPolicy object for an Amazon EFS file system | Read | |||
| DescribeFileSystemPolicy | Grants permission to view the resource-level policy for an Amazon EFS file system | Read | |||
| DescribeFileSystems | Grants permission to view the description of an Amazon EFS file system specified by file system CreationToken or FileSystemId; or to view the description of all file systems owned by the caller's AWS account in the AWS region of the endpoint that is being called | List | |||
| DescribeLifecycleConfiguration | Grants permission to view the LifecycleConfiguration object for an Amazon EFS file system | Read | |||
| DescribeMountTargetSecurityGroups | Grants permission to view the security groups in effect for a mount target | Read | |||
| DescribeMountTargets | Grants permission to view the descriptions of all mount targets, or a specific mount target, for a file system | Read | |||
| DescribeReplicationConfigurations | Grants permission to view the description of an Amazon EFS replication configuration specified by FileSystemId; or to view the description of all replication configurations owned by the caller's AWS account in the AWS region of the endpoint that is being called | List | |||
| DescribeTags | Grants permission to view the tags associated with a file system | Read | |||
| ListTagsForResource | Grants permission to view the tags associated with the specified Amazon EFS resource | Read | |||
| ModifyMountTargetSecurityGroups | Grants permission to modify the set of security groups in effect for a mount target | Write | |||
| PutAccountPreferences | Grants permission to set the account preferences of an account | Write | |||
| PutBackupPolicy | Grants permission to enable or disable automatic backups with AWS Backup by creating a new BackupPolicy object | Write | |||
| PutFileSystemPolicy | Grants permission to apply a resource-level policy that defines the actions allowed or denied from given actors for the specified file system | Permissions management | |||
| PutLifecycleConfiguration | Grants permission to enable lifecycle management by creating a new LifecycleConfiguration object | Write | |||
| ReplicationRead [permission only] | Grants permission to read file system data for replication | Read | |||
| ReplicationWrite [permission only] | Grants permission to replicate data to a file system | Write | |||
| Restore [permission only] | Grants permission to start a restore job for a backup of a file system | Write | |||
| TagResource | Grants permission to create or overwrite tags associated with the specified Amazon EFS resource | Tagging | |||
| UntagResource | Grants permission to delete the specified tags from an Amazon EFS resource | Tagging | |||
| UpdateFileSystem | Grants permission to update the throughput mode or the amount of provisioned throughput of an existing file system | Write | |||
| UpdateFileSystemProtection | Grants permission to update the file system protection of an existing file system | Write |
Resource types defined by Amazon Elastic File System
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 |
|---|---|---|
| file-system |
arn:${Partition}:elasticfilesystem:${Region}:${Account}:file-system/${FileSystemId}
|
|
| access-point |
arn:${Partition}:elasticfilesystem:${Region}:${Account}:access-point/${AccessPointId}
|
Condition keys for Amazon Elastic File System
Amazon Elastic File System 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 a tag key and value pair that is allowed in the request | String |
| aws:ResourceTag/${TagKey} | Filters access by a tag key and value pair of a resource | String |
| aws:TagKeys | Filters access by a list of tag keys that are allowed in the request | ArrayOfString |
| elasticfilesystem:AccessPointArn | Filters access by the ARN of the access point used to mount the file system | ARN |
| elasticfilesystem:AccessedViaMountTarget | Filters access by whether the file system is accessed via mount targets | Bool |
| elasticfilesystem:CreateAction | Filters access by the name of a resource-creating API action | String |
| elasticfilesystem:Encrypted | Filters access by whether users can create only encrypted or unencrypted file systems | Bool |
