Actions, resources, and condition keys for Amazon FSx
Amazon FSx (service prefix: fsx) provides the following
service-specific operations, resources, actions, and condition 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.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon FSx
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
AssociateFileSystemAliases |
Write |
|||
|
CancelDataRepositoryTask |
Write |
|||
|
CopyBackup |
Write |
|||
Tagging, Write |
||||
|
CopySnapshotAndUpdateVolume |
Write |
|||
|
CreateAndAttachS3AccessPoint |
Write |
|||
|
CreateBackup |
Write |
|||
Tagging, Write |
||||
|
CreateDataRepositoryAssociation |
Write |
|||
Tagging, Write |
||||
|
CreateDataRepositoryTask |
Write |
|||
Tagging, Write |
||||
|
CreateFileCache |
Write |
|||
Write |
||||
Tagging, Write |
||||
|
CreateFileSystem |
Write |
|||
Tagging, Write |
||||
|
CreateFileSystemFromBackup |
Write |
|||
Tagging, Write |
||||
|
CreateSnapshot |
Write |
|||
Tagging, Write |
||||
|
CreateStorageVirtualMachine |
Write |
|||
Tagging, Write |
||||
|
CreateVolume |
Write |
|||
Tagging, Write |
||||
|
CreateVolumeFromBackup |
Write |
|||
Tagging, Write |
||||
|
DeleteBackup |
Write |
|||
|
DeleteDataRepositoryAssociation |
Write |
|||
|
DeleteFileCache |
Write |
|||
Write |
||||
|
DeleteFileSystem |
Write |
|||
Write |
||||
Tagging, Write |
||||
|
DeleteSnapshot |
Write |
|||
|
DeleteStorageVirtualMachine |
Write |
|||
|
DeleteVolume |
Permissions management, Write |
|||
Write |
||||
Tagging, Write |
||||
|
DescribeBackups |
Read |
|||
|
DescribeDataRepositoryAssociations |
Read |
|||
|
DescribeDataRepositoryTasks |
Read |
|||
|
DescribeFileCaches |
Read |
|||
|
DescribeFileSystemAliases |
Read |
|||
|
DescribeFileSystems |
Read |
|||
|
DescribeS3AccessPointAttachments |
Read |
|||
|
DescribeSharedVpcConfiguration |
Read |
|||
|
DescribeSnapshots |
Read |
|||
|
DescribeStorageVirtualMachines |
Read |
|||
|
DescribeVolumes |
Read |
|||
|
DetachAndDeleteS3AccessPoint |
Write |
|||
|
DisassociateFileSystemAliases |
Write |
|||
|
ListTagsForResource |
Read |
|||
|
ReleaseFileSystemNfsV3Locks |
Write |
|||
|
RestoreVolumeFromSnapshot |
Write |
|||
|
StartMisconfiguredStateRecovery |
Write |
|||
|
TagResource |
Tagging, Write |
|||
|
UntagResource |
Tagging, Write |
|||
|
UpdateDataRepositoryAssociation |
Write |
|||
|
UpdateFileCache |
Write |
|||
|
UpdateFileSystem |
Write |
|||
|
UpdateSharedVpcConfiguration |
Write |
|||
|
UpdateSnapshot |
Write |
|||
|
UpdateStorageVirtualMachine |
Write |
|||
|
UpdateVolume |
Write |
Actions defined by Amazon FSx
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.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to associate DNS aliases with an Amazon FSx for Windows File Server file system |
Write |
|||
Grants permission to cancel a data repository task |
Write |
|||
Grants permission to copy a backup |
Write |
|||
Grants permission to update an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system |
Write |
|||
Grants permission to create and attach a S3 Access Point to a FSx File System |
Write |
|||
Grants permission to create a new backup of an Amazon FSx file system or an Amazon FSx volume |
Write |
|||
Grants permission to create a new data respository association for an Amazon FSx for Lustre file system |
Write |
|||
Grants permission to create a new data respository task for an Amazon FSx for Lustre file system |
Write |
|||
Grants permission to create a new, empty, Amazon file cache |
Write |
|||
Grants permission to create a new, empty, Amazon FSx file system |
Write |
|||
Grants permission to create a new Amazon FSx file system from an existing backup |
Write |
|||
Grants permission to create a new snapshot on a volume |
Write |
|||
Grants permission to create a new storage virtual machine in an Amazon FSx for Ontap file system |
Write |
|||
Grants permission to create a new volume |
Write |
|||
Grants permission to create a new volume from backup |
Write |
|||
Grants permission to delete a backup, deleting its contents. After deletion, the backup no longer exists, and its data is no longer available |
Write |
|||
Grants permission to delete a data repository association |
Write |
|||
Grants permission to delete a file cache, deleting its contents |
Write |
|||
Grants permission to delete a file system, deleting its contents and any existing automatic backups of the file system |
Write |
|||
Grants permission to delete a snapshot on a volume |
Write |
|||
Grants permission to delete a storage virtual machine, deleting its contents |
Write |
|||
Grants permission to delete a volume, deleting its contents and any existing automatic backups of the volume |
Write |
|||
Grants permission to return the descriptions of all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling |
Read |
|||
Grants permission to return the descriptions of all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling |
Read |
|||
Grants permission to return the descriptions of all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling |
Read |
|||
Grants permission to return the descriptions of all file caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling |
Read |
|||
Grants permission to return the description of all DNS aliases owned by your Amazon FSx for Windows File Server file system |
Read |
|||
Grants permission to return the descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling |
Read |
|||
Grants permission to return the descriptions of S3 Access Point Attachments |
Read |
|||
Grants permission to return the descriptions of whether FSx route table updates from participant accounts are allowed in your account |
Read |
|||
Grants permission to return the descriptions of all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint you're calling |
Read |
|||
Grants permission to return the descriptions of all storage virtual machines owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling |
Read |
|||
Grants permission to return the descriptions of all volumes owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling |
Read |
|||
Grants permission to detach an S3 Access Point from an Amazon FSx File System and delete the S3 Access Point |
Write |
|||
Grants permission to disassociate file system aliases with an Amazon FSx for Windows File Server file system |
Write |
|||
Grants permission to list tags for an Amazon FSx resource |
Read |
|||
Grants permission to release file system NFS V3 locks |
Write |
|||
Grants permission to restore volume state from a snapshot |
Write |
|||
Grants permission to start misconfigured state recovery |
Write |
|||
Grants permission to tag an Amazon FSx resource |
Tagging, Write |
|||
Grants permission to remove a tag from an Amazon FSx resource |
Tagging, Write |
|||
Grants permission to update data repository association configuration |
Write |
|||
Grants permission to update file cache configuration |
Write |
|||
Grants permission to update file system configuration |
Write |
|||
Grants permission to enable or disable FSx route table updates from participant accounts in your account |
Write |
|||
Grants permission to update snapshot configuration |
Write |
|||
Grants permission to update storage virtual machine configuration |
Write |
|||
Grants permission to update volume configuration |
Write |
Permission-only actions for Amazon FSx
The following actions are defined by Amazon FSx but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to associate a File Gateway instance with an Amazon FSx for Windows File Server file system |
Write |
|||
Grants permission to allow deletion of an FSx for ONTAP SnapLock Enterprise volume that contains WORM (write once, read many) files with active retention periods |
Permissions management, Write |
|||
Grants permission to manage cross-account sharing of FSx volumes through Amazon Resource Access Manager (RAM). PutResourcePolicy and GetResourcePolicy are also required |
Permissions management, Write |
|||
Grants permission to describe the File Gateway instances associated with an Amazon FSx for Windows File Server file system |
Read |
|||
Grants permission to disassociate a File Gateway instance from an Amazon FSx for Windows File Server file system |
Write |
|||
Grants permission to manage cross-account sharing of FSx volumes through Amazon Resource Access Manager (RAM). PutResourcePolicy and DeleteResourcePolicy are also required |
Permissions management, Write |
|||
Grants permission to manage backup principal associations through Amazon Backup |
Permissions management, Write |
|||
Grants permission to manage cross-account sharing of FSx volumes through Amazon Resource Access Manager (RAM). DeleteResourcePolicy and GetResourcePolicy are also required |
Permissions management, Write |
Resource types defined by Amazon FSx
The following resource types are defined by this service and can be used in the
Resource element of IAM permission policy statements.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:fsx:${Region}:${Account}:association/${FileSystemIdOrFileCacheId}/${DataRepositoryAssociationId} |
||
arn:${Partition}:fsx:${Region}:${Account}:backup/${BackupId} |
||
arn:${Partition}:fsx:${Region}:${Account}:file-cache/${FileCacheId} |
||
arn:${Partition}:fsx:${Region}:${Account}:file-system/${FileSystemId} |
||
arn:${Partition}:fsx:${Region}:${Account}:snapshot/${VolumeId}/${SnapshotId} |
||
arn:${Partition}:fsx:${Region}:${Account}:storage-virtual-machine/${FileSystemId}/${StorageVirtualMachineId} |
||
arn:${Partition}:fsx:${Region}:${Account}:task/${TaskId} |
||
arn:${Partition}:fsx:${Region}:${Account}:volume/${FileSystemId}/${VolumeId} |
Condition keys for Amazon FSx
Amazon FSx defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the tags that are passed in the request |
String |
|
Filters access by the tags associated with the resource |
String |
|
Filters access by the tag keys that are passed in the request |
ArrayOfString |
|
Filters access by whether the backup is a destination backup for a CopyBackup operation |
Bool |
|
Filters access by whether the backup is a source backup for a CopyBackup operation |
Bool |
|
Filters access by NFS data repositories which support authentication |
Bool |
|
Filters access by NFS data repositories which support encryption-in-transit |
Bool |
|
Filters access by the containing parent volume for mutating volume operations |
String |
|
Filters access by the containing storage virtual machine for a volume for mutating volume operations |
String |